WinCC Programming en-US en-US
Uploaded by
andresWinCC Programming en-US en-US
Uploaded by
andresVBS for Creating Procedures
and Actions 1
ANSI-C for Creating
Functions and Actions 2
VBA for Automated
SIMATIC HMI Configuration 3
WinCC V7.5
WinCC: Scripting (VBS, ANSI-C,
VBA)
System Manual
Print of the Online Help
09/2018
A5E45518271-AA
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent
damage to property. The notices referring to your personal safety are highlighted in the manual by a safety alert
symbol, notices referring only to property damage have no safety alert symbol. These notices shown below are
graded according to the degree of danger.
DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.
WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.
CAUTION
indicates that minor personal injury can result if proper precautions are not taken.
NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will be
used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property
damage.
Qualified Personnel
The product/system described in this documentation may be operated only by personnel qualified for the specific
task in accordance with the relevant documentation, in particular its warning notices and safety instructions. Qualified
personnel are those who, based on their training and experience, are capable of identifying risks and avoiding
potential hazards when working with these products/systems.
Proper use of Siemens products
Note the following:
WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended or
approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and
maintenance are required to ensure that the products operate safely and without any problems. The permissible
ambient conditions must be complied with. The information in the relevant documentation must be observed.
Trademarks
All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication
may be trademarks whose use by third parties for their own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software described.
Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in
this publication is reviewed regularly and any necessary corrections are included in subsequent editions.
Siemens AG A5E45518271-AA Copyright © Siemens AG 2018.
Division Digital Factory Ⓟ 08/2018 Subject to change All rights reserved
Postfach 48 48
90026 NÜRNBERG
GERMANY
Table of contents
1 VBS for Creating Procedures and Actions.................................................................................................11
1.1 VBS for creating procedures and actions...............................................................................11
1.2 Using Visual Basic Script in WinCC.......................................................................................12
1.3 Modules and Procedures.......................................................................................................16
1.4 Actions...................................................................................................................................19
1.5 Multiple Use of Procedures and Actions................................................................................21
1.6 Use of CrossReference..........................................................................................................23
1.7 Using Global Tags in VBS......................................................................................................25
1.8 VBScript Editors.....................................................................................................................27
1.8.1 VBScript Editors.....................................................................................................................27
1.8.2 Global Script Editor................................................................................................................28
1.8.3 Working in an Editing Window...............................................................................................31
1.8.4 Working with the Toolbars......................................................................................................33
1.8.5 Deleting Actions or Procedures..............................................................................................35
1.9 Creating and Editing Procedures...........................................................................................37
1.9.1 Creating and Editing Procedures...........................................................................................37
1.9.2 Creating a New Procedure.....................................................................................................40
1.9.3 How to Write Procedure Codes..............................................................................................42
1.9.4 Using Standard and Project Procedures................................................................................45
1.9.5 How to add module-related information.................................................................................46
1.9.6 Protecting a Module with a Password....................................................................................48
1.9.7 Saving a Procedure................................................................................................................49
1.9.8 Renaming a Procedure or Module.........................................................................................51
1.10 Creating and Editing Actions..................................................................................................53
1.10.1 Creating and Editing Actions..................................................................................................53
1.10.2 Creating a New Action...........................................................................................................57
1.10.3 How to Edit Actions................................................................................................................58
1.10.4 How to add action-related information...................................................................................61
1.10.5 Protecting an Action with a Password....................................................................................63
1.10.6 Saving Actions.......................................................................................................................64
1.10.7 Triggers..................................................................................................................................65
1.10.7.1 Triggers..................................................................................................................................65
1.10.7.2 Animation trigger....................................................................................................................69
1.10.7.3 How to add a trigger of the type "Timer"................................................................................71
1.10.7.4 How to add a trigger of the type "Tag"...................................................................................72
1.10.7.5 How to change a trigger.........................................................................................................73
1.10.7.6 How to delete a trigger...........................................................................................................74
1.10.8 How to Rename an Action.....................................................................................................75
1.11 How to activate global actions in Runtime.............................................................................77
1.12 Diagnostics.............................................................................................................................78
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 3
Table of contents
1.12.1 Diagnostics.............................................................................................................................78
1.12.2 GSC Diagnostics....................................................................................................................79
1.12.2.1 GSC Diagnostics....................................................................................................................79
1.12.2.2 Inserting the GSC Diagnostics Window into a Picture...........................................................80
1.12.2.3 GSC Diagnostics Attributes....................................................................................................80
1.12.2.4 GSC Diagnostics Toolbar.......................................................................................................81
1.12.3 GSC Runtime.........................................................................................................................82
1.12.3.1 GSC Runtime.........................................................................................................................82
1.12.3.2 How to insert the GSC Runtime Window into a Picture.........................................................83
1.12.3.3 GSC Runtime Attributes.........................................................................................................84
1.12.4 Testing with the Debugger.....................................................................................................85
1.12.4.1 Testing with the Debugger.....................................................................................................85
1.12.4.2 How to Activate the Debugger...............................................................................................87
1.12.4.3 Principles of Debugging.........................................................................................................88
1.12.4.4 Structure of VBScript Files.....................................................................................................90
1.12.4.5 Action and Procedure Names in the Debugger......................................................................92
1.12.4.6 Selecting a Script for Editing..................................................................................................94
1.12.4.7 Processing Scripts Step-by-Step...........................................................................................95
1.12.4.8 Setting Breakpoints................................................................................................................96
1.12.4.9 Deleting Breakpoints..............................................................................................................97
1.12.4.10 How to Set Bookmarks in Scripts...........................................................................................98
1.12.4.11 How to Determine and Modify Tag and Property Values.......................................................99
1.12.4.12 Executing Script Commands................................................................................................100
1.13 Printing VBScripts................................................................................................................102
1.14 VBS Reference....................................................................................................................103
1.14.1 VBS Reference....................................................................................................................103
1.14.2 Objects and Lists..................................................................................................................105
1.14.2.1 Objects and Lists..................................................................................................................105
1.14.2.2 Alarm object.........................................................................................................................108
1.14.2.3 Alarms object (list)................................................................................................................108
1.14.2.4 AlarmLogs Object.................................................................................................................110
1.14.2.5 DataItem Object...................................................................................................................111
1.14.2.6 DataLogs Object..................................................................................................................112
1.14.2.7 DataSet Object (List)............................................................................................................113
1.14.2.8 HMIRuntime Object..............................................................................................................116
1.14.2.9 Item Object...........................................................................................................................117
1.14.2.10 Layer Object.........................................................................................................................118
1.14.2.11 Layers Object (Listing).........................................................................................................119
1.14.2.12 Logging Object.....................................................................................................................120
1.14.2.13 ProcessValue Object............................................................................................................121
1.14.2.14 ProcessValues Object (List).................................................................................................122
1.14.2.15 Project Object.......................................................................................................................122
1.14.2.16 ScreenItem Object...............................................................................................................123
1.14.2.17 ScreenItems Object (List).....................................................................................................127
1.14.2.18 Screen Object......................................................................................................................129
1.14.2.19 Screens Object (List)............................................................................................................132
1.14.2.20 SmartTags Object................................................................................................................134
1.14.2.21 Tag Object............................................................................................................................135
1.14.2.22 Tags Object (List).................................................................................................................137
1.14.2.23 TagSet Object (List).............................................................................................................139
1.14.3 Object types of the ScreenItem object.................................................................................141
WinCC: Scripting (VBS, ANSI-C, VBA)
4 System Manual, 09/2018, A5E45518271-AA
Table of contents
1.14.3.1 Object types of the ScreenItem object.................................................................................141
1.14.3.2 Standard objects..................................................................................................................142
1.14.3.3 Smart objects.......................................................................................................................167
1.14.3.4 Windows objects..................................................................................................................199
1.14.3.5 Tube objects.........................................................................................................................213
1.14.3.6 Controls................................................................................................................................216
1.14.3.7 Customized Object...............................................................................................................294
1.14.3.8 Group...................................................................................................................................296
1.14.4 Properties.............................................................................................................................297
1.14.4.1 Properties.............................................................................................................................297
1.14.4.2 A...........................................................................................................................................297
1.14.4.3 B...........................................................................................................................................317
1.14.4.4 C...........................................................................................................................................360
1.14.4.5 D...........................................................................................................................................396
1.14.4.6 E...........................................................................................................................................406
1.14.4.7 F...........................................................................................................................................416
1.14.4.8 G..........................................................................................................................................438
1.14.4.9 H...........................................................................................................................................443
1.14.4.10 I............................................................................................................................................452
1.14.4.11 L...........................................................................................................................................457
1.14.4.12 M..........................................................................................................................................489
1.14.4.13 N...........................................................................................................................................510
1.14.4.14 O..........................................................................................................................................512
1.14.4.15 P...........................................................................................................................................529
1.14.4.16 Q..........................................................................................................................................547
1.14.4.17 R...........................................................................................................................................548
1.14.4.18 S...........................................................................................................................................558
1.14.4.19 T...........................................................................................................................................595
1.14.4.20 U...........................................................................................................................................673
1.14.4.21 V...........................................................................................................................................683
1.14.4.22 W..........................................................................................................................................700
1.14.4.23 X - Z.....................................................................................................................................704
1.14.5 Methods...............................................................................................................................713
1.14.5.1 Methods...............................................................................................................................713
1.14.5.2 Methods A to E.....................................................................................................................714
1.14.5.3 Get methods.........................................................................................................................723
1.14.5.4 Methods H to M....................................................................................................................771
1.14.5.5 Methods N to R....................................................................................................................781
1.14.5.6 Methods S to T.....................................................................................................................799
1.14.5.7 Methods U to Z.....................................................................................................................814
1.14.6 Appendix..............................................................................................................................822
1.14.6.1 Error Messages from Database Area...................................................................................822
1.15 Examples of VBScript..........................................................................................................825
1.15.1 Examples of VBScript..........................................................................................................825
1.15.2 Examples in WinCC.............................................................................................................825
1.15.2.1 Examples in WinCC.............................................................................................................825
1.15.2.2 Example: Accessing objects in Graphics Designer..............................................................826
1.15.2.3 Example: Defining the color of objects.................................................................................827
1.15.2.4 Example: How to Configure Language Changes.................................................................827
1.15.2.5 Example: Deactivating Runtime...........................................................................................828
1.15.2.6 Example: Configuring change picture globally.....................................................................828
1.15.2.7 Example: Configuring Change Picture Via Property............................................................829
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 5
Table of contents
1.15.2.8 Example: Configuring diagnostics output via Trace.............................................................829
1.15.2.9 Example: Writing tag values.................................................................................................830
1.15.2.10 Example: How to Read Tag Values.....................................................................................832
1.15.2.11 Example: Writing Object Properties.....................................................................................835
1.15.2.12 Example: How to Start an Action on the Server (Logging Object).......................................838
1.15.2.13 Example: You connect or disconnect a database backup with VBS....................................840
1.15.2.14 Dynamization of Controls.....................................................................................................843
1.15.3 General Examples................................................................................................................857
1.15.3.1 General examples for VBScript............................................................................................857
1.15.3.2 Example: Configuring a Database Connection with VBS.....................................................858
1.15.3.3 Example: Using the MS Automation interface......................................................................860
1.15.3.4 Example: Starting an external application............................................................................861
1.16 Basic Principles of VBScript.................................................................................................863
1.16.1 Basic Principles of VBScript.................................................................................................863
1.16.2 VBScript Basics....................................................................................................................863
2 ANSI-C for Creating Functions and Actions.............................................................................................865
2.1 Creating Functions and Actions with ANSI-C.......................................................................865
2.2 Creating Functions and Actions...........................................................................................866
2.3 Characteristics of Project Functions.....................................................................................869
2.4 Characteristics of Standard Functions.................................................................................870
2.5 Characteristics of Internal Functions....................................................................................872
2.6 Characteristics of Local Actions...........................................................................................873
2.7 Characteristics of Global Actions.........................................................................................874
2.8 How to Add Global Script Runtime to a Project's Startup List..............................................875
2.9 Use of Global C-Tags...........................................................................................................876
2.10 Use of DLLs in Functions and Actions.................................................................................878
2.11 The Global Script Editor.......................................................................................................880
2.11.1 The Global Script Editor.......................................................................................................880
2.11.2 Working in the Edit Window.................................................................................................882
2.11.2.1 Working in the Edit Window.................................................................................................882
2.11.2.2 Editing Functions with the Keyboard....................................................................................883
2.11.2.3 Editing Functions with the Mouse........................................................................................884
2.11.3 Working with the Toolbars....................................................................................................885
2.11.4 How to Set Different Views..................................................................................................887
2.11.5 How to Set the Font Style....................................................................................................888
2.11.6 How to Use "Save As...".......................................................................................................888
2.11.7 How to Delete Actions or Project and Standard Functions..................................................889
2.11.8 How to Generate a New Header..........................................................................................890
2.11.9 How to Compile All Functions..............................................................................................890
2.11.10 How to Search in Files.........................................................................................................891
2.11.11 Printing Functions and Actions.............................................................................................892
2.11.11.1 Printing Functions and Actions.............................................................................................892
2.11.11.2 How to Set the Print Parameters..........................................................................................892
2.11.11.3 How to Open Page View......................................................................................................893
2.11.11.4 How to Print the Project Documentation..............................................................................893
WinCC: Scripting (VBS, ANSI-C, VBA)
6 System Manual, 09/2018, A5E45518271-AA
Table of contents
2.12 Creating and Editing Functions............................................................................................894
2.12.1 Creating and Editing Functions............................................................................................894
2.12.2 How to Create a New Function............................................................................................897
2.12.3 How to Write Function Code................................................................................................898
2.12.4 How to Use Internal Functions.............................................................................................899
2.12.5 How to Use Standard and Project Functions.......................................................................900
2.12.6 Inserting Additional Function-Related Information...............................................................901
2.12.7 How to Protect a Function Against Unauthorized Access....................................................902
2.12.8 How to Compile and Save a Function..................................................................................903
2.12.9 How to Rename a Function..................................................................................................905
2.12.10 How to Use Functions from Other Sources..........................................................................906
2.13 Creating and Editing Actions................................................................................................907
2.13.1 How To Create and Edit Actions..........................................................................................907
2.13.2 WinCC Coding Rule.............................................................................................................910
2.13.3 How to Create a New Action................................................................................................911
2.13.4 How to Edit Actions..............................................................................................................912
2.13.5 How to add action-related information.................................................................................912
2.13.6 How to Protect an Action Against Unauthorized Access......................................................914
2.13.7 How to Compile and Save an Action....................................................................................915
2.13.8 Triggers................................................................................................................................916
2.13.8.1 Triggers................................................................................................................................916
2.13.8.2 How to Add a New Trigger of the "Timer" Type...................................................................919
2.13.8.3 How to Add a New Trigger of the "Tag" Type......................................................................920
2.13.8.4 How to change a trigger.......................................................................................................921
2.13.8.5 How to delete a trigger.........................................................................................................922
2.13.9 How to Assign Authorizations..............................................................................................923
2.13.10 How to Export an Action.......................................................................................................923
2.13.11 How to Import an Action.......................................................................................................924
2.13.12 How to Rename an Action...................................................................................................924
2.13.13 How to Use Actions From Other Sources............................................................................925
2.14 Runtime Behavior of Actions................................................................................................927
2.14.1 Runtime Behavior of Actions................................................................................................927
2.14.2 GSC Runtime.......................................................................................................................928
2.14.2.1 GSC Runtime.......................................................................................................................928
2.14.2.2 How to Place GSC Runtime in a Process Picture................................................................931
2.14.2.3 Attributes of GSC Runtime...................................................................................................932
2.14.2.4 How to Edit Actions..............................................................................................................932
2.14.3 GSC Diagnose.....................................................................................................................933
2.14.3.1 GSC Diagnose.....................................................................................................................933
2.14.3.2 How to Place GSC Diagnose in a Process Picture?............................................................934
2.14.3.3 Attributes of GSC Diagnose.................................................................................................934
2.14.3.4 The Toolbar of GSC Diagnose.............................................................................................935
2.15 ANSI-C function descriptions...............................................................................................936
2.15.1 lpszPictureName..................................................................................................................936
2.15.2 Standard functions...............................................................................................................936
2.15.2.1 Standard functions - short description..................................................................................936
2.15.2.2 Alarm....................................................................................................................................937
2.15.2.3 Graphics...............................................................................................................................942
2.15.2.4 Obsolete functions...............................................................................................................948
2.15.2.5 Report................................................................................................................................1000
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 7
Table of contents
2.15.2.6 WinCC................................................................................................................................1003
2.15.2.7 Windows.............................................................................................................................1010
2.15.3 Internal functions................................................................................................................1011
2.15.3.1 Internal functions - short description..................................................................................1011
2.15.3.2 allocate...............................................................................................................................1011
2.15.3.3 c_bib...................................................................................................................................1012
2.15.3.4 graphics..............................................................................................................................1096
2.15.3.5 tag......................................................................................................................................1409
2.15.3.6 WinCC................................................................................................................................1512
2.15.4 Examples...........................................................................................................................1520
2.15.4.1 Examles - A to G................................................................................................................1520
2.15.4.2 Examples - GetAlarmHigh to GetPropChar.......................................................................1521
2.15.4.3 Examples - GetRangeMax to GetWidth.............................................................................1538
2.15.4.4 Examples - H to S..............................................................................................................1562
2.15.4.5 Examples - SetAlarmHigh to SetPropChar........................................................................1564
2.15.4.6 Examples - SetRangeMax to SetWidth..............................................................................1574
2.15.4.7 Examples of WinCC controls.............................................................................................1585
2.15.4.8 Examples - Obsolete functions..........................................................................................1587
2.15.5 Lists....................................................................................................................................1595
2.15.5.1 Bar direction.......................................................................................................................1595
2.15.5.2 Bar Scaling.........................................................................................................................1595
2.15.5.3 Flash frequencies...............................................................................................................1595
2.15.5.4 I/O field, output format........................................................................................................1596
2.15.5.5 I/O field, data type of the field content................................................................................1597
2.15.5.6 I/O field, field type..............................................................................................................1597
2.15.5.7 Element alignment in check boxes and radio boxes..........................................................1597
2.15.5.8 Color chart..........................................................................................................................1597
2.15.5.9 Format descriptors.............................................................................................................1598
2.15.5.10 Fill pattern..........................................................................................................................1599
2.15.5.11 Line styles..........................................................................................................................1600
2.15.5.12 Line end style.....................................................................................................................1600
2.15.5.13 List types............................................................................................................................1601
2.15.5.14 Language ID.......................................................................................................................1601
2.15.5.15 Text alignment....................................................................................................................1602
2.15.5.16 Tag statuses.......................................................................................................................1603
2.15.6 Structure definitions...........................................................................................................1603
2.15.6.1 Structure definition CCAPErrorExecute.............................................................................1603
2.15.6.2 Structure definition CCAPTime..........................................................................................1605
2.15.6.3 Structure definition CMN_ERROR.....................................................................................1606
2.15.6.4 Structure definition DM_TYPEREF....................................................................................1606
2.15.6.5 Structure definition DM_VAR_UPDATE_STRUCT.............................................................1607
2.15.6.6 Structure definition DM_VAR_UPDATE_STRUCTEX........................................................1608
2.15.6.7 Structure definition DM_VARKEY......................................................................................1609
2.15.6.8 Structure definition LINKINFO............................................................................................1610
2.15.6.9 Structure definition MSG_FILTER_STRUCT.....................................................................1611
2.15.6.10 Structure definition MSG_RTDATA_STRUCT...................................................................1614
3 VBA for Automated Configuration..........................................................................................................1617
3.1 Automated configuration....................................................................................................1617
3.2 Introduction: Using VBA in WinCC.....................................................................................1618
3.2.1 Introduction: Using VBA in WinCC.....................................................................................1618
3.2.2 Differentiation: Using VBA..................................................................................................1618
WinCC: Scripting (VBS, ANSI-C, VBA)
8 System Manual, 09/2018, A5E45518271-AA
Table of contents
3.2.3 Organizing VBA Code in a WinCC Project.........................................................................1619
3.2.4 How to export and import VBA code..................................................................................1622
3.2.5 Executing VBA Macros in Graphics Designer....................................................................1623
3.3 VBA in the Graphics Designer...........................................................................................1625
3.3.1 VBA in the Graphics Designer...........................................................................................1625
3.3.2 Adapting the Graphics Designer with VBA.........................................................................1627
3.3.2.1 Adapting the Graphics Designer with VBA.........................................................................1627
3.3.2.2 Language-Dependent Configuration with VBA..................................................................1628
3.3.2.3 Creating Customized Menus and Toolbars........................................................................1630
3.3.2.4 Access to WinCC libraries with VBA..................................................................................1650
3.3.3 Editing Pictures with VBA...................................................................................................1663
3.3.3.1 Editing Pictures with VBA...................................................................................................1663
3.3.3.2 How to Create Picture-specific Menus and Toolbars.........................................................1665
3.3.3.3 Editing Layers with VBA.....................................................................................................1666
3.3.3.4 Editing a Copy of a Picture with VBA.................................................................................1668
3.3.4 Editing Objects with VBA...................................................................................................1670
3.3.4.1 Editing Objects with VBA...................................................................................................1670
3.3.4.2 Default objects, Smart objects, Windows objects and Tube objects..................................1672
3.3.4.3 Group Objects....................................................................................................................1682
3.3.4.4 Customized Objects...........................................................................................................1690
3.3.5 Creating Dynamics with VBA.............................................................................................1694
3.3.5.1 Creating Dynamics with VBA.............................................................................................1694
3.3.5.2 Configuring Dynamics in the Properties of Pictures and Objects.......................................1695
3.3.5.3 Configuring Event-Driven Actions with VBA.......................................................................1707
3.3.5.4 Editing Triggers..................................................................................................................1715
3.3.6 Event Handling...................................................................................................................1717
3.3.7 Accessing External Applications with VBA.........................................................................1721
3.3.7.1 Accessing External Applications with VBA.........................................................................1721
3.3.7.2 Example: Accessing MS Excel with VBA...........................................................................1722
3.4 VBA in the WinCC Configuration Studio............................................................................1733
3.4.1 VBA in the WinCC Configuration Studio............................................................................1733
3.4.2 Example: VBA in the WinCC Configuration Studio............................................................1735
3.5 AddIns................................................................................................................................1742
3.5.1 AddIns................................................................................................................................1742
3.5.2 Linking Add Ins...................................................................................................................1742
3.5.3 How to Configure an AddIn in the Graphics Designer.......................................................1744
3.5.4 Example: Creating Add Ins................................................................................................1746
3.5.4.1 Example: Creating Add Ins................................................................................................1746
3.5.4.2 Example: Creating an Add In with Visual Basic 6.0...........................................................1746
3.6 VBA Reference..................................................................................................................1752
3.6.1 The object model of the Graphics Designer.......................................................................1752
3.6.1.1 VBA Reference..................................................................................................................1752
3.6.1.2 VBA Reference: ActionDynamic........................................................................................1754
3.6.1.3 VBA Reference: HMIObjects..............................................................................................1756
3.6.1.4 VBA Reference: Languages...............................................................................................1758
3.6.1.5 Events................................................................................................................................1759
3.6.1.6 Methods.............................................................................................................................1792
3.6.1.7 Objects and Lists................................................................................................................1900
3.6.1.8 Properties...........................................................................................................................2115
3.6.2 VBA in Other WinCC Editors..............................................................................................2563
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 9
Table of contents
3.6.2.1 VBA in Other WinCC Editors..............................................................................................2563
3.6.2.2 VBA in Tag Management...................................................................................................2565
3.6.2.3 VBA im Tag Logging..........................................................................................................2576
3.6.2.4 VBA in the Text Library......................................................................................................2610
3.6.2.5 VBA in Alarm Logging........................................................................................................2624
Index.......................................................................................................................................................2639
WinCC: Scripting (VBS, ANSI-C, VBA)
10 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions 1
1.1 VBS for creating procedures and actions
Contents
WinCC provides the possibility of dynamizing the Runtime environment using the Visual Basic
Script. It is possible to use VBS to program global actions and procedures as well as
dynamizing graphic objects and triggering actions in Runtime.
This chapter will show you
● How to work with VBScript editors
● How to create and edit procedures
● How to create and edit actions
● How to activate VBScripts in Runtime
● How to execute diagnostics on scripts in Runtime
● The object model of graphic Runtime system
● Detailed examples on using VBScript
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 11
VBS for Creating Procedures and Actions
1.2 Using Visual Basic Script in WinCC
1.2 Using Visual Basic Script in WinCC
Introduction
In addition to the C script, WinCC also provides the VBScript programming language as a
programming interface in order to make the WinCC Runtime environment dynamic.
Target Group of the Documentation
This documentation is aimed at configuration engineers with experience in Visual Basic or
WinCC Scriptings (C) used previously.
Possible applications
VBScript (VBS) provides access to tags and objects of the graphical Runtime system in
Runtime and enables execution of picture-independent actions:
● Tags: Tag values can be read and written, for example, to specify tag values for the PLC
by clicking the mouse when positioned on a button.
● Objects: Object properties can be made dynamic using actions and actions can be triggered
by events influencing objects.
● Picture-independent actions: Picture-independent actions can be triggered cyclically or
according to tag values, e.g. for the daily transfer of values into an Excel table.
VBS can be used at the following points in WinCC:
● In the Global Script Editor: This is used to configure picture-independent actions and
procedures. The procedures can be used in picture-dependent and picture-independent
actions. Several procedures are compiled in a topic-related module.
● In Graphics Designer: Picture-dependent actions can be configured with which the
properties of graphic objects can be made dynamic or caused to respond to events in
Runtime.
● In user-defined menus and toolbars: Here you configure procedures called in Runtime using
the menu and toolbars.
Note
Updating Changed Configuration in Runtime
A changed VB script that is connected with "Menus and toolbars" is only updated after
Runtime is restarted.
If you change the properties of "Menus and toolbars" in Runtime, the changes are only
applied in the following cases:
● After a picture change, if the configuration change does not affect the basic picture.
● When you load another configuration file and reload the modified configuration file.
WinCC: Scripting (VBS, ANSI-C, VBA)
12 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.2 Using Visual Basic Script in WinCC
Registered tags in menus and toolbars
The registered tags in the scripts of "Menus and toolbars" remain registered when you unselect
the picture. If you read indirectly from a process image, the tags are registered and unregistered
again when you deselect the picture. However, registered tags in the scripts of "Menus and
toolbars" remain registered when you unselect the picture.
Application scenarios
VBS can be used in Runtime, for example:
● to configure setpoint value specification for tags for the operation of a graphic object in
order to define a value for the PLC by clicking a mouse, for example.
● to configure switching the Runtime language for the operation of a graphic object.
● to configure color changes, e.g. cyclically (flashing) or displaying statuses (motor on).
Apart from the specific WinCC applications, the general functionality of VBS can also be used
to customize your Windows environment, e.g.:
● to transfer data to another application (e.g. Excel).
● to start external applications from WinCC.
● to create files and folders.
The automation objects in your environment are available for customizing your Windows
environment.
Note
All the objects supplied with the Windows Script Host (WSH) from Microsoft can be integrated
in the environment using the standard VBS method CreateObject. However, there is no direct
access to the WSH object itself using VBS from WinCC.
There is no guarantee or WinCC support for the VBS functionality with regard to its adaptation
to the Windows environment.
Differentiation from other programming languages in WinCC
VBS and C
VBScript can be used in WinCC parallel to C-Script, but do not mix the script types:
● VBScripts and C-scripts can be configured within a picture and project.
● C-scripts cannot be invoked in VBScripts and vice versa.
● VBS provides internal interfaces to tags and picture objects while the C environment
enables access to other WinCC subsystems (e.g. the report system).
● The syntax for path information is different. When addressing object in subdirectories, the
folders are separated by single or double backslashes:
– VBScript: single backslash "\"
– C: double backslash "\\"
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 13
VBS for Creating Procedures and Actions
1.2 Using Visual Basic Script in WinCC
VBS and VBA
VBA is used in WinCC Configuration during the configuration in order to adapt Graphics
Designer to your individual requirements and to simplify and automate configuration. VBA
programs only run in the WinCC configuration environment.
As opposed to VBA, VB scripts only run in WinCC Runtime and, from there, enable access to
graphic objects and tags. Objects and pictures can be neither created nor modified on a
permanent basis in VBS, as opposed to VBA.
The main language-related differences between VBA and VBS include, for example:
● VBS was developed for use on the Internet, VBA for the automation of software applications.
● The data type of VBS tags is always VARIANT. VBA, on the other hand, differentiates
between the individual data types such as INT, DOUBLE, STRING, etc.
● Certain language constructs from VBA have been removed from or added to VBS.
● Errors are handled differently in VBS compared to VBA.
A complete list of the differences between VBA and VBS is provided in the appendix in "Basic
Principles of VBScript".
Procedures, Modules and Actions
VBS in WinCC allows the use of procedures, modules and actions to make the Runtime
environment dynamic:
● Procedures: A procedure corresponds to a function in C. You store code in procedures
which you then used at several points in your configuration. Retrieve the code in an action
or another procedure by calling the procedure name. Procedures can be created in WinCC
with or without return values. Procedures do not have their own trigger; they are always
retrieved by an action.
● Modules: It is advantageous to compile related procedures to units in modules. Create
modules for procedures, for example, which must be used in a specific picture or belong
to a specific topic, such as auxiliary mathematical functions or database access functions.
● Actions: Actions are always activated by a trigger, namely a triggering event. Actions are
configured in graphic object properties, in events which occur on a graphic object or globally
in a project. In actions, you can call code that is used several times in the form of procedures.
WinCC: Scripting (VBS, ANSI-C, VBA)
14 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.2 Using Visual Basic Script in WinCC
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 15
VBS for Creating Procedures and Actions
1.3 Modules and Procedures
1.3 Modules and Procedures
Introduction
Procedures are used to make code, created only once, available at several points in a project.
Instead of entering the code several times, simply call in the corresponding procedure. The
code is clearer and easier to maintain.
Related procedures should be stored in modules. When a certain procedure is retrieved via
an action in Runtime, the module that contains that procedure is loaded. Observe the following
when structuring the modules and procedures:
● The more modules that must be loaded when a picture is called in, the worse the
performance in Runtime.
● The larger a module, the more procedures are contained and, thus, the longer the loading
time for the module.
Organize the modules sensibly, e.g. a module with procedures for a specific system part/
picture.
Another type of structuring of procedures in modules is the functional structuring, e.g. a module
containing mathematical functions. Use this structure, for example, for modules which should
be used globally for projects. The following example illustrates a module containing
mathematical functions derived from the standard functions:
WinCC: Scripting (VBS, ANSI-C, VBA)
16 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.3 Modules and Procedures
Procedure Features
The procedures in WinCC have the following properties:
● They are created and modified by the user.
● They can be protected against modification and viewing by means of a password.
● They do not have a trigger.
● They are stored in a module.
WinCC does not provide predefined procedures, but does provide code templates and
Intellisense, for example, to simplify programming. Procedures differ according to module
assignment in:
● Standard procedures apply globally to projects located on the computer on which they were
created.
● Project procedures can only be used within the project in which they were created.
Module Features
A module is a file in which one or more procedures are stored. The modules in WinCC have
the following properties:
● They can be protected against modification and viewing by means of a password.
● The have the file extension *.bmo.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 17
VBS for Creating Procedures and Actions
1.3 Modules and Procedures
Modules differ according to the validity of their procedures in:
● Standard modules: Contain procedures which are globally available to the project. Standard
modules are stored in the WinCC file system under: <WinCC installation directory>\ApLib
\ScriptLibStd\<Module name>.bmo
● Project modules: Contain project-specific procedures. Project modules are stored in the
WinCC file system under: <Project folder>\ScriptLib\<Module Name>.bmo. Since the
project modules are stored in the project directory, they are copied when the WinCC project
is copied.
Note
If WinCC must be reinstalled and the standard procedures and modules need to be used
again, save the module files prior to the re-installation in a different directory and copy them
in the relevant WinCC directory after the re-installation has been completed. Otherwise,
the standard modules in the WinCC installation directory are deleted during the installation
routine.
Using Procedures and Modules
Procedures are used in:
● Actions (in Graphics Designer and Global Script)
● Other procedures (in Global Script)
● User-defined menus and toolbars
Procedures are structured in modules.
See also
Creating and Editing Procedures (Page 37)
VBScript Editors (Page 27)
Basic Principles of VBScript (Page 863)
Actions (Page 19)
Using Visual Basic Script in WinCC (Page 12)
WinCC: Scripting (VBS, ANSI-C, VBA)
18 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.4 Actions
1.4 Actions
Introduction
An action is always started by a trigger. An action, for example, is triggered in Runtime when
an object is operated by a mouse click, a certain time has occurred or a tag has been modified.
Action Features
Actions are defined once in Global Script and then available independent of the picture. Global
Script actions are only valid in the project in which they were defined. Actions linked to a graphic
object are only valid in the picture in which they were defined.
Note
VBS does not currently allow the creation of computer-specific actions.
The following applies for clients in a multi-user system: All global actions configured on a server
are also executed on a client when a project is opened.
The following applies to clients in a distributed system: If actions should be used on a client
computer, copy all the action files in the corresponding project directory on the client.
Actions have the following properties:
● Actions are created and modified by the user.
● Actions in Global Script can be protected against modification and viewing by means of a
password.
● Actions have at least one trigger.
● Actions in Global Script have the file extension *.bac.
● Global Script actions are stored in the WinCC file system under: <Projektverzeichnis>
\ScriptAct\Aktionsname.bac
Action Trigger
Triggers are required to execute actions in Runtime. A trigger is linked to an action thus forming
the triggering event which calls the action. Actions without triggers will not be carried out.
The following trigger types are available in WinCC:
● Timer: Acyclic or cyclic trigger, e.g. for calling a picture or every hour.
● Tags: Change of value
● Event: Modification of object properties (e.g. change of color) or event on an object (e.g.
mouse click).
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 19
VBS for Creating Procedures and Actions
1.4 Actions
Processing of Actions in Runtime
In Graphics Designer
Two actions of the same type can be executed simultaneously in Runtime. In order, for
example, that cyclic actions are not hindered by an action executed by a mouse click, event
triggered actions and cyclic/tag triggered actions in Graphics Designer are executed
independently of each other.
Note
Please note that synchronization between both action types in WinCC may only be executed
by the DataSet object or by internal WinCC tags. As a result of the separate processing, no
common data area exists between event triggered and cyclic/tag triggered actions.
If processing cyclic actions in pictures, for example, is prevented by a high system load or
another action, the action is started once at the next opportunity. Cycles which are not executed
are not retained in a queue but rejected.
After a change of picture, scripts still running are automatically stopped 1 minute after the
change of picture.
Scripts which are still running when Runtime is terminated are stopped after 5 seconds.
In Global Script
Picture-independent actions from Global Script are executed in Runtime in succession after
being triggered. If an action is triggered while another action is in progress, the second action
is retained in a queue until it can be executed.
Note
Please note that synchronization between actions in Global Script and in Graphics Designer
may only be executed by the DataSet object or by internal WinCC tags. There is no common
data area between the actions in Graphics Designer and in Global Script.
Using the Actions
Actions can be used as follows:
● In Global Script The global actions defined here run picture-independent in Runtime.
● In Graphics Designer: The actions defined here only run in the configured picture. An action
is configured in Graphics Designer on an object property or an event on a graphic object.
See also
Creating and Editing Actions (Page 53)
Basic Principles of VBScript (Page 863)
Modules and Procedures (Page 16)
Using Visual Basic Script in WinCC (Page 12)
WinCC: Scripting (VBS, ANSI-C, VBA)
20 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.5 Multiple Use of Procedures and Actions
1.5 Multiple Use of Procedures and Actions
Introduction
An action configured with VBS in WinCC is always valid for the project in which it was defined.
Procedures have the following areas of application:
● Standard procedures apply globally to projects located on the computer on which they were
created.
● Project procedures can only be used in the project in which they were created. If a project
is copied, the project procedures (modules) are copied together with the project.
Multiple Use of Procedures and Actions
If actions or procedures/modules are to be used in other projects or on other computers, it is
possible either to:
● use the "Save As" function to store the action or module in a different project directory or,
for example, on a disk.
● to copy the action or module file in Windows Explorer and paste it in the corresponding
project or standard directory on the target computer.
The properties and trigger configured are retained during copying. Copied modules are directly
available in Runtime. Copied actions are executed in Runtime after they have been opened
and stored once.
Note
Tags used in an action or procedure must also be available on the target computer. If the tag
is not available, the action or procedure is not executed.
Procedures which are called in an action must be available on the target computer. If the
procedure is not available, a Runtime error occurs during Runtime.
Storing Procedures
If procedures need to be copied in other project directories in order to be able to use then in
other projects or different computers, observe the storage path of the procedures in the WinCC
file system:
● Standard procedures: <WinCC-Installationsverzeichnis>\ApLib\ScriptLibStd
\Modulname.bmo
● Project procedures: <Projektverzeichnis>\ScriptLib\Modulname.bmo
Note
Since procedures are always stored in modules, always copy the module (*.bmo) in which the
procedure is contained.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 21
VBS for Creating Procedures and Actions
1.5 Multiple Use of Procedures and Actions
The copied procedures/modules are visible after updating the Global Script navigation window
(context menu command "Update") or restarting the editor.
Storing Actions
If actions need to be copied in other project directories in order to be able to use then in other
projects or different computers, observe the storage path of the actions in the WinCC file
system:
<Projektverzeichnis>\ScriptAct\Aktionsname.bac
Each action is stored in a separate file. When an action is copied, all the triggers related to it
are also copied.
Note
Only actions created in Global Script are stored in the WinCC file system. Actions which are
programmed in Graphics Designer are always stored with the current picture and cannot be
transferred individually. If a Graphics Designer picture is copied into another project directory,
the actions stored with the picture are also copied.
The copied actions are visible after updating the Global Script navigation window (context
menu command "Update") or restarting the editor.
See also
Modules and Procedures (Page 16)
Renaming a Procedure or Module (Page 51)
Saving a Procedure (Page 49)
Protecting a Module with a Password (Page 48)
How to add module-related information (Page 46)
Using Standard and Project Procedures (Page 45)
How to Write Procedure Codes (Page 42)
Creating a New Procedure (Page 40)
Creating and Editing Procedures (Page 37)
WinCC: Scripting (VBS, ANSI-C, VBA)
22 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.6 Use of CrossReference
1.6 Use of CrossReference
CrossReference and Tag Trigger
The CrossReference from WinCC can be used to quickly find all the application points of tags,
even in VBS actions. Tag triggers in actions in Graphics Designer can be "linked" using
CrossReference, i.e. replaced by other tags at all or selected points.
Note
Tags can also be directly linked in Graphics Designer by marking the graphic object and
selecting the "Linking ..." command from the shortcut menu.
Further information on CrossReference is available in the WinCC documentation.
Actions and CrossReference
All the actions used in a picture can be displayed by means of the picture properties. To do
this mark the picture in WinCC Explorer and select the "Properties" shortcut menu command.
After double clicking on an entry, detailed information on the type of dynamics appears.
It is also possible to display all the tags and pictures used in actions by means of the WinCC
CrossReference. CrossReference can also be used for the to link tag connections of Graphics
Designer actions easily.
Tags and CrossReference
All tags addressed with the following standard formulation are automatically compiled by the
CrossReference of WinCC and then listed in the picture properties.
' VBS1
HMIRuntime.Tags("Tagname")
If tags are addressed with different formulations in the code, this can be notified by the following
section of the CrossReference:
' WINCC:TAGNAME_SECTION_START
Const TagNameInAction = "TagName"
' WINCC:TAGNAME_SECTION_END
The section can be inserted in VBS actions as often as required.
Note
It is not possible to guarantee the compilation of combined tag names from the CrossReference.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 23
VBS for Creating Procedures and Actions
1.6 Use of CrossReference
Pictures and CrossReference
All pictures addressed with the following standard formulation are automatically compiled by
the CrossReference of WinCC and then listed in the picture properties.
'VBS2
HMIRuntime.BaseScreenName = "Screenname"
If pictures are addressed with different formulations in the code, this can be notified by the
following section of the CrossReference:
' WINCC:SCREENNAME_SECTION_START
Const ScreenNameInAction = "ScreenName"
' WINCC:SCREENNAME_SECTION_END
The section can be inserted in VBS actions as often as required.
Note
Always enter picture names without the extension "PDL" for reasons of compatibility with future
versions.
See also
VBS Reference (Page 103)
VBScript Editors (Page 27)
Basic Principles of VBScript (Page 863)
Actions (Page 19)
Modules and Procedures (Page 16)
Using Visual Basic Script in WinCC (Page 12)
WinCC: Scripting (VBS, ANSI-C, VBA)
24 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.7 Using Global Tags in VBS
1.7 Using Global Tags in VBS
Introduction
Global tags can be defined in the Global Script Editor which can then be used in all actions
and procedures.
Using Global Tags in Graphics Designer and Global Script
Observe the following conditions when using global tags in Graphics Designer and Global
Script:
● In order to use a global tag in an action in Graphics Designer, call in the procedure in which
the tag is defined so that the associated module is loaded in Runtime.
● In order to use a global tag in an action in Global Script, at least one procedure must be
activated from the module in at least one global action in which the tag is defined so that
the module is loaded in Global Script Runtime. This does not need to be the procedure in
which the tag was defined.
This process is necessary because actions from Global Script and Graphics Designer are
processed independently of each other in Runtime. There is no common data area between
the two Runtime systems.
If you need to synchronize actions from Global Script and Graphics Designer, use the DataSet
object or internal WinCC tags.
Using Global Tags in Graphics Designer
When using global tags in Graphics Designer, observe the following conditions:
● In order to use a global tag in cyclic or tag triggered action in Graphics Designer, call in the
procedure in which the tag is defined. This also applies when the tag has already been
called in an event triggered action.
● In order to use a global tag in an event triggered action in Graphics Designer, call in the
procedure in which the tag is defined. This also applies when the tag has already been
called in a cyclic or tag triggered action.
This process is necessary because the cyclic/tag triggered actions and the event triggered
actions in Graphics Designer in Runtime are processed independently of each other in
Runtime. There is no common data area between the two types of action.
If you need to synchronize cyclic or tag-triggered actions and event-triggered actions, use the
DataSet object or internal WinCC tags.
In the case of Graphics Designer, it is also possible to define global tags in a separate
declaration section. Because event-triggered and cyclic/tag-triggered actions are processed
separately in Runtime, the global tags can only be jointly addressed within the event-triggered
or cyclic/tag-triggered actions.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 25
VBS for Creating Procedures and Actions
1.7 Using Global Tags in VBS
See also
Basic Principles of VBScript (Page 863)
Structure of VBScript Files (Page 90)
Creating and Editing Actions (Page 53)
Creating and Editing Procedures (Page 37)
VBScript Editors (Page 27)
Use of CrossReference (Page 23)
Actions (Page 19)
Modules and Procedures (Page 16)
WinCC: Scripting (VBS, ANSI-C, VBA)
26 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.8 VBScript Editors
1.8 VBScript Editors
1.8.1 VBScript Editors
Introduction
You can program VB scripts in two places in WinCC:
● In Global Script:
Global Script is the central editor for VBS programming.
You open it using the WinCC Explorer.
● In Graphics Designer:
In the Graphics Designer, you program actions on object properties or events on graphic
objects.
You open the Action Editor in the Graphics Designer from the shortcut menu in the
properties dialog of a graphic object.
You can find additional information in the WinCC documentation "Dynamization".
Delineation of Global Script - Graphics Designer
In the Graphics Designer, you can program actions and picture-specific procedures, but not
project-wide global procedures.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 27
VBS for Creating Procedures and Actions
1.8 VBScript Editors
However, you can call global procedures programmed in Global Script.
Note
This documentation primarily describes Global Script and, when appropriate, points out
deviations in the functionality of the Graphics Designer.
You can find a detailed description of the Action Editor in the Graphics Designer under the
WinCC help topic "Dynamization".
No Unicode support
VB scripts do not support Unicode in actions and procedures.
See also
Global Script Editor (Page 28)
1.8.2 Global Script Editor
Introduction
Global procedures and actions are created and edited in the Global Script editor.
Global Script provides a similar range of functions to that of the C script editor in WinCC.
Note
A detailed description of the action editor for the creation of picture-based actions and
procedures in Graphics Designer is provided under the WinCC help topic "Dynamics".
Starting Global Script
Global Script is started using the shortcut menu "Open" command in the WinCC Explorer
project window.
Global Script is also automatically started when a module or action is opened by means of a
double click in WinCC Explorer.
WinCC: Scripting (VBS, ANSI-C, VBA)
28 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.8 VBScript Editors
Design of Global Script
Global Script editor is designed in accordance with the Windows standards.
The action editor in the Graphics Designer provides a similar range of functions to that of Global
Script. A description of the Graphics Designer action editor is provided in the WinCC help topic
"Dynamization".
Menu bar (1) and toolbars (2)
All the commands required to create procedures and actions are provided in the menu bar and
toolbars.
The toolbars can be displayed and hidden using the "View" > "Toolbars" command and can
be moved to any position within the editor.
Navigation window (3)
In the navigation window you manage your procedures, modules and actions. In addition you
can find here code templates which you can insert by drag&drop into your action or procedure.
A procedure can be called in another procedure or action by dragging them from the navigation
window and dropping them at the relevant point in the code.
The display in the navigation window is always updated during the saving of the edited
document. If you change a file, this will be displayed by a * behind the file name.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 29
VBS for Creating Procedures and Actions
1.8 VBScript Editors
The procedures contained in a module are displayed in the navigation window underneath the
module file. The Actions tab control also displays the trigger and procedures configured for an
action, if necessary those directly defined in an action module.
The navigation window can still be used to:
● Create subdirectories for structuring the scripts.
● Move, copy, paste, delete and rename modules and directories directly.
The display in the navigation window can be individually configured with the "View" >
"Workplace" menu commands. It is possible to select whether all file types, only script files or
only syntactically correct files should be displayed. The navigation window can be shown or
hidden with the "View" > "Workplace" > "Display" menu commands.
Editing window (4)
You write and edit your actions in the editing window. Each procedures or action will be opened
in its own editing window. Several editing windows can be open at the same time.
The user is supported by in the editing window by Highlight Syntax and Intellisense. All general
editor functions (e.g. Undo/Redo, Find/Replace, Copy, Paste, Cut, Font Settings, Printer
Settings) remain available.
Output window (5)
Error messages are displayed in the output window following the syntax check. Double click
on the corresponding error line to access the related point in the code.
Status bar (6)
The status bar contains information on the currently selected functionality or hints on
programming.
Note
If information on individual editor commands or icons is required, select the "?" menu icon. >
"What's This?". Then click the mouse button on the corresponding icon/command. This
provides fast, direct help on all the operating elements in the editors. Press "ESC" to exit
"What's This?" help mode.
Window docking
Window docking is a useful tool for the flexible arrangement of windows. It lets you reposition
windows to obtain separate windows, or group windows in tab groups. For example, you can
arrange your actions horizontally, vertically, or as tab group. You can automatically hide
windows and show them again when needed.
See also
Deleting Actions or Procedures (Page 35)
Working with the Toolbars (Page 33)
Working in an Editing Window (Page 31)
WinCC: Scripting (VBS, ANSI-C, VBA)
30 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.8 VBScript Editors
1.8.3 Working in an Editing Window
Introduction
Procedures and actions are edited in the editing window.
Declaration Areas in Actions (Graphics Designer only)
If you create actions in the Action Editor of Graphics Designer, you can display the declaration
area of the action in the editing window using the button .
The declaration area can also be used to make general settings to be used globally for the
current picture, e.g.:
● Tag Definitions
● Procedures which you only want to use in this picture
Note
Do not create any directly executable codes in the declaration area!
Please note that when creating a tag, it must not contain a value (Value = VT_EMPTY).
Initialize the tags after declaration with the corresponding value.
When making definitions in the declaration area, pay attention to the structure of the Script
files, as described under "Structure of VBScript files".
"Option explicit" in Actions
When creating a new action, the "Option explicit" instruction is automatically set and cannot
be deleted in the declaration area (Graphics Designer) or entered in the first line of an action
(Global Script). The instruction is necessary as it prevents errors caused by the incorrect
notation of tags without declaration. The instruction requires that tags are always defined in
your code with the "Dim" instruction.
Note
Do not use the "Option explicit" instruction in the code because it may cause Runtime errors.
User Support in the Editing Window
The following functions are available to support working in the editing window.
Color coding and indentation in the editing window
Certain parts of the code have the following default colors:
Color Description Example
blue Key words Sub, End Sub, Next
Functions
green Comments ' is a comment
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 31
VBS for Creating Procedures and Actions
1.8 VBScript Editors
Color Description Example
red Strings (character strings and "Object1"
digits)
dark blue Preprocessor statements --
bold black Constants vbTrue, vbFalse
black Other codes --
The color coding in the editing window can be customized by means of the editor settings.
Select the "Tools" > "Options" menu commands and the "Script Editor Options" dialog to define
the settings.
In order to organize the codes clearly, they can be structured by indentations. The "Script Editor
Options" dialog can also be used to define the tabulator distance and Automatic Indent while
writing.
Intellisense and Highlight Syntax
During text entry, context-sensitive lists appear containing the properties, methods, and objects
possible at the current code position. If you insert an element from the list, the required syntax
is also indicated automatically.
Note
Full intellisense for all objects can only be utilized in the Graphics Designer if the list is accessed
using the object name and the result is assigned to a tag. Otherwise, only a list of standard
properties is offered.
Example of full intellisense:
Dim Tag
Set Variable = ScreenItems ("Kreis1")
Tag.
If picture window limits are exceeded during addressing, it is once again only the standard
properties which are offered since the picture of the picture window is not loaded.
Highlight Syntax can be activated and deactivated in the "Script Editor Options" dialog. The
dialog can be called in using the "Tools" > "Options" menu commands.
General VBS Functions
Use the "Function List" command of the shortcut menu in the editing window to display a list
of general VBS functions.
Lists of Objects, Properties and Methods
Using the shortcut menu in the editing window, you can view a list of the possible objects by
calling the "Object List" command in Graphics Designer. Global Script only provides the
"HMIRuntime" object in this list because there is no direct access to the objects of Graphics
Designer.
Use the "Properties/Methods" command of the shortcut menu to call in a list of possible
properties and methods.
WinCC: Scripting (VBS, ANSI-C, VBA)
32 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.8 VBScript Editors
The same lists can be called in with the key combination <CTRL + SPACEBAR> according to
the context of the script.
Code Templates
In the "Code templates" tab in the Navigation window of the Editor, you will find a selection of
frequently used instructions, e.g., for loops and conditional instructions. The templates can be
inserted in the procedure code with "drag-and-drop".
If you want to insert a code template into your code, you have to replace the "_XYZ_"
placeholder in the templates with the respective data.
Selection Dialogs
If WinCC tags or objects are used in the code, the following selection dialogs are available for
use:
● Opens a tag selection dialog and returns the selected tag name as the return value.
● Opens a tag selection dialog and returns the tag name with an associated reference.
● Opens a picture/object browser in which you can select a picture/object whose name is
then used for the return value.
● Opens a picture selection dialog for pictures and returns the picture name with the server
prefix, if necessary.
Bookmarks
Bookmarks can be set in the code to find certain parts in the code more easily:
● Sets a bookmark in the line where the cursor is currently located.
● Deletes all bookmarks in the active editing window.
● Jumps ahead to the next bookmark in the code.
● Jumps back to the last bookmark in the code.
See also
Structure of VBScript Files (Page 90)
Global Script Editor (Page 28)
1.8.4 Working with the Toolbars
Purpose
In their default position, the toolbars are located below the menu bar, at the top of the VBS
editor. The buttons arranged on the toolbars enable quick, easy access to the functions
provided in Global Script and the action editor in Graphics Designer.
Global Script/Graphics Designer provide the following toolbars:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 33
VBS for Creating Procedures and Actions
1.8 VBScript Editors
"Standard" toolbar
Button Function Key combination
Creates a new project module (Global Script only) <ALT+F1>
Creates a new standard module (Global Script only) <ALT+F2>
Creates a new global action (Global Script only) <ALT+F3>
Opens an existing action or existing module (Global Script only) <CTRL+O>
Saves the content of the active editing window. This function is only available if <CTRL+S>
an editing window is open. After saving the display in the navigation window is
refreshed. (Global Script only)
Prints the contents of the active editing window as project documentation. This <CTRL+P>
function is only available if an editing window is open.
Cuts the selected text and copies it to the clipboard. This function is only available <CTRL+X>
if text has been selected.
Copies the selected text to the clipboard. This function is only available if text <CTRL+C>
has been selected.
Pastes the contents of the clipboard at the location of the cursor. This function <CTRL+V>
is only available if the clipboard is not empty.
Undoes the last of a maximum of 30 editor actions. This function is only available <CTRL+Z>
if an editor action has been executed.
Redoes the last editor action that was undone. This function is only available if <CTRL+Y>
an editor action has been undone.
Activates the direct help F1
"Editor" Toolbar Content
Button Function Key combination
Indents the line, in which the cursor is located, one position to the right. --
Indents the line, in which the cursor is located, one position to the left. --
Marks the lines selected by the mouse as comments. If no lines have been --
selected by the mouse, the line in which the cursor is located is marked as a
comment.
Removes the comment marking from the lines selected by the mouse. If no lines --
have been selected by the mouse, the comment marking in the line in which the
cursor is located is removed.
Sets a bookmarks in the current line. Actuating again removed the bookmark <CTRL+F9>
from the current line.
Removes all bookmarks from the current code in the editing window. <CTRL+SHIFT+F9>
Moves the cursor one bookmark further. <F9>
Moves the cursor one bookmark back. <SHIFT+F9>
Opens the "Find" dialog for text search in the code. <CTRL+F>
Opens the "Replace" dialog for search and replace in the code. <CTRL+H>
WinCC: Scripting (VBS, ANSI-C, VBA)
34 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.8 VBScript Editors
Button Function Key combination
Repeats the search process. <F3>
Opens the "Script editor options" dialog. --
Content of the "Edit" Toolbar
Button Function Key combination
Selects the file in the navigation window to which the current editing window be‐ --
longs (Global Script only).
Displays all the files in the navigation window (Global Script only). --
Only displays the Script files in the navigation window (Global Script only). --
Only displays the syntactically correct files in the navigation window (Global Script --
only).
Executes a Syntax Check in the code of the current editing window. <F7>
Opens a tag selection dialog returns the selected tag name as the return value. <CTRL+U>
Opens a tag selection dialog and returns the tag name with an associated refer‐ <CTRL+W>
ence.
Opens a picture/object browser in which a picture/object can be selected whose <CTRL+Q>
name is then used for the return value.
Opens a picture selection dialog for pictures and returns the picture name, with <CTRL+B>
the server prefix if necessary.
Opens the "Info/Trigger" dialog. <CTRL+T>
Additional Buttons in Graphics Designer
In addition to the buttons provided by Global Script, the action editor in Graphics Designer also
has the following buttons:
● Displaying the declaration area (<CTRL+E>)
● Hiding the declaration area (<CTRL+A>)
See also
Global Script Editor (Page 28)
1.8.5 Deleting Actions or Procedures
Introduction
If an action, procedure or a module is deleted in a script editor, the code and corresponding
file are deleted in the project directory.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 35
VBS for Creating Procedures and Actions
1.8 VBScript Editors
Be careful only to delete procedures which are no longer used in other procedures or actions.
If an action attempts to call in a procedure which no longer exists, the action is stopped in
Runtime at the fault point. A non-existing reference in the code is not detected by the syntax
check.
Note
Procedures can only be deleted within a module by deleting the code, not in the editor's
navigation window.
Procedure
1. Open Global Script.
2. Select the action or module to be deleted in the navigation window.
3. Select the "Delete" command from the context menu.
4. To delete a procedure: Open the relevant module and delete the corresponding code in
the editing window.
See also
Actions (Page 19)
Modules and Procedures (Page 16)
Global Script Editor (Page 28)
WinCC: Scripting (VBS, ANSI-C, VBA)
36 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
1.9 Creating and Editing Procedures
1.9.1 Creating and Editing Procedures
Introduction
Projects and standard procedures can be programmed in WinCC using VBS:
● Project procedures can only be retrieved in the current project.
Since procedures are stored in the project directory, they are automatically copied when a
project is copied.
● Standard procedures can be called in by all computers linked to a project.
When a project is copied onto another computer, the standard procedures must be copied
into the corresponding directory on the target computer manually.
The copied procedures are directly available for use in Runtime. The become visible in the
editor when the view is updated.
In addition to the procedures you have programmed, you can use general VBS functions (e.g.
Abs, Array,... Year). These general VBS functions can be invoked in the code using the
"Function List" command from the context menu.
In addition, WinCC provides the most popular instructions as code templates (e.g. If...Then,
When...While). The code templates can be moved from the navigation window's Code
Templates tab control directly into your code via drag&drop.
If you insert a code template into your code, it is important to note that, for example, conditions
in the templates are identified by "_XYZ_". You must replace these placeholders with the
appropriate information.
Using Procedures
Procedures are used for the central creation and maintenance of codes which are to be
implemented at several point in the configuration.
Codes are written and saved in a procedure and the procedure is called in with the current
parameters in actions or other procedures instead of repeatedly entering the same code.
Create procedures for repeated functionalities, e.g.
● Calculations with different starting values (procedure with return value)
● Checking tag values (procedure with return value)
● Executing tasks (procedure with return value)
This is linked to the following advantages:
● The code is only programmed once.
● Modifications are only made at one point, namely in the procedure, not in each action.
● The action code is shorter and, thus, remains clearer.
Related procedures should be stored in modules in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 37
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
Procedures are loaded in Runtime when the calling action is executed.
Note
Global tags: Global Script and Graphics Designer
Procedures can be used in actions in Global Script and Graphics Designer.
In order to use a global tag defined in Global Script in an action in Graphics Designer, observe
the following:
● In order that access can be made to the tag, it is necessary to call in the procedure in which
the tag is defined.
In order to use a global tag in picture-independent actions in Global Script, observe the
following:
● In order that access can be made to the tag, at least one procedure in the module containing
the tag must be called in at least one global action.
Changing modules and procedures
If a procedure (module) used in a picture is modified, the modification is applied the next time
the picture is loaded.
WinCC: Scripting (VBS, ANSI-C, VBA)
38 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
This means that a picture currently displayed only works with the modified procedure after the
picture has been reloaded.
Saving a process picture after module change
After having a changed project module and saved the file in the VBS Editor, you must also
open and save the corresponding process picture in Graphics Designer. This also applies if
you insert new functions from other modules.
By saving the picture, you activate the information in the picture file by means of the necessary
project modules.
The change is only applied in Runtime after the process picture the saved.
Procedure - Action Restrictions
Global procedures valid for the entire project can only be created in Global Script. Graphics
Designer can only be used to create picture-specific procedures and call in global procedures
in actions. Picture-specific procedures in Graphics Designer are defined in the declaration area
of an action.
A procedure is not executed without an action.
File Name and Procedure Name
The procedure name is entered in the first line of the procedure code. The procedure is
displayed in the navigation window and called in actions under this name. Procedures do not
have a file name of their own but are stored in a module.
Module names are assigned in the editor's navigation window. Use the "Save As" command
to save a module under another name in the project directory.
Since procedures in Global Script are valid for the entire project, procedure names must always
be unique. Module names can be used more than once within a project, e.g. in different
subdirectories or stored separately in the standard and project directories.
Displaying Procedures and Modules
If you save a module that contains at least one syntactically incorrect procedure, this will
be displayed in the navigation window with this adjacent symbol.
Note
If a module contains a syntactically incorrect procedure, the module can no longer be loaded.
Procedures can no longer be called from the module.
If you save a module that contains only syntactically incorrect procedures, this will be
displayed in the navigation window with this adjacent symbol.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 39
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
Procedures and Modules
Procedures are classified as standard or project procedures according to their assignment to
standard or project modules. Standard and project modules are located o the corresponding
tab controls in the Global Script navigation window.
Use the modules in order to compile procedures to practical function groups. Observe the
following when structuring the modules and procedures:
● The more modules that must be loaded when a picture is called in, the worse the
performance in Runtime.
● The larger a module, the more procedures are contained and, thus, the longer the loading
time for the module.
Organize the modules sensibly, e.g. a module with procedures for a specific system part/
picture.
See also
Multiple Use of Procedures and Actions (Page 21)
Renaming a Procedure or Module (Page 51)
Saving a Procedure (Page 49)
Protecting a Module with a Password (Page 48)
How to add module-related information (Page 46)
Using Standard and Project Procedures (Page 45)
How to Write Procedure Codes (Page 42)
Creating a New Procedure (Page 40)
Examples of VBScript (Page 825)
Modules and Procedures (Page 16)
1.9.2 Creating a New Procedure
Introduction
Standard projects and procedures can be programmed with Global Script in WinCC.
The type of procedure is defined by the assignment to a project or standard module. The
procedure to create standard or project procedures is identical.
On creating a new procedure, WinCC automatically assigns a standard name "procedure#",
in which case # represents a continuous number. If the procedure is edited in the editing
WinCC: Scripting (VBS, ANSI-C, VBA)
40 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
window, assign the procedure a corresponding name via which the procedure can be called
in an action later. The name appears in the navigation window when the procedure is saved.
Note
Procedure names must be unique within a project. If a procedure with the same name already
exists, the module is identified as syntactically incorrect. Module names can be used twice
when the modules are stored in different directories.
Global procedures (valid for the for entire project) can only be programmed Global Script.
Procedures can be called via actions in Graphics Designer and picture-related procedures
created in the declaration area of an action. Using a global action in Global Script, it is possible
to create procedures directly in the code which are then only applicable for this action.
An action must be programmed in order to call in a procedure.
Procedure
The following procedure describes the creation of a new procedure in Global Script:
1. Open Global Script.
2. In the navigation window, select the standard modules or project modules tab control
according to whether a standard procedure or project procedure is to be created.
3. Open an existing module or create a new module using the menu commands "File" > "New"
> "Project Module" or "File" > "New" > "Standard Module".
4. After having created a new module, the structure of a procedure without return value is
already entered in the editing window:
5. Enter the procedure name direct in the code: Sub "Procedure name".
6. To insert one procedure in an existing module: Select the module in the navigation window
and then select the "Insert New Procedure" shortcut menu command.
The "New Procedure" dialog appears:
7. Enter a procedure name and select whether the procedure should have a return value
parameter. The definition of a tag for the return value is then entered in the code (Dim
RetVal).
8. Confirm your settings with "OK".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 41
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
Note
A new procedure can also be entered directly in a module. In the case of procedures without
return value, always begin with the instruction "Sub <Procedure name>" and conclude with
"End Sub". In the case of procedures with return value, always begin with the instruction
"Function <Procedure name>" and conclude with "End Function". The new procedure is
displayed in the navigation window when the module is saved.
See also
Creating and Editing Procedures (Page 37)
Multiple Use of Procedures and Actions (Page 21)
Renaming a Procedure or Module (Page 51)
Saving a Procedure (Page 49)
Protecting a Module with a Password (Page 48)
How to add module-related information (Page 46)
Using Standard and Project Procedures (Page 45)
How to Write Procedure Codes (Page 42)
Modules and Procedures (Page 16)
1.9.3 How to Write Procedure Codes
Introduction
Procedure codes are written in the Global Script editor window. The code of each procedure
can call in other procedures via their procedure names.
Procedures can be created with or without return values. Use the return value to receive
information about successful execution of the procedure, for example.
If you modify a procedure in a picture, the modification will not take effect until the next time
you load the picture.
Functions in Global Script
Global Script provides the following functions to support the creation of procedure codes:
WinCC: Scripting (VBS, ANSI-C, VBA)
42 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
Intellisense and Highlight Syntax
During text entry, context-sensitive lists appear containing the properties, methods, and objects
possible at the current code position. If you insert an element from the list, the required syntax
is also entered automatically.
Note
Full intellisense for all objects can only be utilized in the Graphics Designer if the list is accessed
using the object name and the result is assigned to a tag. Otherwise, you are only offered a
list of standard properties.
Example of a full intellisense:
Dim Variable
Set Variable = ScreenItems ("Circle1")
Variable.<Intellisense selection>
If picture window limits are exceeded during addressing, it is once again only the standard
properties which are offered since the picture of the picture window is not loaded.
General VBS Functions
Use the "Function List" command of the shortcut menu in the editing window to display a list
of general VBS functions.
Lists of Objects, Properties and Methods
Using the shortcut menu in the editing window, you can view a list of the possible objects by
calling the "Object List" command in Graphics Designer. Global Script provides only the
"HMIRuntime" object in this list because there is no direct access to the objects of Graphics
Designer.
Use the "Properties/Methods" command of the shortcut menu to call a list of possible properties
and methods.
The same lists can be called in with the key combination <CTRL + SPACEBAR> according to
the context of the script.
Code Templates
In the "Code templates" tab in the Navigation window of the Editor, you will find a selection of
frequently used instructions, e.g. for loops and conditional instructions. The templates can be
inserted in the procedure code with "drag-and-drop".
If you want to insert a code template into your code, you have to replace the "_XYZ_"
placeholder in the templates with the respective data.
Selection Dialogs
If WinCC tags or WinCC objects are used in the code, the following selection dialogs are
available for use:
● Opens a tag selection dialog and returns the selected tag name as the return value.
● Opens a tag selection dialog and returns the tag name with an associated reference.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 43
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
● Opens a picture/object browser in which a picture/object can be selected whose name
is then used for the return value.
● Opens a picture selection dialog for pictures and returns the picture name, with the server
prefix if necessary.
Syntax Check
Global Script supports you with a syntax check which you can perform after the code has been
created. Syntax errors in the code are displayed in the output window of the editor. You can
move to the erroneous point in the code by double-clicking the error in the output window.
Note
The syntax check can only detect syntax errors in the code. Programming errors, such as
missing references, only become visible in Runtime. You should therefore also always check
your scripts in the Runtime environment.
Changing a Procedure
If a procedure is modified during Runtime, the modification becomes active at the following
times:
● Procedures called from actions or other procedures in pictures become active following a
picture change.
● Procedures in Global Script become active directly after being called again.
Procedure
1. Open Global Script.
2. Open the module containing the procedure to be edited.
3. After double clicking on the procedure in the navigation window, the cursor skips to the
beginning of the required procedure.
4. Edit the procedure. If you create a procedure with a return parameter, e.g. to program
recurring evaluations or reviews, indicate the return value with "procedurename = RetVal"
at the end of the procedure.
See also
How to Write Procedure Codes (Page 42)
Multiple Use of Procedures and Actions (Page 21)
Renaming a Procedure or Module (Page 51)
Saving a Procedure (Page 49)
Protecting a Module with a Password (Page 48)
How to add module-related information (Page 46)
Creating a New Procedure (Page 40)
WinCC: Scripting (VBS, ANSI-C, VBA)
44 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
Modules and Procedures (Page 16)
Creating and Editing Procedures (Page 37)
1.9.4 Using Standard and Project Procedures
Introduction
Use the drag&drop function in the navigation window or the context menu to insert a procedure
in the current code.
Project procedures can only be used within the current project, standard procedures are
available for all projects on the computer.
Procedures, once created, can be used in other projects or on other computers. To do this,
copy the module containing the procedures in the appropriate project or standard directory.
Using Procedures in Graphics Designer and Global Script
Procedures defined in Global Script can be called in actions in Global Script and Graphics
Designer. On executing the action in Runtime, the entire module which contains the procedure
is loaded.
Please observe the following in order to use a global tag defined in a procedure in Global
Script:
When using Graphics Designer, always call the procedure in which the tag is defined so that
the tag can be used. I the procedure is not called in, the corresponding module is not loaded
and access cannot be made to the tag.
In the case of picture-independent actions in Global Script, at least one procedure in the module
containing the tag must be called in at least one global action.
Note
In the general declaration part of screens, no check is made whether a procedure or function
name has already been assigned. Therefore, a name could occur several times and it is not
defined which function will be executed. This is standard behavior of the MS Scripting Engine.
Procedure
1. Open the procedure or action in which the procedure should be inserted.
2. Use the drag&drop function to move the procedure to be inserted from the navigation
window to the correct position in the code.
or
3. Place the cursor at the position in the code where you would like to insert teh procedure.
4. Mark the procedure in the navigation window with the mouse.
5. Choose pop-up menu command "Transfer Procedure Retrieval".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 45
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
See also
Creating and Editing Procedures (Page 37)
Multiple Use of Procedures and Actions (Page 21)
Renaming a Procedure or Module (Page 51)
Saving a Procedure (Page 49)
Protecting a Module with a Password (Page 48)
How to add module-related information (Page 46)
How to Write Procedure Codes (Page 42)
Creating a New Procedure (Page 40)
Modules and Procedures (Page 16)
1.9.5 How to add module-related information
Introduction
Related information can be added to each module in order to quickly recognize the functionality
of the module or the procedures contained in it when edited at a later date. If several operators
are involved in configuring a project, you should provide module-related information for your
colleagues.
When a new module is created, the creation date is entered in the module-related information
automatically and is unchangeable. The Module is also assigned the version number 1.0. The
version numbers can be individually assigned when editing a module. When a module is
changed and saved, the current date of change is entered automatically and is unchangeable.
The following information can be added:
● "Created by"
● "Changed by"
● "Comments" e.g. module functionality/procedures contained
It is still possible to define a password for the module. Further information on assigning
passwords is provided in "Protecting Modules with a Password".
WinCC: Scripting (VBS, ANSI-C, VBA)
46 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
Procedure
1. Open Global Script.
2. Select the module in which information is to be added in the navigation window.
3. Click the "Info/Trigger" toolbar button, or select the "Info" menu command. The
"Properties..." dialog appears.
Enter the required information.
Note
The "Info/Trigger" dialog can also be called if an open procedure is selected in the navigation
window. The information stored in this dialog is always valid for the entire module and all the
procedures contained in it.
See also
Multiple Use of Procedures and Actions (Page 21)
Renaming a Procedure or Module (Page 51)
Saving a Procedure (Page 49)
How to add module-related information (Page 46)
Using Standard and Project Procedures (Page 45)
How to Write Procedure Codes (Page 42)
Creating a New Procedure (Page 40)
Modules and Procedures (Page 16)
Creating and Editing Procedures (Page 37)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 47
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
1.9.6 Protecting a Module with a Password
Introduction
A module can be assigned a password to protect it from unauthorized access. The password
is a part of the module-related information.
Note
If a module is protected by a password, all the procedures contained in it are also protected
by the password.
Procedure
1. Open Global Script.
2. Select the module to be assigned a password in the navigation window.
3. Click the button "Info/Trigger" in the toolbar or choose the pop-up menu command "Info".
The "Properties..." dialog appears.
4. Activate the check box "Password".
The dialog "Enter Password" is displayed.
5. Enter a password and confirm it.
6. Confirm your settings with OK.
Result
If an attempt is made to open the module or a procedure contained in it, a prompt appears
requesting the password.
Deactivate Password Protection
To clear the password protection, disable the "Password" check box.
Change Password
To change the password, open in the Properties dialog and click the "Change" button. Then
enter the new password.
Note
If you forget the module password, the module cannot be edited.
Note
The "Info/Trigger" dialog can also be called if an open procedure is selected in the navigation
window. The information stored in this dialog is always valid for the entire module and all the
procedures contained in it.
WinCC: Scripting (VBS, ANSI-C, VBA)
48 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
See also
Multiple Use of Procedures and Actions (Page 21)
Renaming a Procedure or Module (Page 51)
Saving a Procedure (Page 49)
How to add module-related information (Page 46)
Using Standard and Project Procedures (Page 45)
How to Write Procedure Codes (Page 42)
Creating a New Procedure (Page 40)
Modules and Procedures (Page 16)
Creating and Editing Procedures (Page 37)
1.9.7 Saving a Procedure
Introduction
Individual procedures are never stored but the module in which the procedure has been
programmed.
Before saving a module, check the code is syntactically correct. When saving a module, the
procedures contained are automatically checked and, in the case of syntax errors, a prompt
appears as to whether the module should be saved with the errors or not. In this way, for
example, modules and procedures can be saved which are not fully programmed. Syntactically
incorrect procedures do not run in Runtime.
Note
If a module contains a syntactically incorrect procedure, the module can no longer be loaded.
Procedures can no longer be called from the module.
Note
The syntax check can only detect syntax errors in the code. Programming errors, such as
missing references, only become visible in Runtime. Therefore, always check the scripts in
the Runtime environment and use a debugger, if necessary, to detect and eliminate errors.
Only syntactically correct modules are called in Runtime.
A list of all the possible syntax errors is available in the Appendix under " Basic Principles of
VBScript".
If a procedure is subjected to a syntax check prior to saving, any errors are displayed in the
lower part of the editor window. Double click on an error line to access the error position in the
code directly.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 49
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
Use the "Save As" command to store the module under another name. Note that the new
module is only displayed in the navigation window after updating the view.
Requirement
The procedure/module to be saved must be open in the editor window.
Procedure
1. Click in the toolbar.
2. If syntax errors appear in the output window, double click on the error line and correct the
error in the code. Repeat steps 1 and 2 until the code is correct.
3. Save the module by clicking in the toolbar.
Note
Pictures with modified procedures must be opened and saved once again in Graphics Designer
In addition to saving in the VBS editor, the corresponding picture must be opened and saved
once again in Graphics Designer when the project module is changed. The change is then
applied in Runtime. Only once the picture has been saved is the information applied to the
picture file via the required project modules.
See also
Diagnostics (Page 78)
Multiple Use of Procedures and Actions (Page 21)
Saving a Procedure (Page 49)
Protecting a Module with a Password (Page 48)
How to add module-related information (Page 46)
Using Standard and Project Procedures (Page 45)
How to Write Procedure Codes (Page 42)
Creating a New Procedure (Page 40)
Modules and Procedures (Page 16)
Creating and Editing Procedures (Page 37)
WinCC: Scripting (VBS, ANSI-C, VBA)
50 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
1.9.8 Renaming a Procedure or Module
Introduction
Procedures and modules are renamed in the following cases:
● When a standard name (procedure# or Modul#), which was automatically assigned when
the new module/new procedure was created, is changed to a self-explanatory name.
● When a module or procedure is copied in order, for example, to create a new module with
similar content from an existing one.
Please note that procedure names must be unique within a project. Procedure names which
exist twice are issued as errors during the syntax check.
Contrary to procedure names, the same name can be applied to modules when the modules
are stored in different directories.
Note
The module name is always identical to the file name in the WinCC file system. If a module
name is changed, e.g. in Windows Explorer, the new module name is taken over from Global
Script in the navigation window.
Procedure
Renaming Procedures
1. Open the procedure to be renamed.
2. Enter the new name in the header of the procedure.
3. Save the procedure so that the name is transferred to the navigation window. Procedure
names are always unique and may not be used more than once.
Renaming Modules
1. Close the module to be renamed.
2. Select the module in the navigation window and choose the "Rename" option from the
context menu.
3. Enter the new name in the navigation window. Module names are always unique at directory
level and may not be used more than once.
See also
Multiple Use of Procedures and Actions (Page 21)
Saving a Procedure (Page 49)
Protecting a Module with a Password (Page 48)
How to add module-related information (Page 46)
Using Standard and Project Procedures (Page 45)
How to Write Procedure Codes (Page 42)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 51
VBS for Creating Procedures and Actions
1.9 Creating and Editing Procedures
Creating a New Procedure (Page 40)
Modules and Procedures (Page 16)
Creating and Editing Procedures (Page 37)
WinCC: Scripting (VBS, ANSI-C, VBA)
52 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
1.10 Creating and Editing Actions
1.10.1 Creating and Editing Actions
Introduction
When using VBS in WinCC, there is no differentiation between local (valid for entire project)
and global (valid on all computers) actions, as opposed to C. A configured action is always
valid globally.
A copied action is available for use in Runtime following a restart or opening and saving the
action. The become visible in the editor when the view is updated.
VBS actions can be used in to make graphic objects and object properties dynamic in Runtime
or to execute picture-independent actions.
Note
Please note that the object name length of objects made dynamic in Graphics Designer is
limited to approx. 200 characters, and each special character used in an object name is
converted to five characters in the script files. The special characters are represented by a
four-place hexadecimal code behind the preceding X. If the name of an object made dynamic
is too long, a corresponding error message appears. Further information is available in this
help under "Structure of VBScript Files".
Note
If you make an object property dynamic with a VBS action via the return value of a script, the
value of the object property is written only if it has changed in relation to the last script run. It
is not considered if the value had been changed from another location.
Therefore it is illegal to change properties which have been made dynamic by VBS action via
the return value from another location (e.g., other C scripts or VBS scripts).
if you do not observe this, wrong values can be the results.
Using the Actions
Actions can be used as follows:
On graphic objects in Graphics Designer
Making properties dynamic (action with return value), e.g.:
Function BackColor_Trigger(ByVal Item)
'VBS143
BackColor_Trigger = RGB(125,0,0)
End Function
Triggered by an event on an object (action without return value), e.g.:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 53
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Sub OnClick(ByVal Item)
'VBS144
Item.BackColor = RGB(255,0,0)
End Sub
Picture-independent in Global Script
As a cyclic action, e.g. incrementing a tag:
Option Explicit
Function action
'VBS145
Dim objTag1
Dim lngValue
Set objTag1 = HMIRuntime.Tags("Tag1")
lngValue = objTag1.Read
objTag1.Write lngValue + 1
action = CLng(objTag1.value)
End Function
Executing Actions
An action can be assigned several triggers. The action is always executed when one of the
triggering events occurs. Observe the following:
● Actions in Global Script cannot be executed simultaneously. The action triggered last is
held in a queue until the action currently being performed is completed.
● When using Graphics Designer, cyclically and tag-driven actions cannot be triggered
simultaneously. If the execution of a tag-driven action hinders the execution of a cyclic
action, the cyclic action is executed when the tag-driven action has finished. The cyclic
action is held in a queue during the non-execution phase. When the current action is
completed, the cyclic action is executed with the normal cycle.
● In Graphics Designer, event-driven actions cannot be executed simultaneously.
The action types mentioned do not prevent each other being executed: The execution of
actions in Global Script has no influence on actions in Graphics Designer. In the same way,
in Graphics Designer, the execution of cyclically or tag-driven actions has no effect on the
execution of event-driven actions.
Note
Actions in pictures which are still running one minute after the picture has been deselected
are terminated by the system. This is recorded in a logfile entry.
WinCC: Scripting (VBS, ANSI-C, VBA)
54 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Locating Actions
All the actions used in a picture can be displayed by means of the picture properties. To do
this mark the picture in WinCC Explorer and select the "Properties" context menu command.
After double clicking on an entry, detailed information on the type of dynamics appears.
It is also possible to display all the tags and pictures used in actions by means of the WinCC
CrossReference. CrossReference can also be used for the to link tag connections of Graphics
Designer actions easily.
Note
Use the standard formulations
HMIRuntime.BaseScreenName = "Screenname" and HMIRuntime.Tags("Tagname") when
addressing pictures and tags in your code in order to ensure that the pictures and tags are
registered by the CrossReference.
Procedure - Action Restrictions
Actions can be used to program instructions and call procedures. Codes are programmed
within in procedures for use at several points in a configuration. Contrary to procedures, actions
always have a trigger.
Creating and Editing Actions
Actions can be configured in Global Script and Graphics Designer. Use Global Script to
configure global actions which can be executed independently of the picture currently open.
Graphics Designer is used to configure actions related to graphic objects which should be
executed when the picture is opened in Runtime or when the configured trigger occurs.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 55
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
The script editors in WinCC provide the option of checking that scripts have a correct syntax
without executing them. Errors in the script are displayed in the output window under the editor
window. Double click on the corresponding error line to access the related point in the code.
Note
The syntax check can only check objects known to the system at the moment of execution.
Therefore, the tags and objects addressed in the scripts must be created in WinCC.
Only syntactically correct actions are executed in Runtime.
The automation objects "PDLRuntime" and "WinCC Runtime Project" cannot be used in VBS
actions.
Display of Actions
If you save a syntactically incorrect action, it will be displayed in the navigation window with
this adjacent symbol.
If you save a syntactically correct action without trigger, it will be displayed in the Global
Script navigation window with this adjacent symbol.
If you save a syntactically correct action with trigger, it will be displayed in the Global Script
navigation window with this adjacent symbol.
Note
Actions can only be saved in the Graphics Designer if they have the correct syntax. If an action
with errors should still be retained and exited, however, enter the comments.
System behavior if actions are changed, deleted and saved at Runtime
If a local action is stored at runtime, then all local and global actions of the computer are reset
on the computer to which the local action belongs.
If a global action is stored during runtime, then all local and global actions for the entire project
– and thus on all computers – are reset.
Such a reset might reinitialize for examples tags and times that are used as triggers for actions,
triggering the action at that stage.
Static tags used in the reset actions are reinitialized.
See also
Structure of VBScript Files (Page 90)
Action and Procedure Names in the Debugger (Page 92)
How to Rename an Action (Page 75)
Saving Actions (Page 64)
Protecting an Action with a Password (Page 63)
WinCC: Scripting (VBS, ANSI-C, VBA)
56 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
How to add action-related information (Page 61)
How to Edit Actions (Page 58)
Creating a New Action (Page 57)
Triggers (Page 65)
Actions (Page 19)
1.10.2 Creating a New Action
Introduction
When a new action is created, the editor automatically suggests a file name (Action#.bac),
which can be changed.
Actions can be configured in Global Script and Graphics Designer.
● Global Script is used to configure actions which can be executed, picture-independently,
in Runtime. Open Global Script via WinCC Explorer.
● Graphics Designer is used to configure a new action, related to the properties of a graphic
object, by clicking on the right mouse button in the "Dynamic" column of the Properties tab
control and selecting VBS Action. An action, related to an event, is created in the same
way using the Events tab control.
In both cases, the Action Editor of the Graphics Designer opens.
Note
The precise procedure for linking actions with graphic objects is described under the WinCC
help topic "Dynamics".
Procedure
1. Open Global Script.
2. Activating the Actions Tab Control in the Navigation Window.
3. Click in the toolbar or choose the menu command "File" > "New" > "Action".
A new action is opened in the editor window. The action appears in the navigation window
after it has been saved.
Note
When creating a new action, the "Option explicit" instruction is automatically entered in the
declaration area and cannot be deleted. The instruction is necessary as it prevents errors
caused by the incorrect notation of tags without declaration.
The instruction requires that tags are always defined in your code with the "Dim" instruction.
Do not use the "Option explicit" instruction in the code because it may cause Runtime errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 57
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
See also
How to Rename an Action (Page 75)
Saving Actions (Page 64)
Protecting an Action with a Password (Page 63)
How to add action-related information (Page 61)
How to Edit Actions (Page 58)
Triggers (Page 65)
Creating and Editing Actions (Page 53)
Actions (Page 19)
1.10.3 How to Edit Actions
Introduction
An action is edited in the same way as a procedure in the editor window of the editor or in the
Graphics Designer action editor.
In order that an action can be executed in Runtime, it requires a trigger. Actions which are
triggered by an event in Graphics Designer do not require the assignment of a trigger.
If an action is modified during Runtime, the change is applied when the picture is reloaded (in
the case of actions in Graphics Designer) or the next time the action is called (in the case of
actions in Global Script).
Note
A change in the code in Runtime cannot be applied when another action is being carried out
at the same time.
A procedure call can be inserted in the action by dragging the procedure from the editor
navigation window with "drag-and-drop" and dropping it in the corresponding position of the
code in the editor window. C scripts cannot be called in VBS actions.
Declaration Area in Actions
If you create actions in Graphics Designer, you can display the declaration area of the action
using the button . When creating a new action, the "Option explicit" instruction is
automatically entered in the declaration area and cannot be deleted. The instruction is
necessary as it prevents errors caused by the incorrect notation of tags without declaration.
The instruction requires that tags are always defined in your code with the "Dim" instruction.
Do not use the instruction "Option explicit" in your code as this can cause Runtime errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
58 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
In the declaration area, you can also make general settings which you want to use globally for
the current picture, e.g.:
● Tag Definitions
● Procedures which you only want to use in this picture
In the declaration area of the actions, you may define global tags independent of each other
in the areas "Event" and "Properties" of an object. There is no link between global tags of
identical names in both areas.
Note
Always make sure that the procedures in the declaration area have correct syntax, i.e. with
"Sub" - "End Sub". Do not create directly executable codes in the declaration area as this can
cause Runtime errors.
If global tags are used in the declaration area of actions Graphics Designer, note that the event-
driven and cyclic/tag-driven actions are processed separately in Runtime. There is no
synchronization of global tags between the two Runtime systems in Runtime. If synchronization
of tags is required, configure these using the DataSet object or internal WinCC tags.
When making definitions in the declaration area, pay attention to the structure of the Script
files, as described under "Structure of VBScript files".
Functions for Editing Actions
The script editors provide the following functions to assist you in creating action code:
Intellisense and Highlight Syntax
During text entry, context-sensitive lists appear containing the properties, methods, and objects
possible at the current code position. If you insert an element from the list, the required syntax
is also indicated automatically.
Note
Full intellisense for all objects can only be utilized in the Graphics Designer if the list is accessed
using the object name and the result is assigned to a tag. Otherwise, only a list of standard
properties is offered.
Example of full intellisense:
Dim Variable
Set Variable = ScreenItems ("Circle1")
Variable.<Intellisense>
If picture window limits are exceeded during addressing, it is once again only the standard
properties which are offered since the picture of the picture window is not loaded.
General VBS Functions
Use the "Function List" command of the shortcut menu in the editing window to display a list
of general VBS functions.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 59
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Lists of Objects, Properties and Methods
Using the shortcut menu in the editing window, you can view a list of the possible objects by
calling the "Object List" command in Graphics Designer. Global Script only provides the
"HMIRuntime" object in this list because there is no direct access to the objects of Graphics
Designer.
Use the "Properties/Methods" command of the shortcut menu to call in a list of possible
properties and methods.
The same lists can be called in with the key combination <CTRL + SPACEBAR> according to
the context of the script.
Code Templates
In the "Code templates" tab in the Navigation window of the Editor, you will find a selection of
frequently used instructions, e.g., for loops and conditional instructions. The templates can be
inserted in the procedure code with "drag-and-drop".
If you want to insert a code template into your code, you have to replace the "_XYZ_"
placeholder in the templates with the respective data.
Selection Dialogs
If WinCC tags or WinCC objects are used in the code, the following selection dialogs are
available for use:
● Opens a tag selection dialog and returns the selected tag name as the return value.
● Opens a tag selection dialog and returns the tag name with an associated reference.
● Opens a picture/object browser in which a picture/object can be selected whose name
is then used for the return value.
● Opens a picture selection dialog for pictures and returns the picture name with the server
prefix, if necessary.
Syntax Check
Global Script supports you by providing a syntax check which you can perform after the code
has been created. Syntax errors in the code are displayed in the output window of the editor.
You can move to the erroneous point in the code directly by double-clicking the error in the
output window.
Note
The syntax check can only detect syntax errors in the code. Programming errors, such as
missing references, only become visible in Runtime. Therefore, always check the scripts in
the Runtime environment and use a debugger, if necessary, to detect and eliminate errors.
The way to test scripts with a debugger is described in this documentation under the topics
"Diagnostics" > "Testing with the Debugger".
WinCC: Scripting (VBS, ANSI-C, VBA)
60 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Procedure
1. Open Global Script.
2. Double click on the action on the Action tab control in the navigation window.
3. Edit the action.
See also
Using Global Tags in VBS (Page 25)
Testing with the Debugger (Page 85)
Structure of VBScript Files (Page 90)
How to Rename an Action (Page 75)
Saving Actions (Page 64)
Protecting an Action with a Password (Page 63)
How to Edit Actions (Page 58)
Creating a New Action (Page 57)
Triggers (Page 65)
Creating and Editing Actions (Page 53)
Actions (Page 19)
1.10.4 How to add action-related information
Introduction
Related information can be added to every action in Global Script in order that the function of
an action can be recognized at a later date when editing. If several operators are involved in
configuring a project, you should provide action-related information for your colleagues.
When a new action is created, the creation date is entered in the action-related information
automatically and is unchangeable. The action is also assigned version number 1.0. The
version numbers can be individually assigned when editing an action. When an action is
changed and saved, the current date of change is entered automatically and is unchangeable.
The following information can be added:
● "Created by"
● "Changed by"
● "Comments:" e.g. functionality of the action
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 61
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
It is also possible to define a password for the action. Further information on assigning
passwords is provided in "Protecting Actions with a Password".
Note
Additional information can only be made available actions in Global Script, not for actions in
Graphics Designer.
Procedure
1. Open Global Script.
2. Open the action for which information should be added.
3. Click the "Info/Trigger" toolbar button, or select the "Info" menu command. The
"Properties..." dialog appears.
4. Enter your information.
See also
How to Rename an Action (Page 75)
Saving Actions (Page 64)
Protecting an Action with a Password (Page 63)
How to Edit Actions (Page 58)
Creating a New Action (Page 57)
Triggers (Page 65)
WinCC: Scripting (VBS, ANSI-C, VBA)
62 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Creating and Editing Actions (Page 53)
Actions (Page 19)
1.10.5 Protecting an Action with a Password
Introduction
An action in Global Script can be protected against unauthorized access by assigning a
password to it. The password is a part of the action-related information.
Note
Only actions in Global Script can be assigned a password, not actions in Graphics Designer.
Procedure
1. Open Global Script.
2. Open the action to be protected by a password.
3. Click the button "Info/Trigger" in the toolbar or choose the pop-up menu command "Info".
The "Properties..." dialog appears.
4. Select the "Password" check box.
5. Click the "Change" button. The "Enter Password" window opens.
6. Enter a password and confirm it.
7. Confirm your settings with OK.
Result
If an attempt is made to open the action, the system requests the password is entered.
Deactivate Password Protection
To clear the password protection, disable the "Password" check box.
Change Password
To change the password, open in the Properties dialog and click the "Change" button. Then
enter the new password.
Note
If you forget the action password, the action cannot be edited.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 63
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
See also
How to Rename an Action (Page 75)
Saving Actions (Page 64)
How to add action-related information (Page 61)
How to Edit Actions (Page 58)
Creating a New Action (Page 57)
Triggers (Page 65)
Creating and Editing Actions (Page 53)
Actions (Page 19)
1.10.6 Saving Actions
Introduction
Before an action can be run in Runtime, it must be saved. Save an action as any other Windows
file using the "File" > "Save" commands or the corresponding icon.
Note
Actions in Graphics Designer are automatically applied on closing the action editor with the
picture. Functions can only be saved in the Graphics Designer if they have the correct syntax.
If an action with errors should still be retained and exited, however, enter the comments.
A list of all the possible syntax errors is available in the Appendix under " Basic Principles of
VBScript".
In order to save an action under a different name, e.g. to use an action as a basis for another
action, use the "Save As" command.
Note that, when using "Save As", only the file name is changed and not the action name.
Prior to Saving
Before saving an action, check the code is syntactically correct. The syntax errors in the code
are displayed in the output window of Global Script. Double click on an error line to access the
error position in the code directly.
Note
The syntax check can only detect syntax errors in the code. Programming errors, such as
missing references, only become visible in Runtime. Therefore, always check the scripts in
the Runtime environment and use a debugger, if necessary, to detect and eliminate errors.
If actions are saved without running a syntax check beforehand, the editor comments that a
syntactically incorrect action will be saved which cannot subsequently be run in Runtime.
WinCC: Scripting (VBS, ANSI-C, VBA)
64 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Syntactically incorrect actions are displayed with the adjacent icon in the navigation window.
Procedure
1. Click in the toolbar.
2. If errors are displayed in the lower part of the editor window, double click on the error line
and correct the error in the code. Repeat steps 1 and 2 until the code is correct.
3. Save the action by clicking in the toolbar.
See also
Actions (Page 19)
How to Rename an Action (Page 75)
Protecting an Action with a Password (Page 63)
How to add action-related information (Page 61)
How to Edit Actions (Page 58)
Creating a New Action (Page 57)
Triggers (Page 65)
Creating and Editing Actions (Page 53)
1.10.7 Triggers
1.10.7.1 Triggers
Definition and use
Triggers are used to execute actions at Runtime. To do this, a trigger is linked to an action,
forming the triggering event for calling the action. Actions without triggers will not be carried
out.
The triggers defined for an action are displayed in the Global Script navigation window .
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 65
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Trigger types
The following trigger types are available:
Acyclic triggers
They consist of the specification of date and time. The action specified by such a trigger is
performed once at the date and time specified.
Cyclic triggers
They consist of the specification of a time interval and start time. The following types of cyclic
triggers are available:
● Default cycle. The start of the first time interval coincides with the start of Runtime. The
length of the interval is determined by the cycle.
● Hourly. The start of the interval is specified as minute and second. The length of the interval
is an hour.
● Daily. The start of the interval is specified by the time (hour, minute and second) festgelegt.
The length of the interval is a day.
● Weekly. The start of the interval is specified by the day of the week (Monday, Tuesday,
etc.) and the time. The length of the interval is a week.
● Monthly. The start of the interval is specified by the day and time. The length of the interval
is a month.
● Annual. The start of the interval is specified by the day, month and time. The length of the
interval is a year.
Time-controlled triggers are used for actions Global Script and for actions to make graphic
objects dynamic.
Tag triggers
They consist of one or more specified tags. The action associated with such a trigger is
performed each time a change in the value of one of these tags is detected.
How the tag values are queried may be customized for each tag. Select from the following
modes:
● Cyclic query of the tag value: Specify a standard cycle. The tag value is queried at the
defined intervals (e.g. every 2 seconds). The action is triggered when the system detects
a change of the tag value.
Depending on the size of the cycle, it is possible that the tag value is changed but it is not
detected by the system.
If, for example, a cycle of 5 minutes has been set, the tag value may change several times
within the 5 minute period but only the value set when the next query is made is detected.
The value changes between the two queries are not registered.
● Changes in the tag value: Each change in the tag value is detected by the system. The
action is executed each time the tag value changes.
Tag triggers are used for actions Global Script and for actions to make graphic objects dynamic.
WinCC: Scripting (VBS, ANSI-C, VBA)
66 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Event-driven
When an action is configured related to an event on a graphic object, the action is triggered
when a specific event has occurred, e.g. following a mouse click or the change of the
background color due to another action.
Animation cycle
As of WinCC V7.0, the "animation cycle" trigger art is available for the dynamization of objects
with VBS. The animation cycle allows you to switch actions on and off in Runtime and to change
the time, in which the trigger is executed.
You can find additional information in the "AUTOHOTSPOT" section.
Effects of triggers on actions
If the action is associated with only one trigger, then the action is performed as soon as the
triggering event occurs.
However, an action may be associated with multiple triggers, such as a cyclic trigger and a
tag trigger. Here the action is performed whenever one of the two triggering events occurs. If
two events occur simultaneously, then the action is executed twice sequentially. If two tag
triggers fire at the same time, the action will be performed only once.
Processing actions in Graphics Designer
The following rules apply to processing actions in Graphics Designer:
● No event-driven actions can be executed as long as another event-driven action is running.
● No cyclic/tag triggered actions can be executed as long as another cyclic/tag triggered
action is running.
● The two action types do not affect each other: An event-driven action can also be executed
when a cyclic action is already in progress.
● If the execution of actions is blocked by other actions (e.g. a cyclic action by a tag-triggered
action), each action which is blocked is executed once at the next possible moment. Cyclic
actions then run in their normal intervals after the one-off execution.
Processing actions in Global Script
Picture-based actions from Global Script are executed in Runtime in succession after being
triggered. When an action is triggered while another action is in progress, the second action
is kept in a queue until it can be executed.
Actions in Global Script and Graphics Designer do not affect each other.
Note
If the action should not be executed at each event, it is possible to define a condition in the
action, the result of which controls whether the action is executed or not.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 67
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Notes on configuring triggers
Depending on the system, it cannot be guaranteed that an action with a cyclic trigger will be
carried out at exactly the specified time. If this is a requirement, then the task (such as a check)
should be implemented on the automation device.
The tag triggers should have priority over cyclic triggers: With cyclic actions, the action is
always executed, e.g. every 20 seconds. The tag trigger only executes the action if a change
in the value of the tag has been detected in the case of cyclic queries. This reduces the load
on the system and increases performance.
If a tag trigger is used, configure the "Upon Change" cycle to start as seldom as possible. This
query cycle causes the tag to trigger the action following every change. This causes high
system loads.
Linking tag triggers
The CrossReference from WinCC can be used to quickly find all the application points of tags,
even in VBS actions. Tag triggers in actions in Graphics Designer can be "linked" using
CrossReference, i.e. replaced by other tags at all or selected points.
Note
Tags can also be directly linked in Graphics Designer by marking the graphic object and
selecting the "Linking ..." command from the context menu.
Use the standard formulations
HMIRuntime.BaseScreenName = "Screenname" and
HMIRuntime.Tags("Tagname") when addressing pictures and tags in your code in order
to ensure that the pictures and tags are registered by the CrossReference.
Further information on CrossReference is available in the WinCC documentation.
WinCC: Scripting (VBS, ANSI-C, VBA)
68 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
See also
Actions (Page 19)
How to delete a trigger (Page 74)
How to change a trigger (Page 73)
How to add a trigger of the type "Tag" (Page 72)
How to add a trigger of the type "Timer" (Page 71)
Creating and Editing Actions (Page 53)
1.10.7.2 Animation trigger
Introduction
As of WinCC V7.0, the "animation cycle" trigger art is available for the dynamization of objects
with VBS. The animation cycle allows you to switch actions on and off in Runtime and to change
the time in which the trigger is executed.
Animation cycles
Name Cycle Name Cycle
CycleTime125ms 125 ms CycleUser1 User cycle 1
CycleTime250ms 250 ms CycleUser2 User cycle 2
CycleTime500ms 500 ms CycleUser3 User cycle 3
CycleTime1s 1s CycleUser4 User cycle 4
CycleTime2s 2s CycleUser5 User cycle 5
CycleTime5s 5s CyclePicture Picture cycle
CycleTime10s 10 s CycleWindow Window Cycle
CycleTime1min 1 min
CycleTime5min 5 min
CycleTime10min 10 min
CycleTime1h 1h
You use the trigger by writing an action and using the "animation cycle" trigger type. This action
can be activated or deactivated in Runtime with the "ActivateDynamic" and
"DeactivateDynamic" methods. The methods are described in the VBS reference of the WinCC
Information System. The correct syntax of the methods deviates from the description in the
VBS reference and is shown in the following two examples.
Example
With an action at the determined property "Position X" (left), the rectangle is shifted 5 pixels
to the right. Select the "animation cycle" event in the action as the trigger.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 69
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Enter the following as action in the "Left" property:
item.Left = item.Left + 5
You can switch the action on and off at the property "Position X" with the following methods.
The trigger is switched on in Runtime with the "ActivateDynamic" method:
Dim obj
Set obj = ScreenItems.Item("Rectangle1")
obj.ActivateDynamic "Left", "CycleTime1s"
The trigger is switched off in Runtime with the "DeactivateDynamic" method:
Dim obj
Set obj = ScreenItems.Item("Rectangle1")
obj.DeactivateDynamic "Left"
Note
The WinCC tags remain requested even when the trigger is switched off.
See also
ActivateDynamic method (Page 715)
WinCC: Scripting (VBS, ANSI-C, VBA)
70 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
1.10.7.3 How to add a trigger of the type "Timer"
Add
"Timer" type triggers execute an action at a certain time. "Timer" type triggers can be cyclic or
acyclic triggers.
● Acyclic triggers Trigger an action once at the configured time.
● Cyclic triggers Trigger an action at regular intervals. The time interval and start time for the
time must be triggered. If a standard cycle is selected as the cyclic trigger, the start time is
always the start of Runtime. User-specific cycles can also be selected as standard cycles.
Note
Cyclic triggers guarantee a high updating rate of the system but require high system loads.
Choose cyclic triggers only for those actions, where the update is very important.
With high system loads, some actions may not be executable.
"Timer" type triggers are used to make the properties in Graphics Designer dynamic and
execute global actions.
Procedure
1. Open the action.
2. Click the button "Info/Trigger" in the toolbar or choose the pop-up menu command "Info".
The "Properties..." dialog appears.
3. Select the "Triggers" tab.
4. Select the "Timer" trigger and then select the trigger type to be created: cyclic or acyclic.
5. Click on the "Add" button. The "Add Trigger" dialog appears.
– If the "acyclic" trigger type has been selected: Enter a relevant trigger name and define
the time at which the action should be executed.
– If the "cyclic" trigger type has been selected: Enter a relevant trigger name and define
the start time at which the action should be executed for the first time. Enter a cycle at
which the action should be repeated.
6. Click OK to confirm your entries.
Note
An action can be assigned several triggers. The action is always executed when one of the
triggering events occurs.
See also
How to delete a trigger (Page 74)
How to add a trigger of the type "Tag" (Page 72)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 71
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Triggers (Page 65)
Creating and Editing Actions (Page 53)
Actions (Page 19)
1.10.7.4 How to add a trigger of the type "Tag"
Introduction
"Tag" type triggers execute an action following the change of a tag value. Any internal or
external tag stored in WinCC can be used as a trigger tag.
Actions with tag triggers can be executed at the following times:
● On change of tag: The action is executed each time the tag value changes. Since this
setting causes a very high system utilization, the updating rate should be set as low as
possible.
● Query the tag status according to standard cycle (including user cycles): Define a cycle in
whose intervals the tag value should be queried. The action is only executed when the tag
value has changed when queried. When the query status is a large value, it is possible that
the tag value changes but it is not detected by the system. In this case the action is not
performed.
If an action is linked with several tags, the action is executed when one of the tag values
changes.
Procedure
1. Open the action.
2. Click the button "Info/Trigger" in the toolbar or choose the pop-up menu command "Info".
The "Properties..." dialog appears.
3. Select the "Triggers" tab.
4. Select "Trigger" as the tag.
5. Click on the "Add" button. The "Add Trigger" dialog appears.
6. Enter the name of the tag to be used as the trigger or click the button beside the "Tag Name"
field in order to select a tag from the tag selection dialog.
7. Double-click on the "Standard cycle" field to open the selection dialog for the tag update
cycle:
Select a cycle and click on OK to confirm the selection.
See also
How to delete a trigger (Page 74)
How to add a trigger of the type "Tag" (Page 72)
How to add a trigger of the type "Timer" (Page 71)
Triggers (Page 65)
WinCC: Scripting (VBS, ANSI-C, VBA)
72 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Creating and Editing Actions (Page 53)
Actions (Page 19)
1.10.7.5 How to change a trigger
Introduction
A defined trigger can be modified at any time, even during Runtime.
Procedure
1. Open the action whose triggers should be modified.
2. Click the button "Info/Trigger" in the toolbar
or choose the pop-up menu command "Info/Trigger". The "Properties..." dialog appears.
Alternatively, call in the dialog without executing the action by double clicking on the trigger
in the navigation window.
3. Select the "Triggers" tab.
4. Select the trigger to be modified and click the "Change" button.
5. Modify the trigger can confirm the entries with OK.
See also
Triggers (Page 65)
How to delete a trigger (Page 74)
How to add a trigger of the type "Tag" (Page 72)
How to add a trigger of the type "Timer" (Page 71)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 73
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Creating and Editing Actions (Page 53)
Actions (Page 19)
1.10.7.6 How to delete a trigger
Introduction
Defined triggers can be deleted at any time. Triggers can also be deleted during Runtime.
If a trigger is deleted in Runtime, it only takes effect after the action is saved.
Note
Actions without trigger are not executed in Runtime. None of the actions which used the deleted
trigger are executed any longer.
Procedure
1. Open the Global Script Editor or the Graphics Designer action editor.
2. Open the action.
3. Click the "Info/Trigger" toolbar button or select the "Info/Trigger" menu command. The
"Properties..." dialog appears.
4. Select the "Triggers" tab.
5. Select the trigger to be deleted and click the "Delete" button.
6. The trigger is deleted immediately.
WinCC: Scripting (VBS, ANSI-C, VBA)
74 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Note
Triggers can also be deleted directly in the Global Script navigation window using the "Delete"
command in the context menu.
See also
Actions (Page 19)
How to change a trigger (Page 73)
How to add a trigger of the type "Tag" (Page 72)
How to add a trigger of the type "Timer" (Page 71)
Triggers (Page 65)
Creating and Editing Actions (Page 53)
1.10.8 How to Rename an Action
Introduction
Actions can be renamed in Global Script. When an action is renamed, the action name and
file name are changed.
The action to be renamed must not be open in the editor window.
Procedure
1. Open Global Script.
2. Select the name of the action to be renamed in the editor's navigation window.
3. Select the "Rename" command from the context menu.
4. Enter a new name for the action with the extension *.bac.
See also
Protecting an Action with a Password (Page 63)
Saving Actions (Page 64)
How to add action-related information (Page 61)
How to Edit Actions (Page 58)
Creating a New Action (Page 57)
Triggers (Page 65)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 75
VBS for Creating Procedures and Actions
1.10 Creating and Editing Actions
Creating and Editing Actions (Page 53)
Actions (Page 19)
WinCC: Scripting (VBS, ANSI-C, VBA)
76 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.11 How to activate global actions in Runtime
1.11 How to activate global actions in Runtime
Introduction
Scripts defined in Global Script are always executed when the configured trigger occurs.
Scripts in the graphical Runtime system are executed when the picture is called in and the
configured event or trigger occurs.
In order that the picture-independent, Global Script global actions can be executed, the Global
Script Editor must be registered in the startup list of the Runtime computer.
Procedure
1. Select the "Properties" command in the computer's context menu WinCC Explorer. The
"Computer properties" dialog will open.
2. Click on the "Startup" tab
3. Selection option "Global Script Runtime".
4. Click OK to confirm your entries.
See also
Creating and Editing Actions (Page 53)
Creating and Editing Procedures (Page 37)
VBScript Editors (Page 27)
Using Visual Basic Script in WinCC (Page 12)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 77
VBS for Creating Procedures and Actions
1.12 Diagnostics
1.12 Diagnostics
1.12.1 Diagnostics
Introduction
If the scripts are executed and tested in Runtime, the Diagnostics window can be used to
display an analysis quickly.
Diagnostics Tools
WinCC provides a range of tools with which to analyze the behavior of actions in Runtime:
● The GSC Runtime and GSC Diagnostics application windows
● Use of a debugger
GSC Runtime and GCS Diagnostics
The GSC Runtime and GSC Diagnostics application window are used by inserting them in a
process screen. This can be a process screen developed for diagnostics purposes which is
called in Runtime.
The application windows are used for different strategies:
While Runtime is active, GSC Runtime provides information on the dynamic behavior of all
(Global Script) actions, enables the individual startup as well as log on and off of each individual
action and offers the access point to the Global Script Editor.
GSC Diagnostics issues the Trace methods contained in the actions in the chronological
sequence they are called. This also applies to Trace instructions in procedures which are called
in actions. The targeted implementation of Trace instructions, e.g. for the output of tag values,
enables the progress of actions and the procedures called in them to be traced. The Trace
instructions are entered in the form "HMIRuntime.Trace(<Ausgabe>)".
The GSC Diagnostics displays trace output from C and VBS.
Note
Runtime errors in VBS are not displayed
Some script errors are neither output via trace nor displayed via the error dialog.
Debugger
You can use the "Microsoft Visual Studio 2008" debugger to test your VB scripts in Runtime.
The debugger is included in the WinCC Setup. If another Visual Studio version is already
installed, Microsoft Visual Studio 2010 for example, use the debugger of this version.
WinCC: Scripting (VBS, ANSI-C, VBA)
78 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.12 Diagnostics
See also
Testing with the Debugger (Page 85)
GSC Runtime (Page 82)
GSC Diagnostics (Page 79)
1.12.2 GSC Diagnostics
1.12.2.1 GSC Diagnostics
Introduction
GSC Diagnostics displays the chronological sequence of calls of the trace methods contained
in the actions in the Diagnostics window. This also applies to Trace instructions in procedures
which are called in actions. The targeted implementation of Trace instructions, e.g. for the
output of tag values, enables the progress of actions and the procedures called in them to be
traced.
Application
In order to use GSC Diagnostics, insert a GSC Diagnostics type application window in a
process screen. The GSC Diagnostics attributes can be used to control the appearance of the
GSC Diagnostics window.
In the case of a picture change, the content of the GSC Diagnostics window is deleted.
Note
Messages are also displayed in the "GSC Diagnostics" window when the debugger is activated.
See also
GSC Diagnostics Toolbar (Page 81)
GSC Diagnostics Attributes (Page 80)
Inserting the GSC Diagnostics Window into a Picture (Page 80)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 79
VBS for Creating Procedures and Actions
1.12 Diagnostics
1.12.2.2 Inserting the GSC Diagnostics Window into a Picture
Introduction
In order to use GSC Diagnostics, insert a GSC Diagnostics process screen. The process
screen can be an existing picture or a picture which serves customized diagnostics purposes.
GSC Diagnostics cannot be inserted directly in the process screen as an application but is
inserted as an application in an application window. In this case, the application window is a
component part of the process screen.
Requirements
Graphics Designer has been started and the process screen is open.
Procedure
1. Use the "Smart Objects" object palette to insert the "Application Window" in the picture.
2. Select the "Global Script" option from the "Window Contents" dialog and confirm the
selection with "OK".
3. Select the "GSC Diagnostics" option from the "Templates" dialog.
4. Confirm the selection with OK in order to insert the Diagnostics window.
See also
GSC Diagnostics Toolbar (Page 81)
GSC Diagnostics Attributes (Page 80)
GSC Diagnostics (Page 79)
1.12.2.3 GSC Diagnostics Attributes
Overview
GSC Diagnostics has attributes which affect the appearance of the GSC Diagnostics window
in Runtime. These relate to the geometric attributes, particularly to the following:
● Display: This attribute defines whether the window should be visible or hidden. The attribute
can be made dynamic with the name Visible.
● Sizeable: This attribute defines whether the size of the window should be changeable in
Runtime.
● Movable: This attribute defines whether the window should be moveable or not during
Runtime.
● Border: This attribute defines whether the without is provided with a border. If the window
has a border, its height and width can be modified in Runtime.
● Title: This defines whether the window has a title bar.
WinCC: Scripting (VBS, ANSI-C, VBA)
80 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.12 Diagnostics
● Can be maximized: This attribute defines whether the title bar should contain the button to
maximize the window.
● Can be closed: This attribute defines whether the title bar should contain the button to close
the window.
● Foreground: This attribute defines whether the window should always be in the foreground.
See also
GSC Diagnostics Toolbar (Page 81)
Inserting the GSC Diagnostics Window into a Picture (Page 80)
GSC Diagnostics (Page 79)
1.12.2.4 GSC Diagnostics Toolbar
Overview
The GSC Diagnostics toolbar enables the output in the diagnostics window to be controlled
and to save, print and open window content:
1: Delete the content of the diagnostics window
2: Stop the window being updated
3: Activate the window being updated
4: Opens a text file in the window
5: Saves the window contents in a text file
6: Print the window contents
See also
GSC Diagnostics Attributes (Page 80)
Inserting the GSC Diagnostics Window into a Picture (Page 80)
GSC Diagnostics (Page 79)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 81
VBS for Creating Procedures and Actions
1.12 Diagnostics
1.12.3 GSC Runtime
1.12.3.1 GSC Runtime
Introduction
GSC Runtime is a window which displays the dynamic behavior of all Global Script actions in
Runtime. In addition, GSC Runtime can also be used during Runtime to influence the execution
of each individual action and provide access to the Global Script editor.
Actions
C actions and VBS actions are differentiated in the GSC Runtime window:
● Symbolizes a C action
● Symbolizes a VBS action
The following information is issued:
● Action name: The name of the action
● ID: Action ID. They are used internally by the system. GSC Runtime supplies the
corresponding action name together with the Action ID. The link between ID and action
name is only valid until Runtime is stopped or, during Runtime, until an action is saved.
● Status: Provides information on the current status of the action. Refer to the table below
for the possible statuses.
● Activation Interval: The time in the form Hour:Minute:Second, which should elapse between
the action being called.
● Return Value: The return value of the action
● Started On: Date and time the current action was started
● Next Start: Date and time the action will be started again
● Error message: Contains the error text in the case of an error
Actions Status
Possible action status:
● Action was activated.
● Action was deactivated
● Action was stopped.
● Action in progress
● Error logging on the action!
● Error executing the action!
WinCC: Scripting (VBS, ANSI-C, VBA)
82 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.12 Diagnostics
Pop-Up Menu
The following functions are available for every action in the pop-up menu:
● Log off: The relevant action will not be executed again when the current execution has
finished.
● Log on: The relevant action will be executed again when the next trigger event occurs
● Start: The relevant action will be executed once.
● Edit: The relevant action will be opened in the Global Script editor for editing. Runtime will
remain active. If the edited action is compiled (when necessary) and saved the changes
will be applied by the Runtime system immediately.
The option of opening the pop-up menu for every action can be controlled by assigning an
authorization.
In order to use GSC Runtime, insert a GSC Runtime type application window in a process
screen. The GSC Runtime attributes can be used to control the appearance of the GSC
Runtime window.
Note
Updating the GSC Runtime window increases the system load. The system load is dependent
on how many actions are visible in the window. The system load can be lowered by reducing
the height of the window so that fewer lines are visible.
See also
How to insert the GSC Runtime Window into a Picture (Page 83)
GSC Runtime Attributes (Page 84)
1.12.3.2 How to insert the GSC Runtime Window into a Picture
Introduction
In order to use GSC Runtime, insert a GSC Runtime process screen. The process screen can
be an existing picture or a picture which serves customized diagnostics purposes. GSC
Runtime cannot be inserted directly in the process screen but is inserted as an application in
an application window. In this case, the application window is a component part of the process
screen.
Requirements
Graphics Designer has been started and the process screen is open.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 83
VBS for Creating Procedures and Actions
1.12 Diagnostics
Procedure
1. Use the "Smart Objects" object palette to insert the "Application Window" in the picture.
2. Select the "Global Script" option from the "Window Contents" dialog and confirm the
selection with "OK".
3. Select the "GSC Runtime" option from the "Templates" dialog.
4. Confirm the selection with OK in order to insert the Diagnostics window.
See also
GSC Runtime (Page 82)
GSC Runtime Attributes (Page 84)
1.12.3.3 GSC Runtime Attributes
Overview
GSC Runtime has attributes which affect the appearance of the GSC Runtime window in
Runtime. These relate to the geometric attributes, particularly to the following:
● Display: This attribute defines whether the window should be visible or hidden. The attribute
can be made dynamic with the name Visible.
● Sizeable: This attribute defines whether the size of the window should be changeable in
Runtime.
● Movable: This attribute defines whether the window should be moveable or not during
Runtime.
● Border: This attribute defines whether the without is provided with a border. If the window
has a border, its height and width can be modified in Runtime.
● Title: This defines whether the window has a title bar.
● Can be maximized: This attribute defines whether the title bar should contain the button to
maximize the window.
● Can be closed: This attribute defines whether the title bar should contain the button to close
the window.
● Foreground: This attribute defines whether the window should always be in the foreground.
See also
GSC Runtime (Page 82)
How to insert the GSC Runtime Window into a Picture (Page 83)
WinCC: Scripting (VBS, ANSI-C, VBA)
84 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.12 Diagnostics
1.12.4 Testing with the Debugger
1.12.4.1 Testing with the Debugger
Overview
You can use the "Microsoft Visual Studio 2008" debugger to test your VB scripts in Runtime.
The debugger is included in the WinCC Setup. If another Visual Studio version is already
installed, Microsoft Visual Studio 2010 for example, use the debugger of this version.
Installing the debugger for WinCC
To use the debugger in WinCC, you must start Setup and specify instance "Visual Studio 2008"
as the default.
During the installation of WinCC, the "VS 2008 Shell Redist" folder is created on a drive of the
PC, for example, as "D:\VS 2008 Shell Redist".
Procedure
1. Start the setup with the following file:
– VS 2008 Shell Redist\Integrated Mode\Vside.enu.exe
2. Follow the instructions and accept the default settings.
The following program is installed:
– Microsoft Visual Studio 2008 Shell (Integrated Mode) - ENU
3. When you start the debugger the first time, the "Visual Studio Just-In-Time Debugger"
dialog opens.
Select the entry "New instance of Visual Studio 2008".
To specify "Visual Studio 2008" as the default debugger, select the "Set the currently
selected debugger as the default." setting.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 85
VBS for Creating Procedures and Actions
1.12 Diagnostics
Microsoft Visual Studio 2008 Debugger
See also
Principles of Debugging (Page 88)
Executing Script Commands (Page 100)
How to Determine and Modify Tag and Property Values (Page 99)
How to Set Bookmarks in Scripts (Page 98)
Deleting Breakpoints (Page 97)
Setting Breakpoints (Page 96)
Processing Scripts Step-by-Step (Page 95)
Selecting a Script for Editing (Page 94)
Action and Procedure Names in the Debugger (Page 92)
Structure of VBScript Files (Page 90)
How to Activate the Debugger (Page 87)
Diagnostics (Page 78)
WinCC: Scripting (VBS, ANSI-C, VBA)
86 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.12 Diagnostics
1.12.4.2 How to Activate the Debugger
Principle
There are several ways of activating the debugger:
● Automatic activation of the debugger when an error occurs in Runtime.
● Opening an error box in Runtime via which the debugger can be activated.
● Starting the debugger from the Start menu and opening a running Runtime scripts.
Procedure
The following procedure describes the first two points, activating the debugger in WinCC.
1. In the computer's pop-up menu in WinCC Explorer, select the command "Properties". The
"Computer Properties" dialog appears.
2. Select the "Runtime" tab control.
3. Activate the required debug options. The debug behavior for actions in Global Script and
Graphics Designer can be set independently of each other:
4. Select "Start debugger" when the debugger should be started directly following an error in
the Runtime.
5. Select "Display Error Dialog", if you do not want to start the Debugger directly but wish to
display an error dialog with information about the error. The debugger can be started from
the error box by means of a button.
6. Click OK to confirm your entries.
Starting the Debugger and Opening a Running Script
The debugger can also be started up later and linked to the system currently running. Define
a connection in the debugger to the respective processes, "pdlrt.exe" for the Graphical Runtime
System and "gscrt.exe" for the Global Runtime System. The way to open a running script in
the debugger is described under the topic "Select Script".
Exiting the Debuggers
It is possible to stop the debugger without exiting the WinCC Runtime.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 87
VBS for Creating Procedures and Actions
1.12 Diagnostics
See also
How to Set Bookmarks in Scripts (Page 98)
Executing Script Commands (Page 100)
How to Determine and Modify Tag and Property Values (Page 99)
Deleting Breakpoints (Page 97)
Setting Breakpoints (Page 96)
Processing Scripts Step-by-Step (Page 95)
Selecting a Script for Editing (Page 94)
Action and Procedure Names in the Debugger (Page 92)
Structure of VBScript Files (Page 90)
Principles of Debugging (Page 88)
Testing with the Debugger (Page 85)
Diagnostics (Page 78)
1.12.4.3 Principles of Debugging
Introduction
You can use the "Microsoft Visual Studio 2008" debugger to test your VB scripts in Runtime.
The debugger is included in the WinCC Setup. If another Visual Studio version is already
installed, Microsoft Visual Studio 2010 for example, use the debugger of this version.
The debugger can be used to:
● View the script source code to be debugged
● Step-by-step processing of the scripts to be checked
● Display and modify tag and property values
● View and monitor the script progress
Note
Please note that the code displayed in the debugger is write-protected. The code cannot
be changed directly in the debugger but only test the necessary changes.
Error types
A distinction is made between the following types of error by the debug:
Syntax errors
Syntax errors occur, for example, when a key word is written incorrectly or a parenthesis is
not closed. When a syntax check from WinCC is used, syntax errors can be excluded before
WinCC: Scripting (VBS, ANSI-C, VBA)
88 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.12 Diagnostics
testing the scripts in Runtime. In principle, only syntactically correct scripts can be saved in
Graphics Designer. The WinCC syntax check also checks:
● Whether the procedure names are unique in Global Script
● Whether an action module in Global Script contains only one procedure
● Whether the action part in Graphics Designer contains only one procedure
As a result of the syntax check in WinCC, the script is parsed without being executed. The
script is parsed again directly before executing in Runtime. All the script parts are parsed, even
those which are executed after a certain action has been executed at a later time.
If the script contains syntax errors, the script is not executed in Runtime.
Runtime error
A Runtime error occurs when an attempt is made to execute an invalid/erroneous action, e.g.
because a tag has not been defined. In order to intercept Runtime errors, use the "On Error
Resume Next" command in the VBScript. The command causes the subsequent command to
be executed following a Runtime error. The error code can subsequently be checked using
the Err object. In order to deactivate the processing of Runtime errors in the script, use the
"On Error Goto 0" command.
Logical errors
The debugger is particularly helpful in clearing up logical errors. A logical error occurs when
an unexpected result is received because, for example, a condition was incorrectly checked.
To clear logical errors, go through the scripts step-by-step in order to detect the part which
does not function properly.
Basic Procedure
When an error has occurred and the debugger is open, the script appears in a window, write-
protected. It is possible to navigate through the script document, set breakpoints, execute the
script again in Runtime and to process the script step-by-step.
The most important steps for successful debugging of the scripts are described under
"Processing Scripts Step-by-Step".
The source codes of the scripts cannot be edited directly in the scripts. When an error has
been detected, the error can be corrected in the original script in WinCC, e.g. load the picture
again and update it in the debugger.
Note
Tips and tricks for debugging, frequently occurring error codes and other information is
available in the Microsoft Script Debugger online help.
Change Picture During Debug
If a picture change is executed during debugging, the script document of the "old" picture
remains open but is no longer valid. If necessary, invalid errors are displayed because the
objects called following the picture change are no longer available.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 89
VBS for Creating Procedures and Actions
1.12 Diagnostics
See also
Testing with the Debugger (Page 85)
Executing Script Commands (Page 100)
How to Determine and Modify Tag and Property Values (Page 99)
How to Set Bookmarks in Scripts (Page 98)
Deleting Breakpoints (Page 97)
Setting Breakpoints (Page 96)
Processing Scripts Step-by-Step (Page 95)
Selecting a Script for Editing (Page 94)
Action and Procedure Names in the Debugger (Page 92)
Structure of VBScript Files (Page 90)
How to Activate the Debugger (Page 87)
Diagnostics (Page 78)
1.12.4.4 Structure of VBScript Files
Principle
In order not to hinder the simultaneous processing of cyclic and event-driven scripts in the
graphical Runtime system, the event-driven actions and cyclic/tag-driven actions are strictly
separated during processing. In this way, a cyclic action, for example, cannot hinder the
execution of an action initiated by clicking a button.
To ensure this, the event-driven actions and the cyclic/tag-driven actions are stored in separate
script files when saving a picture. If a global picture section has been defined in actions in
Graphics Designer, this is copied into both scripts. In the same way, modules which are used
in an action are also copied in both script files.
If a tag from a module should be used, the corresponding module must be called in. Otherwise,
the module is not copied in the script file and an error is generated.
Note
Since the two script files are handled separately, they have no common data area. Therefore,
there is no synchronization of global tags between the two script files. If synchronization is
required, implement this using the DataSet object or internal WinCC tags.
Structure of the Script Files
When scripts are debugged with a debugger, the script files always open the different Runtime
systems.
WinCC: Scripting (VBS, ANSI-C, VBA)
90 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.12 Diagnostics
In the case of the graphical Runtime system, this means that you receive two script files per
picture:
● <Bildname>.pdl_events: Contains the event-driven actions.
● <Bildname>.pdl_triggers: Contains the cyclic and tag-controlled actions.
The following section describes how the script files are structured:
Graphical Runtime system
Global Script Runtime
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 91
VBS for Creating Procedures and Actions
1.12 Diagnostics
Note
Please note that the actions and procedures of the graphic Runtime system are not displayed
with the action name in the script file under which it was saved in WinCC. The name
conventions for actions and procedures in the script files sate described in "Action and
Procedure Names in the Debugger".
See also
How to Activate the Debugger (Page 87)
Executing Script Commands (Page 100)
How to Determine and Modify Tag and Property Values (Page 99)
How to Set Bookmarks in Scripts (Page 98)
Deleting Breakpoints (Page 97)
Setting Breakpoints (Page 96)
Processing Scripts Step-by-Step (Page 95)
Selecting a Script for Editing (Page 94)
Action and Procedure Names in the Debugger (Page 92)
Principles of Debugging (Page 88)
Testing with the Debugger (Page 85)
Diagnostics (Page 78)
1.12.4.5 Action and Procedure Names in the Debugger
Action and Procedure Names in the Debugger
The names of procedures and actions in debugger script files differ from the names under
which they were saved by the scripts in WinCC.
The action and procedure names in the script files are compiled according to the following
rules:
Action type Name of the script file
Cyclic or tag-driven actions on a property ObjectName_PropertyName_Trigger
Mouse events ObjektName_OnClick
ObjektName_OnLButtonDown
ObjektName_OnLButtonUp
ObjektName_OnRButtonDown
ObjektName_OnRButtonUp
WinCC: Scripting (VBS, ANSI-C, VBA)
92 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.12 Diagnostics
Action type Name of the script file
Keyboard events ObjektName_OnKeyDown
ObjektName_OnKeyUp
Object events ObjektName_OnObjectChanged
ObjektName_OnSetFocus
Events on properties ObjektName_PropertyName_OnPropertyChanged
ObjektName_PropertyName_OnPropertyState‐
Changed
Picture events Document_OnOpen
Document_OnClosed
Permitted length of action names
The names of the actions in the script files are limited to 255 characters. Each special character
used in an object name is converted to five characters. The special characters are represented
by a four-place hexadecimal code behind the preceding X. If, for example, an action is
configured on a button with the name "PushHere" per mouse click, the script in the script file
appears as "PushHere_OnClick".
If the object name compiled is too long, an error message is issued during the syntax check
in WinCC. As a result of this restriction, graphic object names cannot be selected with any
length during configuration.
Note
If you wish to determine the name of an object in Runtime, press <CTRL+ALT+SHIFT> and
position the mouse over the corresponding object. The picture name and object name then
appears in a tooltip.
See also
Executing Script Commands (Page 100)
How to Determine and Modify Tag and Property Values (Page 99)
How to Set Bookmarks in Scripts (Page 98)
Deleting Breakpoints (Page 97)
Setting Breakpoints (Page 96)
Processing Scripts Step-by-Step (Page 95)
Selecting a Script for Editing (Page 94)
Structure of VBScript Files (Page 90)
Principles of Debugging (Page 88)
How to Activate the Debugger (Page 87)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 93
VBS for Creating Procedures and Actions
1.12 Diagnostics
Testing with the Debugger (Page 85)
Diagnostics (Page 78)
1.12.4.6 Selecting a Script for Editing
Introduction
If the Microsoft Script Debugger is called in Windows instead of automatic activation using
WinCC, scripts which are currently running can be called in for editing in Runtime.
Requirement
Runtime is activated, the picture to be debugged is active.
Procedure
1. Start Microsoft Visual Studio 2008.
2. Create a new script file:
– File > New > File… > Select script template "Windows Script Host".
3. Start debugging with "Debug > Attach to Process".
Select, for example, gscrt.exe or pdlrt.exe.
See also
Executing Script Commands (Page 100)
How to Determine and Modify Tag and Property Values (Page 99)
How to Set Bookmarks in Scripts (Page 98)
Deleting Breakpoints (Page 97)
Setting Breakpoints (Page 96)
Processing Scripts Step-by-Step (Page 95)
Action and Procedure Names in the Debugger (Page 92)
Structure of VBScript Files (Page 90)
Principles of Debugging (Page 88)
How to Activate the Debugger (Page 87)
Testing with the Debugger (Page 85)
Diagnostics (Page 78)
WinCC: Scripting (VBS, ANSI-C, VBA)
94 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.12 Diagnostics
1.12.4.7 Processing Scripts Step-by-Step
Introduction
The Microsoft Script Debugger can be used to process the scripts step-by-step in order, for
example, to locate logical errors systematically. The effect of each individual script line can be
tested in Runtime.
The Procedure in Principle
1. Activate the document to be debugged in Runtime.
2. Start the debugger manually from the Start menu and open the required script file or activate
the debugger in WinCC. When activated in WinCC, the debugger automatically opens when
an attempt is made to execute an erroneous script.
3. Set a breakpoint in the script file. Breakpoints are normally set in front of code lines in which
errors are suspected.
4. Switch to WinCC Runtime and trigger an action which causes the script to run.
The Debugger stops at the first breakpoint and marks the current line.
5. In order to go through the script document step-by-step, select one of the following menu
commands:
"Debug" > "Step Into": Skip to the next code line. If the script calls a procedure in this line,
it skips to the procedure using the "Step Into" command. The procedure called can then be
processed step-by-step.
"Debug" > "Step Over": Skips the procedure called. The procedure is called but the
debugger does not stop at the individual lines of the procedure. Instead, it moves to the
next line of the current script after the procedure has been executed.
6. To interrupt the step-by-step processing of a procedure, select the "Debug" > "Step Out"
menu commands. The debugger then skips to the next action.
7. Proceed step-by-step to the end of the document or select the "Debug" > "Run" menu items
to start the script again in Runtime.
See also
Principles of Debugging (Page 88)
Executing Script Commands (Page 100)
How to Determine and Modify Tag and Property Values (Page 99)
How to Set Bookmarks in Scripts (Page 98)
Deleting Breakpoints (Page 97)
Setting Breakpoints (Page 96)
Selecting a Script for Editing (Page 94)
Action and Procedure Names in the Debugger (Page 92)
Structure of VBScript Files (Page 90)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 95
VBS for Creating Procedures and Actions
1.12 Diagnostics
How to Activate the Debugger (Page 87)
Testing with the Debugger (Page 85)
Diagnostics (Page 78)
1.12.4.8 Setting Breakpoints
Introduction
Breakpoints can be set in a script to stop at specific points when processing it and to start the
debugger. Set a breakpoint in front of a line, for example, which you suspect contains a script
error.
It is possible to:
● Set breakpoints at specific lines to locate logical errors in the script step-by-step.
● Set a breakpoint and call the debugger before the next line in the script is processed. These
procedure is used, for example, for events such as "Change picture".
When a script file is updated in the debugger, all the breakpoints are lost.
If a breakpoint is set in one of the script files "<Bildname>.pdl_trigger" or
"<Bildname>.pdl_event", all the trigger-driven or all event-driven procedures are stopped,
respectively, in Runtime.
Requirements
Runtime is activated, the picture to be debugged is active.
Procedure
Setting a breakpoint
1. Start the debugger and select the script. If automatic activation of the debuggers in WinCC
has been selected, the debugger is called in as soon as an erroneous script is executed.
2. Position the cursor on the action in which a breakpoint should be set.
3. Open the "Debug" menu and select the "Toggle Breakpoint" item or the icon from the
toolbar.
The next executable line will be marked by a red dot.
4. Switch to WinCC Runtime and execute the action you wish to debug.
The Debugger stops at the first breakpoint it finds in the script. The current line is displayed
on a yellow background. The script can then be processed step-by-step.
See also
Deleting Breakpoints (Page 97)
Executing Script Commands (Page 100)
How to Determine and Modify Tag and Property Values (Page 99)
WinCC: Scripting (VBS, ANSI-C, VBA)
96 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.12 Diagnostics
How to Set Bookmarks in Scripts (Page 98)
Setting Breakpoints (Page 96)
Selecting a Script for Editing (Page 94)
Action and Procedure Names in the Debugger (Page 92)
Structure of VBScript Files (Page 90)
Principles of Debugging (Page 88)
How to Activate the Debugger (Page 87)
Testing with the Debugger (Page 85)
Diagnostics (Page 78)
1.12.4.9 Deleting Breakpoints
Introduction
When an error has been cleared properly, the breakpoints in a script can be cleared individually
or all together.
Procedure
1. Position the cursor in the line whose breakpoint is to be deleted.
2. Open the "Debug" menu and select the "Toggle Breakpoint" item or the icon from the
toolbar.
The next line will be displayed without a mark.
3. To delete all the breakpoints in a script, open the "Debug" menu and select the "Clear all
Breakpoints" entry or the icon from the toolbar.
See also
Executing Script Commands (Page 100)
How to Determine and Modify Tag and Property Values (Page 99)
How to Set Bookmarks in Scripts (Page 98)
Setting Breakpoints (Page 96)
Selecting a Script for Editing (Page 94)
Action and Procedure Names in the Debugger (Page 92)
Structure of VBScript Files (Page 90)
Principles of Debugging (Page 88)
How to Activate the Debugger (Page 87)
Testing with the Debugger (Page 85)
Diagnostics (Page 78)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 97
VBS for Creating Procedures and Actions
1.12 Diagnostics
1.12.4.10 How to Set Bookmarks in Scripts
Introduction
During the debug routine, bookmarks can be set on code lines so that they can be found easier
again one line later.
Setting or deleting bookmarks
Position the mouse pointer in the row where you wish to set a bookmark, and click <CTRL+F9>
to set a bookmark or <CTRL+SHIFT+F9> to delete one.
Skipping to the next bookmark
Press <F9> to go to the next bookmark in the script.
Skipping to the previous bookmark
Press <SHIFT+F9> to go to the previous bookmark in the script.
See also
Executing Script Commands (Page 100)
How to Determine and Modify Tag and Property Values (Page 99)
Deleting Breakpoints (Page 97)
Setting Breakpoints (Page 96)
Selecting a Script for Editing (Page 94)
Action and Procedure Names in the Debugger (Page 92)
Structure of VBScript Files (Page 90)
Principles of Debugging (Page 88)
How to Activate the Debugger (Page 87)
Testing with the Debugger (Page 85)
Diagnostics (Page 78)
WinCC: Scripting (VBS, ANSI-C, VBA)
98 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.12 Diagnostics
1.12.4.11 How to Determine and Modify Tag and Property Values
Introduction
While a script is running in Runtime, the "Command Window" of the debugger can be used,
for example, to compile and modify values of tags or properties in the script currently running.
It is possible, for example, to reset a process value for a script to zero without having to stop
the process.
Note
If you wish to determine the name of a WinCC object in Runtime, click <CTRL+ALT+SHIFT>
and position the mouse over the corresponding object. The picture name and object name
then appears in a tooltip.
Requirements
The script runs in Runtime and the debugger is opened.
Procedure
1. Set at least one breakpoint in the current script.
2. Switch to WinCC Runtime and trigger an action which causes the script to be executed.
The Debugger stops at the first breakpoint.
3. Open the "View" menu and activate the "Command Window" entry.
The "Command Window" opens.
4. In order to determine the value of a tag or property, enter a "?" followed by a Space and
the name of the tag or property whose value is to be determined, e.g. "?myTag".
Press <RETURN> to execute the command.
5. In order to modify the value of a tag/property, assign a value in the VBS syntax.
See also
Principles of Debugging (Page 88)
Executing Script Commands (Page 100)
How to Set Bookmarks in Scripts (Page 98)
Deleting Breakpoints (Page 97)
Setting Breakpoints (Page 96)
Selecting a Script for Editing (Page 94)
Action and Procedure Names in the Debugger (Page 92)
Structure of VBScript Files (Page 90)
How to Activate the Debugger (Page 87)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 99
VBS for Creating Procedures and Actions
1.12 Diagnostics
Testing with the Debugger (Page 85)
Diagnostics (Page 78)
1.12.4.12 Executing Script Commands
Introduction
While a script is running in Runtime, the "Command Window" of the debugger can be used to
execute script commands directly and thus manipulate the running of the current script. The
script commands can be executed directly for test purposes without creating the command in
a script and activating it. It is possible, for example:
● To retrieve methods
● To retrieve procedures
● To manipulate object properties
"Command Window" can basically be used to execute all commands which can also be
executed from a VBScript.
Requirements
The script runs in Runtime and the debugger is opened.
Procedure
1. Set at least one breakpoint in the current script.
2. Switch to WinCC Runtime and trigger an action which causes the script to be executed.
The Debugger stops at the first breakpoint.
3. Open the "View" menu and activate the "Command Window" entry.
The "Command Window" opens.
4. Enter the required command and press "ENTER".
Note
If a faulty command is entered in the Command window, no error message is issued in Runtime.
The message "<Script Error> appears in the Command window instead.
See also
How to Determine and Modify Tag and Property Values (Page 99)
How to Set Bookmarks in Scripts (Page 98)
Deleting Breakpoints (Page 97)
Setting Breakpoints (Page 96)
Selecting a Script for Editing (Page 94)
WinCC: Scripting (VBS, ANSI-C, VBA)
100 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.12 Diagnostics
Action and Procedure Names in the Debugger (Page 92)
Structure of VBScript Files (Page 90)
Principles of Debugging (Page 88)
How to Activate the Debugger (Page 87)
Testing with the Debugger (Page 85)
Diagnostics (Page 78)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 101
VBS for Creating Procedures and Actions
1.13 Printing VBScripts
1.13 Printing VBScripts
Principle
The actions and procedures configured in both Global Script and in Graphics Designer can be
documented in WinCC.
The documentation options are distinguished between:
● Print Feedback Doc: In Graphics Designer, all the configured actions are printed with the
feedback of the current picture. The Feed Back contains the C-actions and VBS actions,
located beside each other, differentiated by the source text (C or VBScript).
● Print current script: The Feed Back in Global Script always contains the currently open
procedure or action.
WinCC provided predefined print layouts for the layout of the Feed Back. Customized print
layouts can also be developed and linked to the Print Job tab control with "Project
Documentation - Setup".
Procedure
1. Open Global Script or Graphics Designer according to the scripts to be documented.
2. Configure the print job, if necessary, using the "Project Documentation - Setup" command.
3. Use the "View Project Documentation" command to preview the data to be printed.
4. Select the menu commands "File" > "Print Project Documentation" to print the data.
See also
Creating and Editing Actions (Page 53)
Creating and Editing Procedures (Page 37)
VBScript Editors (Page 27)
Using Visual Basic Script in WinCC (Page 12)
WinCC: Scripting (VBS, ANSI-C, VBA)
102 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14 VBS Reference
1.14.1 VBS Reference
VBS object model in WinCC
The WinCC object model of the graphic Runtime system enables access to graphic objects
and tags in Runtime.
When you click on an object name, you are shown a detailed description.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 103
VBS for Creating Procedures and Actions
1.14 VBS Reference
$FWLYH3URMHFW
7DJV 7DJ6HW
7DJ 7DJ
$FWLYH6FUHHQ
+0,5XQWLPH
6FUHHQV
6FUHHQ $FWLYH6FUHHQ,WHP
6FUHHQ,WHPV
6FUHHQ,WHP
/D\HUV
/D\HU
'DWD6HW
'DWD,WHP
/RJJLQJ 'DWDORJV
$ODUPORJV
$ODUPV 3URFHVV9DOXHV
$ODUP 3URFHVV9DOXH
Object and List
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.
WinCC: Scripting (VBS, ANSI-C, VBA)
104 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
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.
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
Object types of the ScreenItem object (Page 141)
Methods (Page 713)
Properties (Page 297)
Objects and Lists (Page 105)
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).
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 105
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
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.
WinCC: Scripting (VBS, ANSI-C, VBA)
106 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
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
● Tags
● TagSet
See also
ScreenItems Object (List) (Page 127)
TagSet Object (List) (Page 139)
Tags Object (List) (Page 137)
Tag Object (Page 135)
Screens Object (List) (Page 132)
Screen Object (Page 129)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 107
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layers Object (Listing) (Page 119)
Layer Object (Page 118)
Item Object (Page 117)
HMIRuntime Object (Page 116)
1.14.2.2 Alarm object
Description
+0,5XQWLPH
$ODUPV 3URFHVV9DOXHV
$ODUP 3URFHVV9DOXH
The alarm object is used to access the Alarms object list.
Note
The properties of the alarm object are not automatically updated when the values of the
properties change.
See also
Alarms object (list) (Page 108)
1.14.2.3 Alarms object (list)
Description
+0,5XQWLPH
$ODUPV 3URFHVV9DOXHV
$ODUP 3URFHVV9DOXH
Use the alarm object to trigger existing messages.
WinCC: Scripting (VBS, ANSI-C, VBA)
108 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
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)
● Set the status of a message (State property)
● Set 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)
● Read the name of the user who triggered the message (UserName property)
● Set the names of the process value blocks (ProcessValues property)
● Set the comment of the message (Comment property)
● Set the server prefix of the message (Context property)
Example
In the following example, the message with the alarm number "1" configured in the Alarm
Logging Editor will be triggered:
'VBS360
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 624)
ComputerName property (Page 379)
Context property (Page 379)
State property (Page 587)
AlarmID property (Page 303)
Instance property (Page 455)
Comment property (Alarm Logging) (Page 377)
UserName property (Page 679)
ProcessValue property (Page 546)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 109
VBS for Creating Procedures and Actions
1.14 VBS Reference
Alarm object (Page 108)
ProcessValues Object (List) (Page 122)
Create method (Page 719)
Item Method (Page 772)
1.14.2.4 AlarmLogs Object
Description
/RJJLQJ $ODUPORJV
'DWDORJV
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).
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
WinCC: Scripting (VBS, ANSI-C, VBA)
110 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Error Messages from Database Area (Page 822)
Restore Method (Page 796)
Remove Method (Page 790)
DataLogs Object (Page 112)
Logging Object (Page 120)
1.14.2.5 DataItem Object
Description
+0,5XQWLPH
'DWD6HW
'DWD,WHP
6FUHHQV 'DWD6HW
6FUHHQ 'DWD,WHP
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
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
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 111
VBS for Creating Procedures and Actions
1.14 VBS Reference
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 129)
HMIRuntime Object (Page 116)
DataSet Object (List) (Page 113)
Value Property (Page 683)
Name Property (Page 510)
1.14.2.6 DataLogs Object
Description
/RJJLQJ $ODUPORJV
'DWDORJV
Using the object, swapped archive segments of Tag Logging may be reconnected to Runtime,
or previously swapped archive segments of Tag 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. In
addition, you may set the archive type ("Tag Logging Fast", "Tag Logging Slow", "Tag Logging
Fast and Tag Logging Slow"). Archive segments are copied to the common archiving directory
of the project.
WinCC: Scripting (VBS, ANSI-C, VBA)
112 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
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 Tag Logging may be connected with Runtime
("Restore" method).
Previously swapped archive segments of Tag Logging may be deleted from the Runtime
project ("Remove" method).
Example:
In the following example, fast archive segments from Tag Logging are swapped and the return
value is output as Trace.
'VBS188
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.DataLogs.Restore("D:
\Folder","2004-09-14","2004-09-20",-1,1) & vbNewLine
See also
Error Messages from Database Area (Page 822)
Restore Method (Page 796)
Remove Method (Page 790)
AlarmLogs Object (Page 110)
Logging Object (Page 120)
1.14.2.7 DataSet Object (List)
Description
+0,5XQWLPH
'DWD6HW
'DWD,WHP
6FUHHQV 'DWD6HW
6FUHHQ 'DWD,WHP
Using the DataSet object, data may be exchanged across several actions.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 113
VBS for Creating Procedures and Actions
1.14 VBS Reference
A DataSet object is global and defined by the Screen object. Any VBS action may access the
data.
The DataSet object at the Screen object must be addressed according to picture hierarchy
and shall persist as long as the picture is displayed. The global object persists over the entire
Runtime time period.
Access uses the DataItem object.
Note
Objects of type Screen, Screens, ScreenItem, ScreenItems, Tag and TagSet cannot be
included in the DataSet list.
The DataSet object does not support any classes.
Usage
Using the "DataSet" list, you may:
● Output or process (enumerate) all objects in the list.
● Output the number of elements contained ("Count" property).
● To process a specific object in the list ("Item" method).
● Add an object to the list ("Add" method).
● Remove a specific object from the list ("Remove" method).
● Remove all objects from the list ("RemoveAll" method).
Access to list elements uses:
HMIRuntime.DataSet("Itemname")
For a picture-specific list, access uses:
HMIRuntime.Screens("Screenname").DataSet("Itemname")
In a picture, you may access the DataSet object of the picture by using:
DataSet("Itemname")
If upon access the stated name does not exist in the list, VT_Empty is returned and an
Exception is triggered.
WinCC: Scripting (VBS, ANSI-C, VBA)
114 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
The example shows how to add a value to the list, how to read it and remove it. It make sense
to perform this in several different actions.
'VBS162
HMIRuntime.DataSet.Add "motor1", 23
HMIRuntime.Trace "motor1: " & HMIRuntime.DataSet("motor1").Value & vbNewLine
HMIRuntime.DataSet.Remove("motor1")
See also
DataItem Object (Page 111)
RemoveAll Method (Page 794)
Remove Method (Page 790)
Item Method (Page 772)
Count property (listing) (Page 381)
Add Method (Page 716)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 115
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.2.8 HMIRuntime Object
Description
+0,5XQWLPH
$FWLYH3URMHFW
7DJV
7DJ
$FWLYH6FUHHQ
6FUHHQV
6FUHHQ
/RJJLQJ
$ODUPV
$ODUP
The HMIRuntime object represents the graphic Runtime environment.
Usage
The "HMIRuntime" object can be used for the following, for example:
● Read or set the current Runtime language ("Language" property).
● Read or set the name of the current base picture ("BaseScreenName" property).
● Read the path of the active Runtime project ("ActiveProject" property).
● Access tags ("Tags" property).
● Access tags of a list ("DataSet" property).
● Exit Runtime ("Stop" method).
● Display messages in a diagnostics window ("Trace" method).
WinCC: Scripting (VBS, ANSI-C, VBA)
116 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
The following command terminates WinCC Runtime:
'VBS3
HMIRuntime.Stop
See also
Screens Object (List) (Page 132)
TagSet Object (List) (Page 139)
Tags Object (List) (Page 137)
Logging Object (Page 120)
DataSet Object (List) (Page 113)
Visible Property (Page 699)
Trace Method (Page 813)
Tags Property (Page 597)
Stop Method (Page 812)
AlignmentLeft Property (Page 305)
Logging Property (Page 485)
Language Property (Page 459)
DataSet Property (Page 397)
CurrentContext Property (Page 393)
BaseScreenName Property (Page 338)
ActiveProject Property (Page 299)
ActiveScreen Property (Page 299)
MenuToolBarConfig Property (Page 496)
Alarms object (list) (Page 108)
1.14.2.9 Item Object
Description
The "Item" object provides a reference to the current object.
Usage
The "Item" object is used, for example, to address the properties of the object currently selected
in Graphics Designer.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 117
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
In the following example, a rectangle has been created. When the object has been selected,
all the properties of the current object can be set a background color red:
'VBS195
Item.BackColor = RGB(255,0,0)
See also
Objects and Lists (Page 105)
1.14.2.10 Layer Object
Description
6FUHHQV
6FUHHQ
/D\HUV
/D\HU
The layer object returns the result of access to the layers list.
Parent Object
Picture, in which the picture layer is.
Usage
Depending on certain events, the Layer object can be used to obtain access to the properties
of a complete layer in order, for example, to hide or unhide a layer with operating elements
according to the operator authorization.
The "Layer" object can be used to:
● To activate or deactivate the visualization of a layer ("Visible" property).
● To read out the name of a layer ("Name" property).
Note
The layer property specifies the layer in which the object is located. The layer "0" is output
as "Layer0".
When accessed, the layers are counted up from 1 in VBS. Therefore, the layer "1" must be
addressed with "layers(2)".
WinCC: Scripting (VBS, ANSI-C, VBA)
118 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
In the following example, Layer 1 is set invisible:
'VBS4
Layers(2).Visible = vbFalse
See also
Layer Object (Page 118)
Visible Property (Page 699)
Parent Property (Page 529)
Name Property (Page 510)
1.14.2.11 Layers Object (Listing)
Description
6FUHHQV
6FUHHQ
/D\HUV
/D\HU
The Layers list enables access to all 32 layers of the graphical Runtime system.
Parent Object
Picture, in which the picture layer is.
Usage
The "Layers" list can be used to:
● Process all layers in the list ("_NewEnum" property).
● Count all layers contained in the list ("Count" property).
● Process a layer from the list ("Item" method).
The properties represent default properties and methods of a list and are not described in detail
in the WinCC documentation.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 119
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Parent Property (Page 529)
Item Method (Page 772)
Count property (listing) (Page 381)
Layer Object (Page 118)
1.14.2.12 Logging Object
Description
+0,5XQWLPH
/RJJLQJ $ODUPORJV
'DWDORJV
Using the object, swapped archive segments may be reconnected to Runtime, or previously
swapped archive segments 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 and Tag Logging may be connected
with Runtime ("Restore" method).
Previously swapped archive segments of Alarm Logging and Tag Logging may be deleted
from the Runtime project ("Remove" method).
WinCC: Scripting (VBS, ANSI-C, VBA)
120 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
In the following example, archive segments from Alarm Logging and Tag Logging are swapped
and the return value is output as Trace.
'VBS189
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Restore("D:
\Folder","2004-09-14","2004-09-20",-1) & vbNewLine
See also
Error Messages from Database Area (Page 822)
DataLogs Object (Page 112)
AlarmLogs Object (Page 110)
Restore Method (Page 796)
Remove Method (Page 790)
DataLogs Property (Page 397)
AlarmLogs Property (Page 304)
1.14.2.13 ProcessValue Object
Description
$ODUPV 3URFHVV9DOXHV
$ODUP 3URFHVV9DOXH
The ProcessValue object is used to access the ProcessValues object list.
Note
Only the 10 predefined ProcessValues are supported.
See also
ProcessValues Object (List) (Page 122)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 121
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.2.14 ProcessValues Object (List)
Description
$ODUPV 3URFHVV9DOXHV
$ODUP 3URFHVV9DOXH
Usage
Using the "ProcessValues" list, you can:
● Edit a ProcessValue from the list ("Item" method)
● Display or edit all the objects in the list (_NewEnum attribute)
● Count all ProcessValues contained in the list (Count property)
● Read or set the values of the ProcessValue object (Value property)
The properties represent default properties and methods of a list and are not described in detail
in the WinCC documentation.
See also
Alarms object (list) (Page 108)
ProcessValue Object (Page 121)
Count property (listing) (Page 381)
Value Property (Page 683)
Item Method (Page 772)
1.14.2.15 Project Object
Description
+0,5XQWLPH
$FWLYH3URMHFW
Using the object, information may be requested from the current Runtime project.
The project object is returned as the result of ActiveProject.
WinCC: Scripting (VBS, ANSI-C, VBA)
122 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Usage
Using the "Project" object, you may:
● Read the path of the current Runtime project ("Path" property).
● Read the name of the current Runtime project, without path or file extension ("Name"
property).
Example:
The following example returns name and path of the current Runtime project as Trace:
'VBS159
HMIRuntime.Trace "Name: " & HMIRuntime.ActiveProject.Name & vbNewLine
HMIRuntime.Trace "Path: " & HMIRuntime.ActiveProject.Path & vbNewLine
See also
ActiveProject Property (Page 299)
Name Property (Page 510)
Path Property (Page 531)
1.14.2.16 ScreenItem Object
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
The ScreenItem object returns the result of access to the ScreenItem list.
Parent Object
Picture containing the picture element.
Usage
The ScreenItem object can be used to access the properties of graphic objects within a picture
according to certain events.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 123
VBS for Creating Procedures and Actions
1.14 VBS Reference
The "ScreenItem" object can be used for the following, for example:
● To activate or deactivate the visualization of an object ("Visible" property).
● To release or block the operation of an object ("Enabled" property).
● Change the width and height of an object ("Height" and "Width" properties).
● Change the position of an object ("Top" and "Left" properties).
● Read and define a layer in which a graphic object is located ("Layer" property).
● Read or define the name of a graphic object ("ObjectName" property).
● Define a reference to the superordinate picture ("Parent" property).
Using the "Activate" method, the focus is set on the respective ScreenItem object. If the focus
cannot be set because the object is non-operable, for example, an error is generated. Using
error processing (On Error Resume Next), the error may be evaluated.
Possible features of ScreenItem
The "ScreenItem" object can contain the following object types:
Standard ob‐ Smart objects Windows ob‐ Tube objects Controls Others
jects jects
Ellipse 3D bar Button Double T- Siemens HMI Customized Ob‐
piece Symbol Library ject
Ellipse arc Application Check box Polygon WinCC AlarmCon‐ Group
window tube trol
Ellipse seg‐ Bar Radio box Tube bend WinCC digital/ana‐
ment log clock control
Circle Picture win‐ Round button T-piece WinCC Function‐
dow TrendControl
Circular arc Control Slider WinCC gauge con‐
trol
Pie segment I/O field WinCC Online‐
TrendControl
Line Faceplate In‐ WinCC OnlineTa‐
stance bleControl
Polygon Graphic ob‐ WinCC RulerCon‐
ject trol
Polyline Combo box WinCC Slider Con‐
trol
Rectangle List box WinCC UserArchi‐
veControl
Rounded rec‐ Multiple row
tangle text
Connector OLE object
Group display
Text list
Status display
WinCC: Scripting (VBS, ANSI-C, VBA)
124 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Detailed descriptions of the individual object types is provided under "ScreenItem Object
Types". The ScreenItem object's "Type" property can be used to address the object types via
the VBS Type ID.
Object properties
The "ScreenItem" object has different properties according to the features. The following
section describes the properties which all ScreenItem object types have:
When a specific object type is addressed, certain further properties are added to the standard
properties:
The additional properties are indicated in the descriptions of the individual object types.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 125
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
In the following example, the radius of a circle is set to 2 in Runtime per mouse click:
Sub OnClick(ByVal Item)
'VBS5
Dim objCircle
Set objCircle= ScreenItems("Circle1")
objCircle.Radius = 2
End Sub
See also
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
Parent Property (Page 529)
Left Property (Page 477)
Layer Property (Page 461)
Height Property (Page 444)
Enabled Property (Page 407)
Activate Method (Page 714)
Example: How to Read Tag Values (Page 832)
Example: Writing tag values (Page 830)
Properties (Page 297)
Objects and Lists (Page 105)
Object types of the ScreenItem object (Page 141)
Object types of the ScreenItem object (Page 141)
WinCC: Scripting (VBS, ANSI-C, VBA)
126 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.2.17 ScreenItems Object (List)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
The "ScreenItems" list can be used to reference an object in the picture.
Parent Object
Picture containing the picture element.
Usage
The "ScreenItems" list can be used to:
● To display or edit all objects in the list (i.e. all objects within a picture) ("_NewEnum"
property).
● To count the objects in a picture ("Count" property).
● To process a specific object in the list ("Item" method).
The properties are standard properties and methods of a collection and are not described in
detail in the WinCC documentation.
Special features of the ScreenItem object
If an external control (ActiveX control or OLE object) is embedded in WinCC, it is possible that
the properties of the embedded controls have the same name with the general properties of
the ScreenItem object. In such cases, the ScreenItem properties have priority.
The properties of the embedded controls can also be addressed via the "object" property:
The "object" property is only provided by ActiveX controls and OLE objects.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 127
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
'Control1 is an embedded ActiveX-Control with property "type"
'VBS196
Dim Control
Set Control=ScreenItems("Control1")
Control.object.type
'Control1 is a WinCC-Control
'VBS197
Dim Control
Set Control=ScreenItems("Control1")
Control.type
Example
In the following example, the name of the objects in the current picture are displayed in a
message box:
Sub OnClick(ByVal Item)
'VBS6
Dim lngAnswer
Dim lngIndex
lngIndex = 1
For lngIndex = 1 To ScreenItems.Count
lngAnswer = MsgBox(ScreenItems(lngIndex).Objectname, vbOKCancel)
If vbCancel = lngAnswer Then Exit For
Next
End Sub
See also
Count property (listing) (Page 381)
Example: How to Read Tag Values (Page 832)
Example: Writing tag values (Page 830)
ScreenItem Object (Page 123)
Parent Property (Page 529)
Item Method (Page 772)
Object types of the ScreenItem object (Page 141)
WinCC: Scripting (VBS, ANSI-C, VBA)
128 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.2.18 Screen Object
Description
+0,5XQWLPH
6FUHHQV
6FUHHQ $FWLYH6FUHHQ,WHP
6FUHHQ,WHPV
6FUHHQ,WHP
/D\HUV
/D\HU
'DWD6HW
'DWD,WHP
The Screen object returns the result of access to the Screen list. All the properties and methods
of this object can also be edited directly in Runtime. The "Screen" object represents a WinCC
picture in Runtime and contains all the properties of the picture document and picture view.
The "Screen" object also contains the following:
● A list of all the graphic objects contained in the addressed picture which can be addressed
by the "ScreenItems" object.
● A list of all the layers contained in the addressed picture which can be addressed by the
"Layers" object.
Parent Object
A picture window in which the Screen object is embedded.
When the Screen object is the basic picture, the Parent object is not defined and set to zero.
Usage
The "Screen" object can be used for the following, for example:
● To release or block the operation of a screen ("Enabled" property).
● Change the width and height of a screen ("Height" and "Width" properties).
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 129
VBS for Creating Procedures and Actions
1.14 VBS Reference
● Zoom a picture ("Zoom" property).
● Modify the fill pattern, background color and fill pattern color ("Fillstyle", "Backcolor" and
"Fillcolor" properties).
Note
If a Change Picture is executed, all the open references are invalid for pictures no longer
open. It is then no longer possible to work with these references.
Example:
In the following example, the width of the first picture in Runtime is increased by 20 pixels:
'VBS7
Dim objScreen
Set objScreen = HMIRuntime.Screens(1)
MsgBox "Screen width before changing: " & objScreen.Width
objScreen.Width = objScreen.Width + 20
MsgBox "Screen width after changing: " & objScreen.Width
Notes on Cross References
All the pictures which are addressed with the standard formulation
HMIRuntime.BaseScreenName = "Screenname"
are automatically compiled by the CrossReference of WinCC and then listed in the picture
properties.
If pictures are addressed with different formulations in the code, this can be notified by the
following section of the CrossReference:
' ' WINCC:SCREENNAME_SECTION_START
Const ScreenNameInAction = "ScreenName"
' WINCC:SCREENNAME_SECTION_END
The section can be inserted in VBS actions as often as required.
Note
Always enter picture names without the extension "PDL" for reasons of compatibility with future
versions.
See also
ScreenItems Property (Page 561)
Refresh Method (Page 790)
Activate Method (Page 714)
WinCC: Scripting (VBS, ANSI-C, VBA)
130 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Zoom Property (Page 712)
Width Property (Page 701)
Parent Property (Page 529)
ObjectSizeDeclutteringMin Property (Page 515)
ObjectSizeDeclutteringMax Property (Page 514)
ObjectSizeDeclutteringEnable Property (Page 514)
ObjectName Property (Page 513)
Layers Property (Page 477)
DataSet Property (Page 397)
LayerDeclutteringEnable Property (Page 476)
Height Property (Page 444)
FillStyle Property (Page 420)
FillColor Property (Page 418)
ExtendedZoomingEnable Property (Page 416)
Enabled Property (Page 407)
BackColor Property (Page 318)
ActiveScreenItem Property (Page 300)
AccessPath Property (Page 297)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 131
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.2.19 Screens Object (List)
Description
+0,5XQWLPH
6FUHHQV
6FUHHQ $FWLYH6FUHHQ,WHP
6FUHHQ,WHPV
6FUHHQ,WHP
/D\HUV
/D\HU
'DWD6HW
'DWD,WHP
By using the picture window technique, several windows can be opened simultaneously in
WinCC Runtime but only one basic picture exists. The "Screens" list enables access to all
open pictures in Runtime using the picture names. The Screens list contains all invisible
pictures.
Usage
When configuring a multi-user project, it is essential to specify the server prefix to access a
picture which is not on the local computer.
The "Screens" list can be used to:
● Display or edit all the pictures within the list ("_NewEnum" property).
● To count the pictures in a project ("Count" property).
● To process a specific picture in the list ("Item" method).
● Initiate new drawing of all visible pictures ("Refresh" method).
The properties are standard properties and methods of a collection and are not described in
detail in the WinCC documentation.
The access code, required in the VBS environment in the
HMIRuntime.Screens(<Zugriffsschlüssel>) instruction, must fulfill the syntax requirements:
[<Grundbildname>.]<Bildfenstername>[:<Bildname>] ...
.<Bildfenstername>[:<Bildname>]
WinCC: Scripting (VBS, ANSI-C, VBA)
132 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
This means:
● The access code expresses the picture hierarchy.
● The picture names in the code can be omitted at any point.
● The "AccessPath" property of the "Screen" object corresponds to the full access code.
● Always enter picture names without the extension "PDL" for reasons of compatibility with
future versions.
● The basic picture can be addressed by the access code ".
In addition, it has been defined that the basic picture can be addressed with Index 1.
Examples
The pictures are addressed by the hierarchy information in the list. There are two options here,
with or without use of the picture name. In the following examples, a basic picture
"BaseScreenName" is configured with a picture window "ScreenWindow". The picture window
contains the picture "ScreenName".
Addressing with the picture name
'VBS8
Set objScreen = HMIRuntime.Screens("BaseScreenName.ScreenWindow:ScreenName")
Addressing without the picture name
'VBS9
Set objScreen = HMIRuntime.Screens("ScreenWindow")
Referencing the basic picture in various ways
'VBS10
Set objScreen = HMIRuntime.Screens(1)
'VBS11
Set objScreen = HMIRuntime.Screens("")
'VBS12
Set objScreen = HMIRuntime.Screens("BaseScreenName")
See also
ScreenItem Object (Page 123)
Refresh Method (Page 790)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 133
VBS for Creating Procedures and Actions
1.14 VBS Reference
Item Method (Page 772)
Count property (listing) (Page 381)
1.14.2.20 SmartTags Object
Description
The "HMIRuntime" component was deactivated in the faceplate type. The new "SmartTags"
component was added for the faceplate type. With the SmartTags object you can dynamize
the faceplate type. You can only access the faceplate variables and the properties of the
faceplate type. You cannot access the normal WinCC tag management system. The normal
WinCC tag management system is not available in the faceplate type.
Usage
Using the "SmartTags" object, you can:
● Access the faceplate tags in a faceplate type.
Syntax: SmartTags("<tagname>")
● Access the properties of a faceplate type.
Syntax: SmartTags("Properties\<propertyname>")
Example 1
Insert a rectangle and a button in a faceplate type. Define a faceplate variable var1. Connect
the "Width" property of the rectangle to faceplate variable var1. Dynamize the "OnClick" event
of the button as follows with VBS.
'VBS306
Dim w
w = SmartTags("var1")
w = w + 10
SmartTags("var1") = w
When you activate Runtime, the faceplate variable is incremented by 10 every time you click
the button. This increases the rectangle width by 10.
Direct reading and writing with object reference
In the following example, the SmartTags object is used to create an object reference "w" to
"var1".
Referencing offers the advantage of being able to access the "var1" tag.
'VBS307
Dim w
Set w = SmartTags("var1")
w.value = w.value + 10
WinCC: Scripting (VBS, ANSI-C, VBA)
134 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example 2:
Insert a rectangle and a button in a faceplate type. Define the instance-specific property "wide".
Link the "Width" property of the rectangle to the instance-specific property "wide". Dynamize
the "OnClick" event of the button as follows with VBS:
'VBS308
Dim w
w = SmartTags("Properties\wide")
SmartTags("Properties\wide") = w + 50
When you activate Runtime, the instance-specific property "wide" is increased by 50 every
time you click the button. This increases the rectangle width by 50.
See also
SmartTag property (Page 581)
1.14.2.21 Tag Object
Description
+0,5XQWLPH
7DJV 7DJ6HW
7DJ 7DJ
A tag object is returned via the "Tags" list. A tag object can be used to address all the properties
and methods of a tag.
When creating a tag object, all the properties are installed with the following values:
● Value = VT_EMPTY
● Name = Tag name
● QualityCode = BAD NON-SPECIFIC
● TimeStamp = 0
● LastError = 0
● ErrorDescription = " "
Note
A summary of possible Quality Codes may be found in WinCC Information System under
key word "Communication" > "Diagnostics" or "Communication" > "Quality Codes".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 135
VBS for Creating Procedures and Actions
1.14 VBS Reference
Use
The "Tag" object can be used to:
● Read information for the tag ("Name", "QualityCode", "TimeStamp", "LastError" and
"ErrorDescription" properties)
● Set a value for a tag ("Write" method, "Value" property)
● Read a value for a tag ("Read" method, "Value" property)
Read the value of a "Tag1" tag:
'VBS13
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read()
MsgBox objTag.Value
Declaration of tags in WinCC
Always define internal tags in VB script using the "Dim" instruction in order to prevent writing
tags wrongly.
When creating a new action, the "Option explicit" instruction is automatically entered in the
declaration area and cannot be deleted.
Do not use the "Option explicit" instruction in the code because it may cause Runtime errors.
Example: Declaration of a VBScript "lngVar" tag:
'VBS14
Dim lngVar
lngVar = 5
MsgBox lngVar
Note
Tag names must not contain any special characters.
Please note that when creating a tag, it must not contain a value (Value = VT_EMPTY). Initialize
the tags after declaration with the corresponding value.
Notes on Cross-Reference
All the pictures which are addressed with the standard formulation
HMIRuntime.Tags("tag name")
are automatically compiled by the Cross-Reference of WinCC and then listed in the picture
properties.
WinCC: Scripting (VBS, ANSI-C, VBA)
136 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
If tags are addressed with different formulations in the code, this can be notified by the following
section of the Cross-Reference:
' WINCC:TAGNAME_SECTION_START
Const TagNameInAction = "TagName"
' WINCC:TAGNAME_SECTION_END
The section can be inserted in VBS actions as often as required.
Note
It is not possible to guarantee the compilation of combined tag names from the Cross-
Reference.
See also
Name Property (Page 510)
Example: How to Read Tag Values (Page 832)
Example: Writing tag values (Page 830)
Write Method (Page 815)
Read Method (Page 785)
Value Property (Page 683)
TimeStamp Property (Page 624)
QualityCode Property (Page 547)
LastError Property (Page 459)
ErrorDescription Property (Page 411)
Comment property (Tag Logging) (Page 377)
1.14.2.22 Tags Object (List)
Description
+0,5XQWLPH
7DJV 7DJ6HW
7DJ 7DJ
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 137
VBS for Creating Procedures and Actions
1.14 VBS Reference
The "Tags" list enables access to tags in WinCC Runtime. The result of access to the "Tags"
list is returned by an object of the type "Tag". The Tag object can be used to access all the tag
properties and methods.
Note
"Tags" is a list with a restricted functional scope. The tags in the list cannot be accessed via
the index but only by using the tag names. The standard methods get_Count and
get_NewEnum cannot be used in the Tags list.
Usage
Tags in the list are accessed via:
HMIRuntime.Tags("Tagname")
The Tags list is used to declare tags (tag objects) for read and write access. To ensure that
read and write access is carried out without errors, the corresponding tags must be available
in WinCC tag management.
In VBS you can address tags directly via the name and set and read values. If you want to
access additional tag properties, request the quality code, for example, you will always have
to address tags via the tag listing. The tag object returned enables access to all tag properties
and methods. You have to form an instance for the object, to write a binary tag with
HMIRuntime.Tags("Variable").Value=TRUE, for example.
The "CreateTagSet" method can be used to generate a "TagSet" object that enables
simultaneous access to several tags.
Example:
There are two options when creating tags:
● With specification of the server prefix: For tags in multi-user systems which are not stored
locally.
● Direct use of the tag name: For tags stored locally on the computer.
Specification of the server prefix
'VBS15
Dim objTag
Set objTag = HMIRuntime.Tags("Serverprefix::Tagname")
If the server prefix is entered directly, the "ServerPrefix" property is assigned the
corresponding value.
WinCC: Scripting (VBS, ANSI-C, VBA)
138 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Specification of the tag name
'VBS16
Dim objTag
Set objTag = HMIRuntime.Tags("Tagname")
If just the tag name is used, the "ServerPrefix" and "TagPrefix" properties are assigned
the values from the current context (current picture window).
See also
Example: How to Read Tag Values (Page 832)
Example: Writing tag values (Page 830)
Item Method (Page 772)
CreateTagSet Method (Page 719)
Tag Object (Page 135)
1.14.2.23 TagSet Object (List)
Description
The object "TagSet" enables simultaneous access to several tags in one call. This features
better performance and lower communication load that single access to various tags.
Usage
Using the TagSet object, you may:
● Add tags to the list ("Add" method)
● Access tag objects contained in the list, and their properties ("Item" method)
● Write all tags of the list ("Write" method)
● Read all tags of the list ("Read" method)
● Remove single tags from the list ("Remove" method)
● Remove all tags from the list ("RemoveAll" method)
Tags in the list are accessed via:
'VBS169
Dim myTags
myTags = HMIRuntime.Tags.CreateTagSet
myTags("Tagname")
In order to have error-free read/write access to tags (tag objects) of the list, the respective tags
must exist in WinCC tag management.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 139
VBS for Creating Procedures and Actions
1.14 VBS Reference
If an error occurred during read/write access, the method used will return an error message
using the "LastError" and "ErrorDescription" properties.
Synchronous writing and reading of the tags is possible. The optional "Writemode" parameter
can be used to write process tags directly to the AS with "1", for example, "group.Write 1". Use
the optional "Readmode" parameter to read process tags with "1" directly from the AS or
channel, for example, "group.Read 1".
Example:
The following example shows how to generate a TagSet object, how to add tags, and how to
write values.
'VBS168
Build a Reference to the TagSet Object
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
'Add Tags to the Collection
group.Add "Motor1"
group.Add "Motor2"
'Set the Values of the Tags
group("Motor1").Value = 3
group("Motor2").Value = 9
'Write the Values to the DataManager
group.Write
See also
LastError Property (Page 459)
Example: How to Read Tag Values (Page 832)
Example: Writing tag values (Page 830)
Write Method (Page 815)
RemoveAll Method (Page 794)
Remove Method (Page 790)
Read Method (Page 785)
Item Method (Page 772)
ErrorDescription Property (Page 411)
Count property (listing) (Page 381)
Add Method (Page 716)
Tags Object (List) (Page 137)
Tag Object (Page 135)
WinCC: Scripting (VBS, ANSI-C, VBA)
140 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.3 Object types of the ScreenItem object
1.14.3.1 Object types of the ScreenItem object
Introduction
The following section lists all the available types of the "ScreenItem" object.
The features of the "ScreenItem" object represent all the graphic objects available in WinCC
Graphics Designer.
The object types are divided into the following groups according to their arrangement in
Graphics Designer:
● Standard objects
● Smart objects
● Windows objects
● Tube objects
● Controls
There are also the object types
● Customized Object
● Group
See also
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Group (Page 296)
Customized Object (Page 294)
Controls (Page 216)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 141
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.3.2 Standard objects
Ellipse
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Ellipse"
Type Identifier in VBS
HMIEllipse
Usage
In the following example, the object with the name "Ellipse1" is moved 10 pixels to the right:
'VBS17
Dim objEllipse
Set objEllipse = ScreenItems("Ellipse1")
objEllipse.Left = objEllipse.Left + 10
See also
FillStyle Property (Page 420)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
WinCC: Scripting (VBS, ANSI-C, VBA)
142 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
RadiusWidth Property (Page 548)
RadiusHeight Property (Page 548)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
BackColor Property (Page 318)
Layer Property (Page 461)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 143
VBS for Creating Procedures and Actions
1.14 VBS Reference
Ellipse arc
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Ellipse Arc"
Type Identifier in VBS
HMIEllipticalArc
Usage
In the following example, the object with the name "EllipseArc1" is moved 10 pixels to the right:
'VBS18
Dim objEllipseArc
Set objEllipseArc = ScreenItems("EllipseArc1")
objEllipseArc.Left = objEllipseArc.Left + 10
See also
RadiusHeight Property (Page 548)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
StartAngle Property (Page 587)
RadiusWidth Property (Page 548)
WinCC: Scripting (VBS, ANSI-C, VBA)
144 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
FlashRateBorderColor Property (Page 427)
FlashBorderColor Property (Page 424)
EndAngle Property (Page 410)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
Layer Property (Page 461)
Ellipse segment
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Ellipse Segment"
Type Identifier in VBS
HMIEllipseSegment
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 145
VBS for Creating Procedures and Actions
1.14 VBS Reference
Usage
In the following example, the object with the name "EllipseSegment1" is moved 10 pixels to
the right:
'VBS19
Dim objEllipseSeg
Set objEllipseSeg = ScreenItems("EllipseSegment1")
objEllipseSeg.Left = objEllipseSeg.Left + 10
See also
Layer Object (Page 118)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
StartAngle Property (Page 587)
RadiusWidth Property (Page 548)
RadiusHeight Property (Page 548)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Height Property (Page 444)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
WinCC: Scripting (VBS, ANSI-C, VBA)
146 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
EndAngle Property (Page 410)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
BackColor Property (Page 318)
Layer Property (Page 461)
Circle
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Circle".
Type Identifier in VBS
HMICircle
Usage
In the following example, the object with the name "Circle1" is moved 10 pixels to the right:
'VBS20
Dim objCircle
Set objCircle= ScreenItems("Circle1")
objCircle.Left = objCircle.Left + 10
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 147
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Properties (Page 297)
BorderStyle Property (Page 352)
Activate Method (Page 714)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
Radius Property (Page 548)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
WinCC: Scripting (VBS, ANSI-C, VBA)
148 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BackColor Property (Page 318)
Layer Property (Page 461)
Circular arc
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Circular Arc"
Type Identifier in VBS
HMICircularArc
Usage
In the following example, the object with the name "CircularArc1" is moved 10 pixels to the
right:
'VBS21
Dim objCircularArc
Set objCircularArc = ScreenItems("CircularArc1")
objCircularArc.Left = objCircularArc.Left + 10
See also
StartAngle Property (Page 587)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 149
VBS for Creating Procedures and Actions
1.14 VBS Reference
ToolTipText Property (Page 643)
Radius Property (Page 548)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
FlashRateBorderColor Property (Page 427)
FlashBorderColor Property (Page 424)
EndAngle Property (Page 410)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
Layer Property (Page 461)
Pie segment
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Pie Segment"
Type Identifier in VBS
HMICircleSegment
WinCC: Scripting (VBS, ANSI-C, VBA)
150 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Usage
In the following example, the object with the name "PieSegment1" is moved 10 pixels to the
right:
'VBS22
Dim objCircleSeg
Set objCircleSeg = ScreenItems("PieSegment1")
objCircleSeg.Left = objCircleSeg.Left + 10
See also
Type Property (Page 669)
BorderColor Property (Page 351)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Top Property (Page 644)
ToolTipText Property (Page 643)
StartAngle Property (Page 587)
Radius Property (Page 548)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 151
VBS for Creating Procedures and Actions
1.14 VBS Reference
EndAngle Property (Page 410)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
BackColor Property (Page 318)
Layer Property (Page 461)
Line
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Line"
Type Identifier in VBS
HMILine
Usage
In the following example, the object with the name "Line1" is moved 10 pixels to the right:
'VBS23
Dim objLine
Set objLine = ScreenItems("Line1")
objLine.Left = objLine.Left + 10
WinCC: Scripting (VBS, ANSI-C, VBA)
152 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
PasswordLevel Property (Page 531)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
RotationAngle Property (Page 553)
ReferenceRotationTop Property (Page 550)
ReferenceRotationLeft Property (Page 550)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
FlashRateBorderColor Property (Page 427)
FlashBorderColor Property (Page 424)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderEndStyle Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
Layer Property (Page 461)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 153
VBS for Creating Procedures and Actions
1.14 VBS Reference
Polygon
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Polygon"
Type Identifier in VBS
HMIPolygon
Usage
In the following example, the object with the name "Polygon1" is moved 10 pixels to the right:
'VBS24
Dim objPolygon
Set objPolygon = ScreenItems("Polygon1")
objPolygon.Left = objPolygon.Left + 10
See also
ReferenceRotationTop Property (Page 550)
BackFlashColorOn Property (Page 320)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
RotationAngle Property (Page 553)
WinCC: Scripting (VBS, ANSI-C, VBA)
154 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ReferenceRotationLeft Property (Page 550)
PointCount Property (Page 542)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Index Property (Page 452)
Height Property (Page 444)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOff Property (Page 320)
BackColor Property (Page 318)
ActualPointTop Property (Page 301)
ActualPointLeft Property (Page 301)
Layer Property (Page 461)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 155
VBS for Creating Procedures and Actions
1.14 VBS Reference
Polyline
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Polyline"
Type Identifier in VBS
HMIPolyLine
Usage
In the following example, the object with the name "Polyline1" is moved 10 pixels to the right:
'VBS25
Dim objPolyline
Set objPolyline = ScreenItems("Polyline1")
objPolyline.Left = objPolyline.Left + 10
See also
Layer Object (Page 118)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
RotationAngle Property (Page 553)
ReferenceRotationTop Property (Page 550)
WinCC: Scripting (VBS, ANSI-C, VBA)
156 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ReferenceRotationLeft Property (Page 550)
PointCount Property (Page 542)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Index Property (Page 452)
Height Property (Page 444)
FlashRateBorderColor Property (Page 427)
FlashBorderColor Property (Page 424)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderEndStyle Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
ActualPointTop Property (Page 301)
ActualPointLeft Property (Page 301)
Layer Property (Page 461)
Rectangle
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Rectangle"
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 157
VBS for Creating Procedures and Actions
1.14 VBS Reference
Type Identifier in VBS
HMIRectangle
Usage
In the following example, the object with the name "Rectangle1" is moved 10 pixels to the right:
'VBS26
Dim objRectangle
Set objRectangle = ScreenItems("Rectangle1")
objRectangle.Left = objRectangle.Left + 10
Notes on Error Handling
The rectangle and rounded rectangle are mapped to an "HMIRectangle" type in the object
model. Since the two objects have different properties, the availability of the property (dynamic
type compilation in Runtime) should be queried via an exception measure. The exception
measure is activated for the corresponding procedure by the following instruction:
On Error Resume Next
The instruction causes the VBScript engine to initiate the follow-on command in the case of a
Runtime error.
The error code can subsequently be checked using the Err object. In order to deactivate the
handling of Runtime errors in scripts, use the following command:
On Error Goto 0
Handling errors always relates to the procedure layer. If a script in a procedure causes an
error, VBScript checks whether an error handling measure is implemented in this layer. If not,
control is transferred one layer up (to the calling procedure). If there is no error handling
measure here either, the control is transferred yet another layer up. This continues until either
the top module level is reached or the code for Runtime error handling is located. If the
activation of the Runtime error handling fails, the control is transferred to the top level on the
internal VBScript Runtime error handing. This opens an error dialog and stops the script.
The "On Error Resume Next" command can be installed on all layers (i.e. also in procedures).
When the error handling measure is use, it can basically be determined whether the user is
actually using the required implementation type.
In addition, it can be ensured that there is no termination of execution due to a faulty access
to the object.
WinCC: Scripting (VBS, ANSI-C, VBA)
158 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Examples of error handling
Sub OnClick(ByVal Item)
'VBS27
Dim objScreenItem
'
'Activation of errorhandling:
On Error Resume Next
For Each objScreenItem In ScreenItems
If "HMIRectangle" = objScreenItem.Type Then
'
'=== Property "RoundCornerHeight" only available for RoundRectangle
objScreenItem.RoundCornerHeight = objScreenItem.RoundCornerHeight * 2
If 0 <> Err.Number Then
HMIRuntime.Trace objScreenItem.Name & ": no RoundedRectangle" & vbCrLf
'
'Delete error message
Err.Clear
End If
End If
Next
On Error Goto 0 'Deactivation of errorhandling
End Sub
See also
Properties (Page 297)
BorderFlashColorOn Property (Page 352)
Activate Method (Page 714)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 159
VBS for Creating Procedures and Actions
1.14 VBS Reference
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
BackColor Property (Page 318)
Layer Property (Page 461)
Rounded rectangle
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Rounded Rectangle".
Type Identifier in VBS
HMIRoundRectangle
WinCC: Scripting (VBS, ANSI-C, VBA)
160 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Usage
In the following example, the object with the name "RoundedRectangle1" is moved 10 pixels
to the right:
'VBS28
Dim objRoundedRectangle
Set objRoundedRectangle = ScreenItems("RoundedRectangle1")
objRoundedRectangle.Left = objRoundedRectangle.Left + 10
Notes on Error Handling
The rectangle and rounded rectangle are mapped to an "HMIRectangle" type in the object
model. Since the two objects have different properties, the availability of the property (dynamic
type compilation in Runtime) should be queried via an exception measure. The exception
measure is activated for the corresponding procedure by the following instruction:
On Error Resume Next
The instruction causes the VBScript engine to initiate the follow-on command in the case of a
Runtime error.
The error code can subsequently be checked using the Err object. In order to deactivate the
handling of Runtime errors in scripts, use the following command:
On Error Goto 0
Handling errors always relates to the procedure layer. If a script in a procedure causes an
error, VBScript checks whether an error handling measure is implemented in this layer. If not,
control is transferred one layer up (to the calling procedure). If there is no error handling
measure here either, the control is transferred yet another layer up. This continues until either
the top module level is reached or the code for Runtime error handling is located. If the
activation of the Runtime error handling fails, the control is transferred to the top level on the
internal VBScript Runtime error handing. This opens an error dialog and stops the script.
The "On Error Resume Next" command can be installed on all layers (i.e. also in procedures).
When the error handling measure is use, it can basically be determined whether the user is
actually using the required implementation type.
In addition, it can be ensured that there is no termination of execution due to a faulty access
to the object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 161
VBS for Creating Procedures and Actions
1.14 VBS Reference
Examples of error handling
Sub OnClick(ByVal Item)
'VBS29
Dim objScreenItem
On Error Resume Next 'Activation of errorhandling
For Each objScreenItem In ScreenItems
If "HMIRectangle" = objScreenItem.Type Then
'
'=== Property "RoundCornerHeight" available only for RoundRectangle
objScreenItem.RoundCornerHeight = objScreenItem.RoundCornerHeight * 2
If 0 <> Err.Number Then
HMIRuntime.Trace objScreenItem.ObjectName & ": no RoundedRectangle" & vbCrLf
Err.Clear 'Delete errormessage
End If
End If
Next
On Error Goto 0 'Deactivation of errorhandling
End Sub
See also
FlashBackColor Property (Page 423)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
RoundCornerWidth Property (Page 554)
RoundCornerHeight Property (Page 553)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
WinCC: Scripting (VBS, ANSI-C, VBA)
162 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
FlashBorderColor Property (Page 424)
FillStyle Property (Page 420)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
BackColor Property (Page 318)
Layer Property (Page 461)
Static text
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Static Text"
Type Identifier in VBS
HMITextField
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 163
VBS for Creating Procedures and Actions
1.14 VBS Reference
Usage
In the following example, the object with the name "StaticText1" is moved 10 pixels to the right:
'VBS30
Dim objStaticText
Set objStaticText = ScreenItems("StaticText1")
objStaticText.Left = objStaticText.Left + 10
See also
ObjectName Property (Page 513)
BorderFlashColorOn Property (Page 352)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
Text list (Page 194)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
Orientation Property (Page 527)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
ForeFlashColorOn Property (Page 436)
ForeFlashColorOff Property (Page 435)
ForeColor Property (Page 435)
FontUnderline Property (Page 434)
FontSize Property (Page 433)
FontName Property (Page 433)
FontItalic Property (Page 432)
FontBold Property (Page 432)
FlashRateForeColor Property (Page 428)
WinCC: Scripting (VBS, ANSI-C, VBA)
164 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashForeColor Property (Page 424)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
BackColor Property (Page 318)
AlignmentTop Property (Page 305)
AlignmentLeft Property (Page 305)
AdaptBorder Property (Page 302)
Layer Property (Page 461)
Connector
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Connector"
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 165
VBS for Creating Procedures and Actions
1.14 VBS Reference
Type Identifier in VBS
HMIConnector
Usage
In the following example, the object with the name "Connector1" is moved 10 pixels to the right:
'VBS31
Dim objConnector
Set objConnector = ScreenItems("Connector1")
objConnector.Left = objConnector.Left + 10
See also
ScreenItems Object (List) (Page 127)
Activate Method (Page 714)
Properties (Page 297)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
TopConnectedObjectName Property (Page 645)
TopConnectedConnectionPointIndex Property (Page 645)
Top Property (Page 644)
ToolTipText Property (Page 643)
Parent Property (Page 529)
Orientation Property (Page 527)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Property (Page 461)
Height Property (Page 444)
Enabled Property (Page 407)
BottomConnectedObjectName Property (Page 354)
BottomConnectedConnectionPointIndex Property (Page 353)
WinCC: Scripting (VBS, ANSI-C, VBA)
166 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.3.3 Smart objects
3D Bar
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "3D Bar"
Type Identifier in VBS
HMIBar
Usage
In the following example, the object with the name "3DBar1" is moved 10 pixels to the right:
'VBS32
Dim objBar
Set objBar = ScreenItems("3DBar1")
objBar.Left = objBar.Left + 10
Notes on Error Handling
Bars and 3D bars are imaged in the object model on a "HMIBar" type. Since the two objects
have different properties, the availability of the property (dynamic type compilation in Runtime)
should be queried via an exception measure. The exception measure is activated for the
corresponding procedure by the following instruction:
On Error Resume Next
The instruction causes the VBScript engine to initiate the follow-on command in the case of a
Runtime error.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 167
VBS for Creating Procedures and Actions
1.14 VBS Reference
The error code can subsequently be checked using the Err object. In order to deactivate the
handling of Runtime errors in scripts, use the following command:
On Error Goto 0
Handling errors always relates to the procedure layer. If a script in a procedure causes an
error, VBScript checks whether an error handling measure is implemented in this layer. If not,
control is transferred one layer up (to the calling procedure). If there is no error handling
measure here either, the control is transferred yet another layer up. This continues until either
the top module level is reached or the code for Runtime error handling is located. If the
activation of the Runtime error handling fails, the control is transferred to the top level on the
internal VBScript Runtime error handing. This opens an error dialog and stops the script.
The "On Error Resume Next" command can be installed on all layers (i.e. also in procedures).
When the error handling measure is use, it can basically be determined whether the user is
actually using the required implementation type.
In addition, it can be ensured that there is no termination of execution due to a faulty access
to the object.
Examples of error handling
'VBS148
Sub OnClick(ByVal Item)
Dim objScreenItem
'
'Activation of errorhandling:
On Error Resume Next
For Each objScreenItem In ScreenItems
If "HMIBar" = objScreenItem.Type Then
'
'=== Property "Layer00Value" only available for 3D bar
objScreenItem.Layer00Value = objScreenItem.Layer00Value * 2
If 0 <> Err.Number Then
HMIRuntime.Trace objScreenItem.Name & ": no 3D bar" & vbCrLf
'
'Delete error message
Err.Clear
End If
End If
Next
On Error Goto 0 'Deactivation of errorhandling
End Sub
See also
Type Property (Page 669)
Layer08Color Property (Page 468)
BorderStyle Property (Page 352)
WinCC: Scripting (VBS, ANSI-C, VBA)
168 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
ZeroPointValue Property (Page 712)
Width Property (Page 701)
Visible Property (Page 699)
Top Property (Page 644)
ToolTipText Property (Page 643)
Process Property (Page 545)
PredefinedAngles Property (Page 544)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Min Property (Page 507)
Max Property (Page 489)
LightEffect Property (Page 478)
Left Property (Page 477)
Layer10Value Property (Page 476)
Layer09Value Property (Page 476)
Layer08Value Property (Page 475)
Layer07Value Property (Page 475)
Layer06Value Property (Page 475)
Layer05Value Property (Page 474)
Layer04Value Property (Page 474)
Layer03Value Property (Page 474)
Layer02Value Property (Page 474)
Layer01Value Property (Page 473)
Layer00Value Property (Page 473)
Layer10Color Property (Page 469)
Layer09Color Property (Page 468)
Layer07Color Property (Page 468)
Layer06Color Property (Page 467)
Layer05Color Property (Page 467)
Layer04Color Property (Page 467)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 169
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer03Color Property (Page 466)
Layer02Color Property (Page 466)
Layer01Color Property (Page 466)
Layer00Color Property (Page 465)
Layer10Checked Property (Page 465)
Layer09Checked Property (Page 465)
Layer08Checked Property (Page 464)
Layer07Checked Property (Page 464)
Layer06Checked Property (Page 464)
Layer05Checked Property (Page 463)
Layer04Checked Property (Page 463)
Layer03Checked Property (Page 463)
Layer02Checked Property (Page 462)
Layer01Checked Property (Page 462)
Layer00Checked Property (Page 462)
Layer Object (Page 118)
Height Property (Page 444)
Enabled Property (Page 407)
Direction Property (Page 404)
BorderWidth Property (Page 353)
BorderColor Property (Page 351)
BaseY Property (Page 339)
BaseX Property (Page 339)
BarWidth Property (Page 336)
BarHeight Property (Page 325)
BarDepth Property (Page 324)
Background Property (Page 320)
BackColor Property (Page 318)
Axe Property (Page 316)
AngleBeta Property (Page 308)
AngleAlpha Property (Page 307)
WinCC: Scripting (VBS, ANSI-C, VBA)
170 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Application Window
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Application Window"
Type Identifier in VBS
HMIApplicationWindow
Usage
In the following example, the object with the name "ApplicationWindow1" is moved 10 pixels
to the right:
'VBS33
Dim objAppWindow
Set objAppWindow = ScreenItems("ApplicationWindow1")
objAppWindow.Left = objAppWindow.Left + 10
See also
Properties (Page 297)
Activate Method (Page 714)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
WindowBorder Property (Page 702)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
Template Property (Page 598)
Parent Property (Page 529)
OnTop Property (Page 517)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 171
VBS for Creating Procedures and Actions
1.14 VBS Reference
ObjectName Property (Page 513)
Moveable Property (Page 508)
MaximizeButton Property (Page 489)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
Enabled Property (Page 407)
CloseButton Property (Page 369)
Caption Property (Page 360)
Application Property (Page 309)
Bar
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Bar"
Type Identifier in VBS
HMIBar
Usage
In the following example, the object with the name "Bar1" is moved 10 pixels to the right:
'VBS34
Dim objBar
Set objBar = ScreenItems("Bar1")
objBar.Left = objBar.Left + 10
WinCC: Scripting (VBS, ANSI-C, VBA)
172 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Notes on Error Handling
Bars and 3D bars are imaged in the object model on a "HMIBar" type. Since the two objects
have different properties, the availability of the property (dynamic type compilation in Runtime)
should be queried via an exception measure. The exception measure is activated for the
corresponding procedure by the following instruction:
On Error Resume Next
The instruction causes the VBScript engine to initiate the follow-on command in the case of a
Runtime error.
The error code can subsequently be checked using the Err object. In order to deactivate the
handling of Runtime errors in scripts, use the following command:
On Error Goto 0
Handling errors always relates to the procedure layer. If a script in a procedure causes an
error, VBScript checks whether an error handling measure is implemented in this layer. If not,
control is transferred one layer up (to the calling procedure). If there is no error handling
measure here either, the control is transferred yet another layer up. This continues until either
the top module level is reached or the code for Runtime error handling is located. If the
activation of the Runtime error handling fails, the control is transferred to the top level on the
internal VBScript Runtime error handing. This opens an error dialog and stops the script.
The "On Error Resume Next" command can be installed on all layers (i.e. also in procedures).
When the error handling measure is use, it can basically be determined whether the user is
actually using the required implementation type.
In addition, it can be ensured that there is no termination of execution due to a faulty access
to the object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 173
VBS for Creating Procedures and Actions
1.14 VBS Reference
Examples of error handling
'VBS147
Sub OnClick(ByVal Item)
Dim objScreenItem
'
'Activation of errorhandling:
On Error Resume Next
For Each objScreenItem In ScreenItems
If "HMIBar" = objScreenItem.Type Then
'
'=== Property "LimitHigh4" only available for bar
objScreenItem.LimitHigh4 = objScreenItem.LimitHigh4 * 2
If 0 <> Err.Number Then
HMIRuntime.Trace objScreenItem.Name & ": no bar" & vbCrLf
'
'Delete error message
Err.Clear
End If
End If
Next
On Error Goto 0 'Deactivation of errorhandling
End Sub
See also
ToolTipText Property (Page 643)
Layer Object (Page 118)
ColorChangeType Property (Page 373)
Average Property (Page 316)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
ZeroPointValue Property (Page 712)
ZeroPoint Property (Page 711)
Width Property (Page 701)
WarningLow Property (Page 701)
WarningHigh Property (Page 700)
Visible Property (Page 699)
TypeWarningLow Property (Page 673)
TypeWarningHigh Property (Page 673)
TypeToleranceLow Property (Page 672)
TypeToleranceHigh Property (Page 672)
WinCC: Scripting (VBS, ANSI-C, VBA)
174 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TypeLimitLow5 Property (Page 672)
TypeLimitLow4 Property (Page 672)
TypeLimitHigh5 Property (Page 671)
TypeLimitHigh4 Property (Page 671)
TypeAlarmLow Property (Page 671)
TypeAlarmHigh Property (Page 670)
Type Property (Page 669)
LTrendColor property (before WinCC V7) (Page 649)
Trend Property (Page 646)
Top Property (Page 644)
ToleranceLow Property (Page 630)
ToleranceHigh Property (Page 630)
ScalingType Property (Page 559)
Scaling Property (Page 559)
ScaleTicks Property (Page 558)
ScaleColor Property (Page 558)
RightComma Property (Page 552)
Process Property (Page 545)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Min Property (Page 507)
Max Property (Page 489)
Marker Property (Page 489)
LongStrokesTextEach Property (Page 486)
LongStrokesSize Property (Page 486)
LongStrokesOnly Property (Page 486)
LongStrokesBold Property (Page 485)
LimitLow5 Property (Page 479)
LimitLow4 Property (Page 479)
LimitHigh5 Property (Page 479)
LimitHigh4 Property (Page 478)
LeftComma Property (Page 478)
Left Property (Page 477)
HysteresisRange Property (Page 451)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 175
VBS for Creating Procedures and Actions
1.14 VBS Reference
Hysteresis Property (Page 451)
Height Property (Page 444)
FontSize Property (Page 433)
FontName Property (Page 433)
FontBold Property (Page 432)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle2 Property (Page 421)
FillStyle Property (Page 420)
FillColor Property (Page 418)
Exponent Property (Page 413)
Enabled Property (Page 407)
Direction Property (Page 404)
ColorWarningLow Property (Page 376)
ColorWarningHigh Property (Page 376)
ColorToleranceLow Property (Page 375)
ColorToleranceHigh Property (Page 375)
ColorLimitLow5 Property (Page 375)
ColorLimitLow4 Property (Page 374)
ColorLimitHigh5 Property (Page 374)
ColorLimitHigh4 Property (Page 374)
ColorAlarmLow Property (Page 373)
ColorAlarmHigh Property (Page 372)
CheckWarningLow Property (Page 367)
CheckWarningHigh Property (Page 367)
CheckToleranceLow Property (Page 367)
CheckToleranceHigh Property (Page 366)
CheckLimitLow5 Property (Page 366)
CheckLimitLow4 Property (Page 366)
CheckLimitHigh5 Property (Page 365)
CheckLimitHigh4 Property (Page 365)
CheckAlarmLow Property (Page 365)
CheckAlarmHigh Property (Page 364)
WinCC: Scripting (VBS, ANSI-C, VBA)
176 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
BackColor3 Property (Page 319)
BackColor2 Property (Page 319)
BackColor Property (Page 318)
AxisSection Property (Page 317)
Alignment Property (Page 305)
AlarmLow Property (Page 304)
AlarmHigh Property (Page 304)
Picture Window
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Picture Window"
Type Identifier in VBS
HMIScreenWindow
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 177
VBS for Creating Procedures and Actions
1.14 VBS Reference
Usage
In the following example, the object with the name "ScreenWindow1" is moved 10 pixels to
the right:
'VBS35
Dim objScrWindow
Set objScrWindow = ScreenItems("ScreenWindow1")
objScrWindow.Left = objScrWindow.Left + 10
See also
ServerPrefix Property (Page 572)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Zoom Property (Page 712)
WindowBorder Property (Page 702)
Width Property (Page 701)
Visible Property (Page 699)
UpdateCycle Property (Page 675)
Type Property (Page 669)
Top Property (Page 644)
TagPrefix Property (Page 596)
ScrollPositionY Property (Page 563)
ScrollPositionX Property (Page 562)
ScrollBars Property (Page 562)
ScreenName Property (Page 561)
Screens Property (Page 561)
Parent Property (Page 529)
OnTop Property (Page 517)
OffsetTop Property (Page 516)
OffsetLeft Property (Page 516)
ObjectName Property (Page 513)
Moveable Property (Page 508)
MaximizeButton Property (Page 489)
Left Property (Page 477)
WinCC: Scripting (VBS, ANSI-C, VBA)
178 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer Object (Page 118)
Height Property (Page 444)
Enabled Property (Page 407)
CloseButton Property (Page 369)
CaptionText property (Page 362)
Caption Property (Page 360)
AdaptSize Property (Page 303)
AdaptPicture Property (Page 302)
MenuToolBarConfig Property (Page 496)
Control
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Control"
The Control object type always assumes the properties of the Control type selected. In the
case of controls provided by WinCC, the properties are indicated under the description of the
corresponding Control.
In the case of controls from external suppliers, the control properties are supplied and thus not
a part of this description. However, the control properties can be queried using the "Item"
property.
Type Identifier in VBS
Special WinCC type descriptions or version-independent ProgID
Usage
In the following example, the object with the name "Control1" is moved 10 pixels to the right:
'VBS36
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left + 10
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 179
VBS for Creating Procedures and Actions
1.14 VBS Reference
Special feature
The controls provided by WinCC return a special ID as the type. It can be found under the
topic "Type Identification in VBS" in the individual descriptions of the WinCC Controls.
Use of Controls from External Suppliers
In the case of non-WinCC controls, the version-independent ProgID is returned as the type.
It is possible to determine the version-dependent ProgID or "User friendly Name" from the
ProgID: In the following example, "Control1" is a control embedded in the picture which already
returns the version-independent ProgID as a result of the Type property.
Note
Since not every Control has a version-dependent ProgID, an error handling measure should
be integrated to query the version-dependent ProgID or UserFriendlyName. If no error handling
is used, the code is terminated immediately without any result when no ProgID is found.
Determine the version-dependent ProgID as follows:
'VBS37
Dim objControl
Dim strCurrentVersion
Set objControl = ScreenItems("Control1")
strCurrentVersion = CreateObject("WScript.Shell").RegRead("HKCR\" & objControl.Type &
"\CurVer\")
MsgBox strCurrentVersion
Note
In order that example above works, a multimedia control should be inserted in the picture.
Determine the UserFriendlyName as follows:
'VBS38
Dim objControl
Dim strFriendlyName
Set objControl = ScreenItems("Control1")
strFriendlyName = CreateObject("WScript.Shell").RegRead("HKCR\" & objControl.Type & "\")
MsgBox strFriendlyName
Note
In order that example above works, a multimedia control should be inserted in the picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
180 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
If a non-WinCC control is used, it is possible that the properties provided by the control have
the same names as the general ScreenItem properties. In such cases, the ScreenItem
properties have priority. The "hidden" properties of an external control supplier can be
accessed using the additional "object" property. Address the properties of an external control
supplier as follows:
Control.object.type
The properties of the ScreenItem object are used in the case of identical names, if you use
the following form:
Control.type
WinCC controls available
● WinCC Alarm Control
● WinCC Digital/Analog Clock
● WinCC FunctionTrendControl
● WinCC Gauge Control
● WinCC Media Control
● WinCC OnlineTableControl
● WinCC OnlineTrendControl
● WinCC Slider Control
● WinCC UserArchiveControl
● HMI Symbol Library
See also
Object Property (Page 512)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
Parent Property (Page 529)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 181
VBS for Creating Procedures and Actions
1.14 VBS Reference
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Property (Page 461)
Height Property (Page 444)
Enabled Property (Page 407)
I/O Field
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "I/O Field"
Type Identifier in VBS
HMIIOField
Usage
In the following example, the object with the name "IOField1" is moved 10 pixels to the right:
'VBS39
Dim objIOField
Set objIOField = ScreenItems("IOField1")
objIOField.Left = objIOField.Left + 10
See also
OperationMessage Property (Page 518)
EditAtOnce Property (Page 406)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
182 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
OutputValue Property (Page 528)
OutputFormat Property (Page 528)
Orientation Property (Page 527)
OperationReport Property (Page 526)
ObjectName Property (Page 513)
LimitMin Property (Page 480)
LimitMax Property (Page 480)
Left Property (Page 477)
Layer Object (Page 118)
HiddenInput Property (Page 445)
Height Property (Page 444)
ForeFlashColorOn Property (Page 436)
ForeFlashColorOff Property (Page 435)
ForeColor Property (Page 435)
FontUnderline Property (Page 434)
FontSize Property (Page 433)
FontName Property (Page 433)
FontItalic Property (Page 432)
FontBold Property (Page 432)
FlashRateForeColor Property (Page 428)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashForeColor Property (Page 424)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillColor Property (Page 418)
Enabled Property (Page 407)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 183
VBS for Creating Procedures and Actions
1.14 VBS Reference
DataFormat Property (Page 396)
CursorControl Property (Page 394)
ClearOnNew Property (Page 368)
ClearOnError Property (Page 368)
BoxType Property (Page 355)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
BackColor Property (Page 318)
AssumeOnFull Property (Page 311)
AssumeOnExit Property (Page 311)
AlignmentTop Property (Page 305)
AlignmentLeft Property (Page 305)
AdaptBorder Property (Page 302)
Faceplate Instance
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the "faceplate instance" graphic object.
Type identifier in VBS
HMIFaceplateObject
WinCC: Scripting (VBS, ANSI-C, VBA)
184 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Usage
In the following example, the object with the name "FaceplateInstance1" is moved 10 pixels
to the right:
'VBS309
Dim objFaceplateObject
Set objFaceplateObject = ScreenItems("FaceplateInstance1")
objFaceplateObject.Left = objFaceplateObject.Left + 10
Graphic Object
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Graphic Object"
Type Identifier in VBS
HMIGraphicView
Usage
In the following example, the object with the name "GraphicObject1" is moved 10 pixels to the
right:
'VBS40
Dim objGraphicView
Set objGraphicView= ScreenItems("GraphicObject1")
objGraphicView.Left = objGraphicView.Left + 10
See also
Parent Property (Page 529)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 185
VBS for Creating Procedures and Actions
1.14 VBS Reference
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
PicUseTransColor Property (Page 541)
PictureName Property (Page 539)
PicTransColor Property (Page 537)
PicReferenced Property (Page 536)
PasswordLevel Property (Page 531)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
BackColor Property (Page 318)
WinCC: Scripting (VBS, ANSI-C, VBA)
186 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Combobox
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the "Combobox" graphic object.
Type Identifier in VBS
HMIComboBox
Usage
In the following example, the object with the name "ComboBox1" is moved 10 pixels to the
right:
'VBS21
Dim objComboBox
Set objComboBox = ScreenItems("ComboBox1")
objComboBox.Left = objComboBox.Left + 10
See also
Text list property (Page 599)
List Box
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 187
VBS for Creating Procedures and Actions
1.14 VBS Reference
Object Type of ScreenItem Object. Represents the "List Box" graphic object.
Type Identifier in VBS
HMIListBox
Usage
In the following example, the object with the name "ListBox1" is moved 10 pixels to the right:
'VBS21
Dim objListBox
Set objListBox = ScreenItems("ListBox1")
objListBox.Left = objListBox.Left + 10
See also
Text list property (Page 599)
Multiple row text
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the "Multiline Text" graphic object.
Type Identifier in VBS
HMIMultiLineEdit
WinCC: Scripting (VBS, ANSI-C, VBA)
188 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Usage
In the following example, the object with the name "MultiLineEdit1" is moved 10 pixels to the
right:
'VBS21
Dim objMultiLineEdit
Set objMultiLineEdit = ScreenItems("MultiLineEdit1")
objMultiLineEdit.Left = objMultiLineEdit.Left + 10
OLE object
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "OLE Element". The return
value is a STRING type.
Type Identifier in VBS
Version-independent ProgID
Usage
In the following example, the object with the name "OLEElement1" is moved 10 pixels to the
right:
'VBS41
Dim objOLEElement
Set objOLEElement = ScreenItems("OLEElement1")
objOLEElement.Left = objOLEElement.Left + 10
Special feature
In the case of OLE Elements, the version-independent ProgID is returned as the type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 189
VBS for Creating Procedures and Actions
1.14 VBS Reference
It is possible to determine the version-dependent ProgID or "User friendly Name" from the
ProgID: In the following example, "OLEObject1" is a control embedded in the picture which
already returns the version-independent ProgID as a result of the Type property.
Note
Since not every Control has a version-dependent ProgID, an error handling measure should
be integrated to query the version-dependent ProgID or UserFriendlyName. If no error handling
is used, the code is terminated immediately without any result when no ProgID is found.
Determine the version-dependent ProgID as follows:
'VBS42
Dim objControl
Dim strCurrentVersion
Set objControl = ScreenItems("OLEElement1")
strCurrentVersion = CreateObject("WScript.Shell").RegRead("HKCR\" & objControl.Type &
"\CurVer\")
MsgBox strCurrentVersion
Note
In order that the example above works, a Word document should be embedded in the picture
as an OLE Element.
Determine the User Friendly Name as follows:
'VBS43
Dim objControl
Dim strFriendlyName
Set objControl = ScreenItems("OLEElement1")
strFriendlyName = CreateObject("WScript.Shell").RegRead("HKCR\" & objControl.Type & "\")
MsgBox strFriendlyName
Note
In order that the example above works, a Word document should be embedded in the picture
as an OLE Element.
WinCC: Scripting (VBS, ANSI-C, VBA)
190 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Using OLE Elements
If an OLE Element is used, it is possible that the properties provided by the OLE Element have
the same names as the general ScreenItem properties. In such cases, the ScreenItem
properties have priority. The "hidden" properties of an OLE Element can be accessed using
the additional "Object" property. Address the properties of an OLE Element as follows:
OLEObjekt.object.type
Only use the form
OLEObjekt.type
In the case of identical names, the properties of the ScreenItem object are used.
See also
Height Property (Page 444)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
Parent Property (Page 529)
Object Property (Page 512)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Property (Page 461)
Enabled Property (Page 407)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 191
VBS for Creating Procedures and Actions
1.14 VBS Reference
Group Display
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Group Display"
Type Identifier in VBS
HMIGroupDisplay
Usage
In the following example, the object with the name "GroupDisplay1" is moved 10 pixels to the
right:
'VBS44
Dim objGroupDisplay
Set objGroupDisplay = ScreenItems("GroupDisplay1")
objGroupDisplay.Left = objGroupDisplay.Left + 10
See also
Activate Method (Page 714)
MCKQBackColorOn Property (Page 493)
FontBold Property (Page 432)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
UserValue4 Property (Page 681)
UserValue3 Property (Page 680)
UserValue2-Eigenschaft (Page 680)
UserValue1 Property (Page 680)
WinCC: Scripting (VBS, ANSI-C, VBA)
192 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
SignificantMask Property (Page 579)
SameSize Property (Page 558)
Relevant Property (Page 551)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
MessageClass Property (Page 504)
MCText Property (Page 495)
MCKQTextFlash Property (Page 495)
MCKQTextColorOn Property (Page 494)
MCKQTextColorOff Property (Page 494)
MCKQBackFlash Property (Page 494)
MCKQBackColorOff Property (Page 493)
MCKOTextFlash Property (Page 493)
MCKOTextColorOn Property (Page 493)
MCKOTextColorOff Property (Page 492)
MCKOBackFlash Property (Page 492)
MCKOBackColorOn Property (Page 492)
MCKOBackColorOff Property (Page 491)
MCGUTextFlash Property (Page 491)
MCGUTextColorOn Property (Page 491)
MCGUTextColorOff Property (Page 491)
MCGUBackFlash Property (Page 490)
MCGUBackColorOn Property (Page 490)
MCGUBackColorOff-Eigenschaft (Page 490)
LockTextColor Property (Page 485)
LockText Property (Page 485)
LockStatus Property (Page 484)
LockBackColor Property (Page 484)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 193
VBS for Creating Procedures and Actions
1.14 VBS Reference
FontUnderline Property (Page 434)
FontSize Property (Page 433)
FontName Property (Page 433)
FontItalic Property (Page 432)
FlashRate Property (Page 426)
Enabled Property (Page 407)
CollectValue Property (Page 371)
Button4Width Property (Page 360)
Button3Width Property (Page 359)
Button2Width Property (Page 359)
Button1Width Property (Page 359)
BackColor Property (Page 318)
AlignmentTop Property (Page 305)
AlignmentLeft Property (Page 305)
Text list
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Text List"
Type Identifier in VBS
HMISymbolicIOField
WinCC: Scripting (VBS, ANSI-C, VBA)
194 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Usage
In the following example, the object with the name "TextList1" is moved 10 pixels to the right:
'VBS45
Dim objSymIO
Set objSymIO = ScreenItems("TextList1")
objSymIO.Left = objSymIO.Left + 10
See also
Type Property (Page 669)
FontUnderline Property (Page 434)
BackFlashColorOff Property (Page 320)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
UnselTextColor Property (Page 675)
UnselBGColor Property (Page 675)
Top Property (Page 644)
ToolTipText Property (Page 643)
SelTextColor Property (Page 569)
SelBGColor Property (Page 564)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
OutputValue Property (Page 528)
Orientation Property (Page 527)
OperationReport Property (Page 526)
OperationMessage Property (Page 518)
ObjectName Property (Page 513)
NumberLines Property (Page 511)
ListType Property (Page 482)
Left Property (Page 477)
Layer Object (Page 118)
LanguageSwitch Property (Page 458)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 195
VBS for Creating Procedures and Actions
1.14 VBS Reference
ItemBorderWidth Property (Page 456)
ItemBorderStyle Property (Page 456)
ItemBorderColor Property (Page 455)
ItemBorderBackColor Property (Page 455)
Height Property (Page 444)
ForeFlashColorOn Property (Page 436)
ForeFlashColorOff Property (Page 435)
ForeColor Property (Page 435)
FontSize Property (Page 433)
FontName Property (Page 433)
FontItalic Property (Page 432)
FontBold Property (Page 432)
FlashRateForeColor Property (Page 428)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashForeColor Property (Page 424)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillColor Property (Page 418)
Enabled Property (Page 407)
EditAtOnce Property (Page 406)
CursorControl Property (Page 394)
BoxType Property (Page 355)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BitNumber Property (Page 343)
BackFlashColorOn Property (Page 320)
BackColor Property (Page 318)
AssumeOnExit Property (Page 311)
Assignments Property (Page 311)
WinCC: Scripting (VBS, ANSI-C, VBA)
196 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
AlignmentTop Property (Page 305)
AlignmentLeft Property (Page 305)
AdaptBorder Property (Page 302)
Text list property (Page 599)
TextListSort property (Page 600)
Status display
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Status Display"
Type Identifier in VBS
HMIGraphicIOField
Usage
In the following example, the object with the name "StatusDisplay1" is moved 10 pixels to the
right:
'VBS46
Dim objGraphicIO
Set objGraphicIO= ScreenItems("StatusDisplay1")
objGraphicIO.Left = objGraphicIO.Left + 10
See also
Layer Object (Page 118)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 197
VBS for Creating Procedures and Actions
1.14 VBS Reference
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Index Property (Page 452)
Height Property (Page 444)
FlashRateFlashPic Property (Page 428)
FlashRateBorderColor Property (Page 427)
FlashPicUseTransColor Property (Page 426)
FlashPicture Property (Page 425)
FlashPicTransColor Property (Page 425)
FlashPicReferenced Property (Page 425)
FlashFlashPicture Property (Page 424)
FlashBorderColor Property (Page 424)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BasePicUseTransColor Property (Page 338)
BasePicture Property (Page 338)
BasePicTransColor Property (Page 337)
BasePicReferenced Property (Page 337)
WinCC: Scripting (VBS, ANSI-C, VBA)
198 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.3.4 Windows objects
Button
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Button"
Type Identifier in VBS
HMIButton
Usage
In the following example, the object with the name "Button1" is moved 10 pixels to the right:
'VBS47
Dim cmdButton
Set cmdButton = ScreenItems("Button1")
cmdButton.Left = cmdButton.Left + 10
Notes on Error Handling
Buttons and pushbuttons are mapped in the object model to an "HMIButton" type. Since the
objects have different properties, the availability of the property (dynamic type compilation in
Runtime) should be queried via an exception measure. The exception measure is activated
for the corresponding procedure by the following instruction:
On Error Resume Next
The instruction causes the VBScript engine to initiate the follow-on command in the case of a
Runtime error.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 199
VBS for Creating Procedures and Actions
1.14 VBS Reference
The error code can subsequently be checked using the Err object. In order to deactivate the
handling of Runtime errors in scripts, use the following command:
On Error Goto 0
Handling errors always relates to the procedure layer. If a script in a procedure causes an
error, VBScript checks whether an error handling measure is implemented in this layer. If not,
control is transferred one layer up (to the calling procedure). If there is no error handling
measure here either, the control is transferred yet another layer up. This continues until either
the top module level is reached or the code for Runtime error handling is located. If the
activation of the Runtime error handling fails, the control is transferred to the top level on the
internal VBScript Runtime error handing. This opens an error dialog and stops the script.
The "On Error Resume Next" command can be installed on all layers (i.e. also in procedures).
When the error handling measure is use, it can basically be determined whether the user is
actually using the required implementation type.
In addition, it can be ensured that there is no termination of execution due to a faulty access
to the object.
Examples of error handling
Sub OnClick(ByVal Item)
'VBS48
Dim objScreenItem
On Error Resume Next 'Activation of errorhandling
For Each objScreenItem In ScreenItems
If objScreenItem.Type = "HMIButton" Then
'
'=== Property "Text" available only for Standard-Button
objScreenItem.Text = "Windows"
If 0 <> Err.Number Then
HMIRuntime.Trace objScreenItem.ObjectName & ": no Windows-Button" & vbCrLf
Err.Clear 'Delete error message
End If
End If
Next
On Error Goto 0 'Deactivation of errorhandling
End Sub
See also
Top Property (Page 644)
FlashBorderColor Property (Page 424)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
WinCC: Scripting (VBS, ANSI-C, VBA)
200 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ScreenItem Object (Page 123)
WindowsStyle Property (Page 703)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
ToolTipText Property (Page 643)
Text list (Page 194)
PictureUp Property (Page 540)
PictureDown Property (Page 538)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
Orientation Property (Page 527)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Hotkey Property (Page 450)
Height Property (Page 444)
ForeFlashColorOn Property (Page 436)
ForeFlashColorOff Property (Page 435)
ForeColor Property (Page 435)
FontUnderline Property (Page 434)
FontSize Property (Page 433)
FontName Property (Page 433)
FontItalic Property (Page 432)
FontBold Property (Page 432)
FlashRateForeColor Property (Page 428)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashForeColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
Enabled Property (Page 407)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 201
VBS for Creating Procedures and Actions
1.14 VBS Reference
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColorTop Property (Page 351)
BorderColor Property (Page 351)
BorderColorBottom Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
BackColor Property (Page 318)
AlignmentTop Property (Page 305)
AlignmentLeft Property (Page 305)
AdaptBorder Property (Page 302)
Check box
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Check Box"
Type Identifier in VBS
HMICheckBox
WinCC: Scripting (VBS, ANSI-C, VBA)
202 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Usage
In the following example, the object with the name "CheckBox1" is moved 10 pixels to the right:
'VBS49
Dim chkCheckBox
Set chkCheckBox = ScreenItems("CheckBox1")
chkCheckBox.Left = chkCheckBox.Left + 10
See also
FontSize Property (Page 433)
BackColor Property (Page 318)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
Text list (Page 194)
Process Property (Page 545)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
Orientation Property (Page 527)
OperationMessage Property (Page 518)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Index Property (Page 452)
Height Property (Page 444)
ForeFlashColorOn Property (Page 436)
ForeFlashColorOff Property (Page 435)
ForeColor Property (Page 435)
FontUnderline Property (Page 434)
FontName Property (Page 433)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 203
VBS for Creating Procedures and Actions
1.14 VBS Reference
FontItalic Property (Page 432)
FontBold Property (Page 432)
FlashRateForeColor Property (Page 428)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashForeColor Property (Page 424)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
Enabled Property (Page 407)
BoxCount Property (Page 354)
BoxAlignment Property (Page 354)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
AlignmentTop Property (Page 305)
AlignmentLeft Property (Page 305)
AdaptBorder Property (Page 302)
Text list property (Page 599)
WinCC: Scripting (VBS, ANSI-C, VBA)
204 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Radio box
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Radio Box"
Type Identifier in VBS
HMIOptionGroup
Usage
In the following example, the object with the name "RadioBox1" is moved 10 pixels to the right:
'VBS50
Dim objOptionGroup
Set objOptionGroup = ScreenItems("RadioBox1")
objOptionGroup.Left = objOptionGroup.Left + 10
See also
ForeColor Property (Page 435)
BackFlashColorOn Property (Page 320)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
Text list (Page 194)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 205
VBS for Creating Procedures and Actions
1.14 VBS Reference
Process Property (Page 545)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
Orientation Property (Page 527)
OperationMessage Property (Page 518)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Index Property (Page 452)
Height Property (Page 444)
ForeFlashColorOn Property (Page 436)
ForeFlashColorOff Property (Page 435)
FontUnderline Property (Page 434)
FontSize Property (Page 433)
FontName Property (Page 433)
FontItalic Property (Page 432)
FontBold Property (Page 432)
FlashRateForeColor Property (Page 428)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashForeColor Property (Page 424)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
Enabled Property (Page 407)
BoxCount Property (Page 354)
BoxAlignment Property (Page 354)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
WinCC: Scripting (VBS, ANSI-C, VBA)
206 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BorderBackColor Property (Page 350)
BackFlashColorOff Property (Page 320)
BackColor Property (Page 318)
AlignmentTop Property (Page 305)
AlignmentLeft Property (Page 305)
AdaptBorder Property (Page 302)
Text list property (Page 599)
Round Button
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Round Button"
Type Identifier in VBS
HMISwitch
Usage
In the following example, the object with the name "RoundButton1" is moved 10 pixels to the
right:
'VBS51
Dim objSwitch
Set objSwitch= ScreenItems("RoundButton1")
objSwitch.Left = objSwitch.Left + 10
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 207
VBS for Creating Procedures and Actions
1.14 VBS Reference
Sub OnClick(ByVal Item)
'VBS52
Dim objScreenItem
On Error Resume Next 'Activation of errorhandling
For Each objScreenItem In ScreenItems
If objScreenItem.Type = "HMIButton" Then
'
'=== Property "Text" available only for Standard-Button
objScreenItem.Text = "Windows"
If 0 <> Err.Number Then
HMIRuntime.Trace objScreenItem.ObjectName & ": no Windows-Button" & vbCrLf
Err.Clear 'Delete error message
End If
'
'=== Property "Radius" available only for RoundButton
objScreenItem.Radius = 10
If 0 <> Err.Number Then
HMIRuntime.Trace ScreenItem.ObjectName & ": no RoundButton" & vbCrLf
Err.Clear
End If
End If
Next
On Error Goto 0 'Deactivation of errorhandling
End Sub
See also
PicDownUseTransColor Property (Page 536)
BorderColorTop Property (Page 351)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
Toggle Property (Page 629)
Radius Property (Page 548)
Pressed Property (Page 544)
PicUpUseTransColor Property (Page 541)
PicUpTransparent Property (Page 541)
WinCC: Scripting (VBS, ANSI-C, VBA)
208 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
PicUpReferenced Property (Page 540)
PictureUp Property (Page 540)
PictureDown Property (Page 538)
PictureDeactivated Property (Page 538)
PicDownTransparent Property (Page 536)
PicDownReferenced Property (Page 536)
PicDeactUseTransColor Property (Page 535)
PicDeactTransparent Property (Page 535)
PicDeactReferenced-Eigenschaft (Page 535)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
Enabled Property (Page 407)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
BorderColor Property (Page 351)
BorderColorBottom Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
BackColor Property (Page 318)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 209
VBS for Creating Procedures and Actions
1.14 VBS Reference
Slider
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Slider"
Type Identifier in VBS
HMISlider
Usage
In the following example, the object with the name "Slider1" is moved 10 pixels to the right:
'VBS53
Dim sldSlider
Set sldSlider = ScreenItems("Slider1")
sldSlider.Left = sldSlider.Left + 10
Notes on Error Handling
Sliders and WinCC slider controls are mapped in the object model to an "HMISlider" type.
Since the objects have different properties, the availability of the property (dynamic type
compilation in Runtime) should be queried via an exception measure. The exception measure
is activated for the corresponding procedure by the following instruction:
On Error Resume Next
The instruction causes the VBScript engine to initiate the follow-on command in the case of a
Runtime error.
The error code can subsequently be checked using the Err object. In order to deactivate the
handling of Runtime errors in scripts, use the following command:
On Error Goto 0
WinCC: Scripting (VBS, ANSI-C, VBA)
210 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Handling errors always relates to the procedure layer. If a script in a procedure causes an
error, VBScript checks whether an error handling measure is implemented in this layer. If not,
control is transferred one layer up (to the calling procedure). If there is no error handling
measure here either, the control is transferred yet another layer up. This continues until either
the top module level is reached or the code for Runtime error handling is located. If the
activation of the Runtime error handling fails, the control is transferred to the top level on the
internal VBScript Runtime error handing. This opens an error dialog and stops the script.
The "On Error Resume Next" command can be installed on all layers (i.e. also in procedures).
When the error handling measure is use, it can basically be determined whether the user is
actually using the required implementation type.
In addition, it can be ensured that there is no termination of execution due to a faulty access
to the object.
Examples of error handling
Sub OnClick(Byval Item)
'VBS194
Dim ScreenItem
' activating error handling:
On Error Resume Next
For Each ScreenItem In ScreenItems
If ScreenItem.Type = "HMISlider" Then
'=== Property "BevelColorUp" only exists for a WinCC Slider Control
ScreenItem.BevelColorUp = 1
If (Err.Number <> 0) Then
HMIRuntime.Trace(ScreenItem.ObjectName + ": no Windows-Slider" + vbCrlf)
' delete error message
Err.Clear
End If
'=== Property "BorderStyle" only exists for a Windows-Slider
ScreenItem.BorderStyle = 1
If (Err.Number <> 0) Then
HMIRuntime.Trace(ScreenItem.ObjectName + ": no WinCC Slider Control" + vbCrlf)
Err.Clear
End If
End If
Next
On Error GoTo 0 ' deactivating error handling
End Sub
See also
Height Property (Page 444)
BackColorBottom Property (Page 319)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 211
VBS for Creating Procedures and Actions
1.14 VBS Reference
WindowsStyle Property (Page 703)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
SmallChange Property (Page 580)
Process Property (Page 545)
PasswordLevel Property (Page 531)
Parent Property (Page 529)
OperationReport Property (Page 526)
OperationMessage Property (Page 518)
ObjectName Property (Page 513)
Min Property (Page 507)
Max Property (Page 489)
Left Property (Page 477)
Layer Object (Page 118)
FlashRateBorderColor Property (Page 427)
FlashRateBackColor Property (Page 427)
FlashBorderColor Property (Page 424)
FlashBackColor Property (Page 423)
FillStyle Property (Page 420)
FillingIndex Property (Page 419)
Filling Property (Page 419)
FillColor Property (Page 418)
ExtendedOperation Property (Page 415)
Enabled Property (Page 407)
Direction Property (Page 404)
ColorTop Property (Page 375)
ColorBottom Property (Page 373)
ButtonColor Property (Page 355)
BorderWidth Property (Page 353)
BorderStyle Property (Page 352)
BorderFlashColorOn Property (Page 352)
BorderFlashColorOff Property (Page 352)
WinCC: Scripting (VBS, ANSI-C, VBA)
212 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BorderColor Property (Page 351)
BorderBackColor Property (Page 350)
BackFlashColorOn Property (Page 320)
BackFlashColorOff Property (Page 320)
BackColorTop Property (Page 320)
BackColor Property (Page 318)
1.14.3.5 Tube objects
Polygon Tube
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the "Polygon Tube" graphic object.
Type Identifier in VBS
HMITubePolyline
Usage
In the following example, the object with the name "TubePolyline1" is moved 10 pixels to the
right:
'VBS24
Dim objTubePolyline
Set objTubePolyline = ScreenItems("TubePolyline1")
objTubePolyline.Left = objTubePolyline.Left + 10
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 213
VBS for Creating Procedures and Actions
1.14 VBS Reference
T-piece
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the "T-piece" graphic object.
Type Identifier in VBS
HMITubeTeeObject
Usage
In the following example, the object with the name "TubeTeeObject1" is moved 10 pixels to
the right:
'VBS21
Dim objTubeTeeObject
Set objTubeTeeObject = ScreenItems("TubeTeeObject1")
objTubeTeeObject.Left = objTubeTeeObject.Left + 10
Double T-piece
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the "Double T-piece" graphic object.
WinCC: Scripting (VBS, ANSI-C, VBA)
214 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Type Identifier in VBS
HMITubeDoubleTeeObject
Usage
In the following example, the object with the name "TubeDoubleTeeObject1" is moved 10
pixels to the right:
'VBS21
Dim objTubeDoubleTeeObject
Set objTubeDoubleTeeObject = ScreenItems("TubeDoubleTeeObject1")
objTubeDoubleTeeObject.Left = objTubeDoubleTeeObject.Left + 10
Tube Bend
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the "Tube Arc" graphic object.
Type Identifier in VBS
HMITubeArcObject
Usage
In the following example, the object with the name "TubeArcObject1" is moved 10 pixels to the
right:
'VBS24
Dim objTubeArcObject
Set objTubeArcObject = ScreenItems("TubeArcObject1")
objTubeArcObject.Left = objTubeArcObject.Left + 10
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 215
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.3.6 Controls
Controls
Special features with controls
In the case of non-WinCC controls, the version-independent ProgID is returned as the type.
It is possible to determine the version-dependent ProgID or "User friendly Name" from the
ProgID: In the following example, "Control1" is a control embedded in the picture which already
returns the version-independent ProgID as a result of the Type property.
Note
Since not every Control has a version-dependent ProgID, an error handling measure should
be integrated to query the version-dependent ProgID or UserFriendlyName. If no error handling
is used, the code is terminated immediately without any result when no ProgID is found.
Determine the version-dependent ProgID as follows:
'VBS153
Dim objControl
Dim strCurrentVersion
Set objControl = ScreenItems("Control1")
strCurrentVersion = CreateObject("WScript.Shell").RegRead("HKCR\" & objControl.Type &
"\CurVer\")
MsgBox strCurrentVersion
Note
In order that example above works, a multimedia control should be inserted in the picture.
Determine the User Friendly Name as follows:
'VBS154
Dim objControl
Dim strFriendlyName
Set objControl = ScreenItems("Control1")
strFriendlyName = CreateObject("WScript.Shell").RegRead("HKCR\" & objControl.Type & "\")
MsgBox strFriendlyName
Note
In order that example above works, a multimedia control should be inserted in the picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
216 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Restrictions of VBS for Dynamization by Controls
If Controls are to be dynamized with, the following conditions must be fulfilled:
Methods
The "ByRef" declaration may only be implemented as a "Variant" (ByRef xxx as Variant)
The "ByVal" declaration may only be implemented with tag types (ByVal xxx as Long)
Properties
The "ByRef" declaration may only be implemented as a "Variant" (ByRef xxx as Variant)
The "ByVal" declaration may only be implemented with tag types (ByVal xxx as Long)
Events
The "ByRef" declaration is not permitted.
The "ByVal" declaration may only be implemented as a "Variant" (ByVal xxx as Variant)
Arrays
If arrays are used, they must be declared with (ByRef xxx As Variant).
In order that arrays can be transferred in variants, variant tag must also be inserted as an
intermediate tag according to the following scheme:
'VBS151
Dim arrayPoints(200)
Dim vArrayCoercion 'Variant for array Coercion
' Make the VBS Array compatibile with the OLE Automation
vArrayCoercion = (arrayPoints)
objTrendControl.DataXY = vArrayCoercion ' this array will occur in the control
Use of Controls from External Suppliers
If a non-WinCC control is used, it is possible that the properties provided by the control have
the same names as the general ScreenItem properties. In such cases, the ScreenItem
properties have priority. The "hidden" properties of an external control supplier can be
accessed using the additional "object" property. Address the properties of an external control
supplier as follows:
Control.object.type
If you use the following form, the properties of the ScreenItem object are used in the case of
identical names:
Control.type
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 217
VBS for Creating Procedures and Actions
1.14 VBS Reference
Double parameter
When using a Control which is not an internal WinCC control, it is possible that the event
prototypes contain a parameter with the name "Item". In this case, the name of the parameter
is renamed according to "ObjectItem" in the VBS prototype submitted. If this name already
exists, the name is differentiated by numbers being appended.
WinCC controls available
● HMI Symbol Library
● WinCC AlarmControl
● WinCC Alarm Control (before WinCC V7)
● WinCC Digital/Analog Clock
● WinCC FunctionTrendControl
● WinCC Function Trend Control (before WinCC V7)
● WinCC Gauge Control
● WinCC Media Control
● WinCC OnlineTableControl
● WinCC Online Table Control (before WinCC V7)
● WinCC OnlineTrendControl
● WinCC Online Trend Control (before WinCC V7)
● WinCC Push Button Control (up to WinCC V7.3)
● WinCC RulerControl
● WinCC Slider Control
● WinCC UserArchiveControl
See also
HMI Symbol Library (Page 237)
WinCC Slider Control (Page 270)
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Gauge Control (Page 251)
WinCC Function Trend Control (before WinCC V7) (Page 281)
WinCC Digital/Analog Clock (Page 244)
WinCC Alarm Control (before WinCC V7) (Page 279)
WinCC UserArchiveControl (Page 274)
WinCC RulerControl (Page 266)
WinCC: Scripting (VBS, ANSI-C, VBA)
218 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
WinCC OnlineTrendControl (Page 260)
WinCC OnlineTableControl (Page 254)
WinCC FunctionTrendControl (Page 246)
WinCC AlarmControl (Page 238)
List of controls
Column object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "Column" listing object to configure the properties of the columns in the WinCC
UserArchiveControl.
Use in the controls
● WinCC UserArchiveControl (Page 274)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "colobj.ColumnName", the listing name "Column" is dropped:
"colobj.Name".
ColumnAlias (Page 382) ColumnFlagUnique ColumnPosition (Page 387) ColumnSort (Page 390)
(Page 384)
ColumnAlign (Page 382) ColumnHideText (Page 385) ColumnPrecisions ColumnSortIndex (Page 391)
(Page 387)
ColumnAutoPrecisions ColumnHideTitleText ColumnReadAccess ColumnStartValue
(Page 383) (Page 385) (Page 388) (Page 391)
ColumnCaption (Page 383) ColumnIndex (Page 386) ColumnReadonly (Page 388) ColumnStringLength
(Page 391)
ColumnCount (Page 383) ColumnLeadingZeros ColumnRepos (Page 388) ColumnTimeFormat
(Page 386) (Page 391)
ColumnDateFormat ColumnLength (Page 386) ColumnShowDate ColumnType (Page 392)
(Page 383) (Page 389)
ColumnDMVarName ColumnMaxValue ColumnShowIcon ColumnVisible (Page 393)
(Page 384) (Page 387) (Page 389)
ColumnExponentialFormat ColumnMinValue (Page 387) ColumnShowTitleIcon ColumnWriteAccess
(Page 384) (Page 390) (Page 393)
ColumnFlagNotNull ColumnName (Page 387)
(Page 384)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 219
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
GetColumn method (Page 723)
GetColumnCollection method (Page 724)
HitlistColumn object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "HitlistColumn" listing object to configure the message blocks used in the hitlist of
WinCC AlarmControl.
Use in the controls
● WinCC AlarmControl (Page 238)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "hitlistobj.HitlistColumnName", the listing name
"HitlistColumn" is dropped: "hitlistobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
HitlistColumnAdd (Page 445) HitlistColumnRepos (Page 447) HitListMaxSourceItems (Page 448)
HitlistColumnAutoAdjust (Page 445) HitlistColumnSort (Page 447) HitListMaxSourceItemsWarn
(Page 448)
HitlistColumnCount (Page 446) HitlistColumnSortIndex (Page 447) HitListRelTime (Page 449)
HitlistColumnIndex (Page 446) HitlistColumnVisible (Page 447) HitListRelTimeFactor (Page 449)
HitlistColumnName (Page 446) HitListDefaultSort (Page 448) HitListRelTimeFactorType (Page 449)
HitlistColumnRemove (Page 446)
See also
GetHitlistColumn method (Page 725)
GetHistlistColumnCollection method (Page 726)
WinCC: Scripting (VBS, ANSI-C, VBA)
220 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
MessageBlock object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "MessageBlock" listing object to configure the message blocks in WinCC
AlarmControl.
Use in the controls
● WinCC AlarmControl (Page 238)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "messageobj.MessageBlockName", the listing name
"MessageBlock" is dropped: "messageobj.Name".
MessageBlockAlign MessageBlockFlashOn MessageBlockLength MessageBlockShowIcon
(Page 496) (Page 498) (Page 501) (Page 502)
MessageBlockAutoPreci‐ MessageBlockHideText MessageBlockName MessageBlockShowTitleIcon
sions (Page 496) (Page 499) (Page 501) (Page 502)
MessageBlockCaption MessageBlockHideTitleText MessageBlockPrecisions MessageBlockTextId
(Page 497) (Page 499) (Page 501) (Page 502)
MessageBlockCount MessageBlockID (Page 499) MessageBlockSelected MessageBlockTimeFormat
(Page 497) (Page 501) (Page 503)
MessageBlockDateFormat MessageBlockIndex MessageBlockShowDate MessageBlockType
(Page 500) (Page 502) (Page 503)
MessageBlockExponential‐ MessageBlockLeadingZeros
Format (Page 498) (Page 500)
See also
GetMessageBlock method (Page 727)
GetMessageBlockCollection method (Page 728)
MessageColumn object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "MessageColumn" listing object to configure the message blocks used in the message
lists of WinCC AlarmControl.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 221
VBS for Creating Procedures and Actions
1.14 VBS Reference
Use in the controls
● WinCC AlarmControl (Page 238)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "messagecol.MessageColumnName", the listing name
"MessageColumn" is dropped: "messagecol.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
MessageColumnAdd (Page 504) MessageColumnName (Page 505) MessageColumnSort (Page 506)
MessageColumnAutoAdjust (Page 504) MessageColumnRemove (Page 505) MessageColumnSortIndex (Page 506)
MessageColumnCount (Page 505) MessageColumnRepos (Page 506) MessageColumnVisible (Page 506)
MessageColumnIndex (Page 505)
See also
GetMessageColumn method (Page 729)
GetMessageColumnCollection method (Page 730)
OperatorMessage object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "OperatorMessage" listing object to configure the operator messages displayed in
WinCC AlarmControl.
Use in the controls
● WinCC AlarmControl (Page 238)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "opmessobj.OperatorMessageName", the listing name
"OperatorMessage" is dropped: "opmessobj.Name".
OperatorMessageID (Page 518) OperatorMessageSource5 (Page 521) OperatorMessageSourceType3
(Page 524)
OperatorMessageIndex (Page 518) OperatorMessageSource6 (Page 521) OperatorMessageSourceType4
(Page 524)
WinCC: Scripting (VBS, ANSI-C, VBA)
222 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
OperatorMessageName (Page 519) OperatorMessageSource7 (Page 522) OperatorMessageSourceType5
(Page 524)
OperatorMessageNumber (Page 519) OperatorMessageSource8 (Page 522) OperatorMessageSourceType6
(Page 525)
OperatorMessageSelected (Page 519) OperatorMessageSource9 (Page 522) OperatorMessageSourceType7
(Page 525)
OperatorMessageSource1 (Page 520) OperatorMessageSource10 (Page 523) OperatorMessageSourceType8
(Page 525)
OperatorMessageSource2 (Page 520) OperatorMessageSourceType1 OperatorMessageSourceType9
(Page 523) (Page 526)
OperatorMessageSource3 (Page 520) OperatorMessageSourceType2 OperatorMessageSourceType10
(Page 523) (Page 526)
OperatorMessageSource4 (Page 521)
See also
GetOperatorMessage method (Page 731)
GetOperatorMessageCollection method (Page 732)
Row object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "Row" listing object to access the rows of the table-based controls. The Row object
refers to the runtime data in the tables.
Use in the controls
WinCC AlarmControl (Page 238) WinCC OnlineTableControl (Page 254)
WinCC RulerControl (Page 266) WinCC UserArchiveControl (Page 274)
Available methods of the object
SelectAll (Page 799) SelectRow (Page 800)
UnselectAll (Page 814) UnselectRow (Page 815)
Available properties of the object
● Count (Page 382)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 223
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
'VBS371
Dim mycontrol
Set mycontrol = ScreenItems.Item("Control1")
Dim rowobj
Set rowobj = mycontrol.GetRowCollection
'Reading the property Count of the collection
HMIRuntime.Trace "RowCount: " & rowobj.Count & vbNewline
'Reading the properties CellText, CellCount an RowNumber for the items of the collection
For lIndex = 1 To rowobj.Count
'In this example the CellText of the third column is returned
HMIRuntime.Trace "RowCellText: " & lIndex & ": " & rowobj.item(lIndex).CellText(3) &
vbNewline
HMIRuntime.Trace "RowCellCount: " & lIndex & ": " & rowobj.item(lIndex).CellCount &
vbNewline
HMIRuntime.Trace "RowNumber: " & rowobj.item(lIndex).RowNumber & vbNewline
Next
See also
GetRow method (Page 733)
GetRowCollection method (Page 734)
GetSelectedRow method (Page 740)
GetSelectedRows method (Page 741)
CellCount property (Page 362)
CellText property (Page 363)
RowNumber property (Page 554)
RulerBlock object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "Block" listing object to configure the blocks of WinCC RulerControl.
Use in the controls
● WinCC RulerControl (Page 266)
WinCC: Scripting (VBS, ANSI-C, VBA)
224 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "rulerblockobj.BlockName", the listing name "Block" is
dropped: "rulerblockobj.Name".
BlockAlign (Page 344) BlockHideText (Page 347) BlockPrecisions (Page 349)
BlockAutoPrecisions (Page 345) BlockHideTitleText (Page 347) BlockShowDate (Page 349)
BlockCaption (Page 345) BlockID BlockShowIcon (Page 349)
BlockCount (Page 345) BlockIndex (Page 348) BlockShowTitleIcon (Page 349)
BlockDateFormat (Page 345) BlockLength (Page 348) BlockTimeFormat (Page 350)
BlockExponentialFormat (Page 346) BlockName (Page 348) BlockUseSourceFormat (Page 350)
See also
GetRulerBlock method (Page 735)
GetRulerBlockCollection method (Page 736)
RulerColumn object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "Column" listing object to configure the columns of the ruler window in WinCC
RulerControl.
Use in the controls
● WinCC RulerControl (Page 266)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "rulercolobj.ColumnName", the listing name "Column" is
dropped: "rulercolobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
ColumnAdd (Page 382) ColumnName (Page 387) ColumnSort (Page 390)
ColumnCount (Page 383) ColumnRemove (Page 388) ColumnSortIndex (Page 391)
ColumnIndex (Page 386) ColumnRepos (Page 388) ColumnVisible (Page 393)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 225
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
GetRulerColumn method (Page 737)
GetRulerColumnCollection method (Page 738)
StatisticAreaColumn object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "Column" listing object to configure the columns of the statistic area window in WinCC
RulerControl.
Use in the controls
● WinCC RulerControl (Page 266)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "statareacolobj.ColumnName", the listing name "Column" is
dropped: "statareacolobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
ColumnAdd (Page 382) ColumnName (Page 387) ColumnSort (Page 390)
ColumnCount (Page 383) ColumnRemove (Page 388) ColumnSortIndex (Page 391)
ColumnIndex (Page 386) ColumnRepos (Page 388) ColumnVisible (Page 393)
See also
GetStatisticAreaColumn method (Page 743)
GetStatisticAreaColumnCollection method (Page 744)
StatisticResultColumn object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "Column" listing object to configure the columns of the statistic window in WinCC
RulerControl.
WinCC: Scripting (VBS, ANSI-C, VBA)
226 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Use in the controls
● WinCC RulerControl (Page 266)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "statrescolobj.ColumnName", the listing name "Column" is
dropped: "statrescolobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
ColumnAdd (Page 382) ColumnName (Page 387) ColumnSort (Page 390)
ColumnCount (Page 383) ColumnRemove (Page 388) ColumnSortIndex (Page 391)
ColumnIndex (Page 386) ColumnRepos (Page 388) ColumnVisible (Page 393)
See also
GetStatisticResultColumn method (Page 745)
GetStatisticResultColumnCollection method (Page 746)
StatusbarElement object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "StatusbarElement" listing object to configure the properties of the statusbar of the
controls.
Use in the controls
WinCC AlarmControl (Page 238) WinCC FunctionTrendControl WinCC OnlineTableControl (Page 254)
(Page 246)
WinCC OnlineTrendControl (Page 260) WinCC RulerControl (Page 266) WinCC UserArchiveControl (Page 274)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "statusbarobj.StatusbarElementName", the listing name
"StatusbarElement" is dropped: "statusbarobj.Name".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 227
VBS for Creating Procedures and Actions
1.14 VBS Reference
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
StatusbarElementAdd (Page 589) StatusbarElementIndex (Page 590) StatusbarElementText (Page 591)
StatusbarElementAutoSize (Page 589) StatusbarElementName (Page 590) StatusbarElementTooltipText
(Page 591)
StatusbarElementCount (Page 589) StatusbarElementRemove StatusbarElementUserDefined
(Page 590) (Page 592)
StatusbarElementIconId (Page 589) StatusbarElementRename StatusbarElementVisible (Page 591)
(Page 590)
StatusbarElementId (Page 589) StatusbarElementRepos (Page 591) StatusbarElementWidth (Page 592)
See also
GetStatusbarElement method (Page 747)
GetStatusbarElementCollection method (Page 748)
TimeAxis object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "TimeAxis" listing object to configure the properties of the time axis in columns in the
WinCC OnlineTrendControl.
Use in the controls
● WinCC OnlineTrendControl (Page 260)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "timeaxisobj.TimeAxisName", the listing name "TimeAxis" is
dropped: "timeaxisobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
TimeAxisActualize TimeAxisIndex (Page 607) TimeAxisRepos (Page 609)
TimeAxisAdd (Page 604) TimeAxisInTrendColor TimeAxisShowDate (Page 610)
TimeAxisAlign (Page 605) TimeAxisLabel (Page 608) TimeAxisTimeFormat (Page 610)
TimeAxisBeginTime (Page 605) TimeAxisMeasurePoints (Page 608) TimeAxisTimeRangeBase (Page 610)
TimeAxisColor (Page 605) TimeAxisName (Page 608) TimeAxisTimeRangeFactor (Page 611)
TimeAxisCount (Page 606) TimeAxisRangeType (Page 609) TimeAxisTrendWindow (Page 611)
WinCC: Scripting (VBS, ANSI-C, VBA)
228 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeAxisDateFormat (Page 606) TimeAxisRemove (Page 609) TimeAxisVisible (Page 611)
TimeAxisEndTime (Page 606) TimeAxisRename (Page 609)
See also
GetTimeAxis method (Page 749)
GetTimeAxisCollection method (Page 750)
TimeColumn object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "TimeColumn" listing object to configure the properties of the time column in WinCC
OnlineTrendControl.
Use in the controls
● WinCC OnlineTableControl (Page 254)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "timecolobj.TimeColumnName", the listing name
"TimeColumn" is dropped: "timecolobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
TimeColumnActualize (Page 612) TimeColumnHideText (Page 615) TimeColumnShowDate (Page 618)
TimeColumnAdd (Page 612) TimeColumnHideTitleText (Page 616) TimeColumnShowIcon (Page 618)
TimeColumnAlign (Page 613) TimeColumnIndex (Page 616) TimeColumnShowTitleIcon (Page 618)
TimeColumnBackColor (Page 613) TimeColumnLength (Page 616) TimeColumnSort (Page 619)
TimeColumnBeginTime (Page 614) TimeColumnMeasurePoints (Page 616) TimeColumnSortIndex (Page 619)
TimeColumnCaption (Page 614) TimeColumnName (Page 617) TimeColumnTimeFormat (Page 619)
TimeColumnCount (Page 614) TimeColumnRangeType (Page 617) TimeColumnTimeRangeBase
(Page 620)
TimeColumnDateFormat (Page 614) TimeColumnRemove (Page 617) TimeColumnTimeRangeFactor
(Page 620)
TimeColumnEndTime (Page 615) TimeColumnRename (Page 617) TimeColumnUseValueColumnColors
(Page 620)
TimeColumnForeColor (Page 615) TimeColumnRepos (Page 618) TimeColumnVisible (Page 620)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 229
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
GetTimeColumn method (Page 752)
GetTimeColumnCollection method (Page 753)
ToolbarButton object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "ToolbarButton" listing object to configure the properties of the toolbar of the controls.
Use in the controls
WinCC AlarmControl (Page 238) WinCC FunctionTrendControl WinCC OnlineTableControl (Page 254)
(Page 246)
WinCC OnlineTrendControl (Page 260) WinCC RulerControl (Page 266) WinCC UserArchiveControl (Page 274)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "toolbarobj.ToolbarButtonName", the listing name
"ToolbarButton" is dropped: "toolbarobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
ToolbarButtonActive (Page 632) ToolbarButtonId (Page 637) ToolbarButtonRename (Page 639)
ToolbarButtonAdd (Page 632) ToolbarButtonIndex (Page 637) ToolbarButtonRepos (Page 639)
ToolbarButtonBeginGroup (Page 632) ToolbarButtonLocked (Page 638) ToolbarButtonTooltipText (Page 640)
ToolbarButtonCount (Page 637) ToolbarButtonName (Page 638) ToolbarButtonUserDefined (Page 640)
ToolbarButtonEnabled (Page 637) ToolbarButtonPasswordLevel ToolbarButtonVisible (Page 640)
(Page 638)
ToolbarButtonHotKey (Page 637) ToolbarButtonRemove (Page 638)
See also
GetToolbarButton method (Page 754)
GetToolbarButtonCollection method (Page 755)
WinCC: Scripting (VBS, ANSI-C, VBA)
230 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Trend object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "Trend" listing object to configure the properties of the trends. The "InsertData" and
"RemoveData" methods are used to fill the trend with data or to delete the trend. The
"GetRulerData" method is used to access the data at a particular point of the trend.
Use in the controls
WinCC FunctionTrendControl (Page 246) WinCC OnlineTrendControl (Page 260)
Available methods of the object
GetRulerData (Page 739) InsertData (Page 771) RemoveData (Page 796)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "trendobj.Trendname", the listing name "Trend" is dropped:
"trendobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
Properties in WinCC FunctionTrendControl and WinCC OnlineTrendControl
TrendAdd (Page 647) TrendLineWidth (Page 652) TrendRemove (Page 656)
TrendColor (Page 649) TrendLowerLimit (Page 652) TrendRename (Page 656)
TrendCount (Page 649) TrendLowerLimitColor (Page 652) TrendRepos (Page 656)
TrendExtendedColorSet TrendLowerLimitColoring (Page 653) TrendTrendWindow (Page 659)
TrendFill (Page 650) TrendName (Page 653) TrendUncertainColor (Page 659)
TrendFillColor (Page 650) TrendPointColor (Page 653) TrendUncertainColoring (Page 660)
TrendIndex (Page 651) TrendPointStyle TrendUpperLimit (Page 660)
TrendLabel (Page 651) TrendPointWidth (Page 654) TrendUpperLimitColor (Page 660)
TrendLineStyle (Page 651) TrendProvider (Page 654) TrendUpperLimitColoring (Page 660)
TrendLineType (Page 651) TrendProviderCLSID (Page 655) TrendVisible (Page 662)
Properties in WinCC OnlineTrendControl
TrendAutoRangeBeginTagName TrendAutoRangeSource (Page 648) TrendValueAlignment (Page 661)
(Page 647)
TrendAutoRangeBeginValue TrendSelectTagName (Page 656) TrendValueAxis (Page 661)
(Page 647)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 231
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendAutoRangeEndTagName TrendTagName (Page 658) TrendValueUnit (Page 661)
(Page 648)
TrendAutoRangeEndValue (Page 648) TrendTimeAxis (Page 658)
Properties in the WinCC FunctionTrendControl
TrendActualize (Page 647) TrendSelectTagNameX (Page 657) TrendTimeRangeBase (Page 658)
TrendBeginTime (Page 648) TrendSelectTagNameY (Page 657) TrendTimeRangeFactor (Page 659)
TrendEndTime (Page 649) TrendTagNameX (Page 658) TrendXAxis (Page 668)
TrendMeasurePoints (Page 653) TrendTagNameY (Page 658) TrendYAxis (Page 668)
TrendRangeType
See also
GetTrend method (Page 756)
GetTrendCollection method (Page 757)
TrendWindow object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "TrendWindow" listing object to configure the properties of the trend window.
Use in the controls
WinCC FunctionTrendControl (Page 246) WinCC OnlineTrendControl (Page 260)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "trendwndobj.TrendWindowName", the listing name
"TrendWindow" is dropped: "trendwndobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
Properties in WinCC FunctionTrendControl and WinCC OnlineTrendControl
TrendWindowAdd (Page 662) TrendWindowGridInTrendColor TrendWindowRulerColor (Page 666)
(Page 664)
TrendWindowCoarseGrid (Page 662) TrendWindowHorizontalGrid TrendWindowRulerLayer
(Page 664)
TrendWindowCoarseGridColor TrendWindowIndex (Page 664) TrendWindowRulerStyle (Page 666)
(Page 663)
WinCC: Scripting (VBS, ANSI-C, VBA)
232 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendWindowCount (Page 663) TrendWindowName (Page 665) TrendWindowRulerWidth (Page 666)
TrendWindowFineGrid (Page 663) TrendWindowRemove (Page 665) TrendWindowSpacePortion (Page 667)
TrendWindowFineGridColor TrendWindowRename (Page 665) TrendWindowVerticalGrid (Page 668)
(Page 663)
TrendWindowForegroundTrendGrid TrendWindowRepos (Page 665) TrendWindowVisible (Page 668)
(Page 664)
Properties in WinCC OnlineTrendControl
TrendWindowStatisticRulerColor TrendWindowStatisticRulerStyle TrendWindowStatisticRulerWidth
(Page 667) (Page 667) (Page 667)
See also
GetTrendWindow method (Page 759)
GetTrendWindowCollection method (Page 760)
ValueAxis object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "ValueAxis" listing object to configure the properties of the value axis in WinCC
OnlineTrendControl.
Use in the controls
● WinCC OnlineTrendControl (Page 260)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "valueaxisobj.ValueAxisName", the listing name "ValueAxis"
is dropped: "valueaxisobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
ValueAxisAdd (Page 684) ValueAxisEndValue (Page 686) ValueAxisRemove (Page 689)
ValueAxisAlign (Page 684) ValueAxisExponentialFormat ValueAxisRename (Page 689)
(Page 686)
ValueAxisAutoPrecisions (Page 685) ValueAxisIndex (Page 687) ValueAxisRepos (Page 689)
ValueAxisAutoRange (Page 685) ValueAxisInTrendColor ValueAxisScalingType (Page 689)
ValueAxisBeginValue (Page 685) ValueAxisLabel (Page 688) ValueAxisTrendWindow (Page 690)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 233
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueAxisColor (Page 686) ValueAxisName (Page 688) ValueAxisVisible (Page 690)
ValueAxisCount (Page 686) ValueAxisPrecisions (Page 688)
See also
GetValueAxis method (Page 761)
GetValueAxisCollection method (Page 762)
ValueColumn object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "ValueColumn" listing object to configure the properties of the value column in WinCC
OnlineTrendControl.
Use in the controls
● WinCC OnlineTableControl (Page 254)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "valcolobj.ValueColumnName", the listing name
"ValueColumn" is dropped: "valcolobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
ValueColumnAdd (Page 690) ValueColumnHideTitleText (Page 693) ValueColumnRepos (Page 695)
ValueColumnAlign (Page 690) ValueColumnIndex (Page 693) ValueColumnSelectTagName
(Page 695)
ValueColumnAutoPrecisions ValueColumnLength (Page 693) ValueColumnShowIcon (Page 696)
(Page 691)
ValueColumnBackColor (Page 691) ValueColumnName (Page 694) ValueColumnShowTitleIcon (Page 696)
ValueColumnCaption (Page 692) ValueColumnPrecisions (Page 694) ValueColumnSort (Page 696)
ValueColumnCount (Page 692) ValueColumnProvider (Page 694) ValueColumnSortIndex (Page 697)
ValueColumnExponentialFormat ValueColumnProviderCLSID ValueColumnTagName (Page 697)
(Page 692) (Page 694)
ValueColumnForeColor (Page 692) ValueColumnRemove (Page 695) ValueColumnTimeColumn (Page 697)
ValueColumnHideText (Page 693) ValueColumnRename (Page 695) ValueColumnVisible (Page 697)
WinCC: Scripting (VBS, ANSI-C, VBA)
234 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
GetValueColumn method (Page 763)
GetValueColumnCollection method (Page 764)
XAxis object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "Xaxis" listing object to configure the properties of the X axis in WinCC
FunctionTrendControl.
Use in the controls
● WinCC FunctionTrendControl (Page 246)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "xaxisobj.XAxisName", the listing name "XAxis" is dropped:
"xaxisobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
XAxisAdd (Page 704) XAxisEndValue (Page 707) XAxisRemove (Page 708)
XAxisAlign XAxisExponentialFormat (Page 707) XAxisRename (Page 711)
XAxisAutoPrecisions (Page 705) XAxisIndex (Page 710) XAxisRepos (Page 709)
XAxisAutoRange (Page 706) XAxisInTrendColor XAxisScalingType (Page 709)
XAxisBeginValue (Page 706) XAxisLabel (Page 708) XAxisTrendWindow (Page 709)
XAxisColor (Page 706) XAxisName (Page 708) XAxisVisible (Page 710)
XAxisCount (Page 710) XAxisPrecisions (Page 708)
See also
GetXAxis method (Page 766)
GetXAxisCollection method (Page 767)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 235
VBS for Creating Procedures and Actions
1.14 VBS Reference
YAxis object (list)
Description
The listing of controls is a data container that can save a number of objects of the same type
(users can change the number).
Use the "Yaxis" listing object to configure the properties of the Y axis in WinCC
FunctionTrendControl.
Use in the controls
● WinCC FunctionTrendControl (Page 246)
Available properties of the object
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "yaxisobj.YAxisName", the listing name "YAxis" is dropped:
"yaxisobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
YAxisAdd (Page 704) YAxisEndValue (Page 707) YAxisRemove (Page 708)
YAxisAlign (Page 705) YAxisExponentialFormat (Page 707) YAxisRename (Page 711)
YAxisAutoPrecisions (Page 705) YAxisIndex (Page 711) YAxisRepos (Page 709)
YAxisAutoRange (Page 706) YAxisInTrendColor (Page 707) YAxisScalingType (Page 709)
YAxisBeginValue (Page 706) YAxisLabel (Page 708) YAxisTrendWindow (Page 709)
YAxisColor (Page 706) YAxisName (Page 708) YAxisVisible (Page 710)
YAxisCount (Page 711) YAxisPrecisions (Page 708)
See also
GetYAxis method (Page 768)
GetYAxisCollection method (Page 769)
WinCC: Scripting (VBS, ANSI-C, VBA)
236 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
HMI Symbol Library
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "HMI Symbol Library"
Type Identifier in VBS
HMISymbolLibrary
Usage
In the following example, the object with the name "Control1" is moved 20 pixels to the right:
'VBS64
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left +20
Properties
This object type has the following properties:
See also
Left Property (Page 477)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Controls (Page 216)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 237
VBS for Creating Procedures and Actions
1.14 VBS Reference
Top Property (Page 644)
Stretch Property (Page 594)
Picture Property (Page 537)
Parent Property (Page 529)
ObjectName Property (Page 513)
Object Property (Page 512)
Layer Object (Page 118)
Height Property (Page 444)
ForeColor Property (Page 435)
Flip Property (Page 429)
Enabled Property (Page 407)
Cursor Property (Page 394)
BlinkColor Property (Page 343)
BackStyle Property (Page 321)
BackColor Property (Page 318)
WinCC AlarmControl
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC AlarmControl" as
of WinCC V7.0.
Type Identifier in VBS
HMIAlarmControl
Available list objects
HitlistColumn (Page 220) Row (Page 223)
MessageBlock (Page 221) StatusbarElement (Page 227)
WinCC: Scripting (VBS, ANSI-C, VBA)
238 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
MessageColumn (Page 221) ToolbarButton (Page 230)
OperatorColumn (Page 222)
Methods Available in VBS
Activate ActivateDynamic AttachDB
CopyRows
DeactivateDynamic DetachDB
Export
GetHitlistColumn GetOperatorMessage GetStatusbarElement
GetHitlistColumnCollection GetOperatorMessageCollection GetStatusbarElementCollection
GetMessageBlock GetRow (Page 733) GetToolbarButton
GetMessageBlockCollection GetRowCollection (Page 734) GetToolbarButtonCollection
GetMessageColumn GetSelectedRow (Page 740)
GetMessageColumnCollection GetSelectedRows (Page 741)
HideAlarm LockAlarm
LoopInAlarm
MoveToFirstLine MoveToLastPage MoveToPreviousLine
MoveToFirstPage MoveToNextLine MoveToPreviousPage
MoveToLastLine MoveToNextPage
QuitHorn QuitSelected QuitVisible
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 239
VBS for Creating Procedures and Actions
1.14 VBS Reference
ShowComment ShowInfoText ShowSelectionDialog
ShowDisplayOptionsDialog ShowLockDialog ShowShortTermArchiveList
ShowEmergencyQuitDialog ShowLockList ShowSortDialog
ShowHelp ShowLongTermArchiveList ShowTimebaseDialog
ShowHideList ShowMessageList
ShowHitList ShowPropertyDialog
UnhideAlarm UnlockAlarm
Properties Available in VBS
If you access the properties with a listing object, you do not have to enter the name of the
listing. For example, when using "messagecol.MessageColumnName", the listing name
"MessageColumn" is dropped: "messagecol.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
Activate AutoCompleteColumns AutoSelectionColors
AllServer AutoCompleteRows AutoSelectionRectColor
ApplyProjectSettings AutoScroll
BackColor BorderColor BorderWidth
Caption CellSpaceRight ColumnTitleAlign
CellCut CellSpaceTop ColumnTitles
CellSpaceBottom Closeable
CellSpaceLeft ColumnResize
DefaultMsgFilterSQL DefaultSort2 DisplayOptions
DefaultSort DefaultSort2Column DoubleClickAction
ExportDirectoryChangeable ExportFilenameChangeable ExportSelection
ExportDirectoryname ExportFormatGuid ExportShowDialog
ExportFileExtension ExportFormatName ExportXML
ExportFilename ExportParameters
WinCC: Scripting (VBS, ANSI-C, VBA)
240 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Font
GridLineColor GridLineWidth
HitlistColumnAdd HitlistColumnRepos HitListMaxSourceItemsWarn
HitlistColumnAutoAdjust (Page 445) HitlistColumnSort HitListRelTime
HitlistColumnCount HitlistColumnSortIndex HitListRelTimeFactor
HitlistColumnIndex HitlistColumnVisible HitListRelTimeFactorType
HitlistColumnName HitListDefaultSort HorizontalGridLines
HitlistColumnRemove HitListMaxSourceItems
IconSpace
LineColor (Page 480) LineWidth (Page 482) LongTermArchiveConsistency
MessageBlockAlign MessageBlockLength MessageColumnIndex
MessageBlockAutoPrecisions MessageBlockPrecisions MessageColumnName
MessageBlockCaption MessageBlockSelected MessageColumnRemove
MessageBlockCount MessageBlockShowDate MessageColumnRepos
MessageBlockDateFormat MessageBlockShowIcon MessageColumnSort
MessageBlockExponentialFormat MessageBlockShowTitleIcon MessageColumnSortIndex
MessageBlockFlashOn MessageBlockTextId MessageColumnVisible
MessageBlockHideText MessageBlockType MessageListType
MessageBlockHideTitleText MessageColumnAdd Moveable
MessageBlockIndex MessageColumnAutoAdjust (Page 504) MsgFilterSQL
MessageBlockLeadingZeros MessageColumnCount
OperatorMessageID OperatorMessageSource5 OperatorMessageSourceType4
OperatorMessageIndex OperatorMessageSource6 OperatorMessageSourceType5
OperatorMessageName OperatorMessageSource7 OperatorMessageSourceType6
OperatorMessageNumber OperatorMessageSource8 OperatorMessageSourceType7
OperatorMessageSelected OperatorMessageSource9 OperatorMessageSourceType8
OperatorMessageSource1 OperatorMessageSource10 OperatorMessageSourceType9
OperatorMessageSource2 OperatorMessageSourceType1 OperatorMessageSourceType10
OperatorMessageSource3 OperatorMessageSourceType2
OperatorMessageSource4 OperatorMessageSourceType3
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 241
VBS for Creating Procedures and Actions
1.14 VBS Reference
PageMode PageModeMessageNumber PrintJobName
RowCellCount (Page 362) RowScrollbar RTPersistencePasswordLevel
RowCellText (Page 363) RowTitleAlign RTPersistenceType
RowCount (Page 382) RowTitles
RowNumber (Page 554) RTPersistence
SelectedCellColor SelectionRect ShowSortIndex
SelectedCellForeColor SelectionRectColor ShowTitle
SelectedRowColor SelectionRectWidth Sizeable
SelectedRowForeColor SelectionType SkinName
SelectedTitleColor ServerNames SortSequence
SelectedTitleForeColor ShowSortButton
SelectionColoring ShowSortIcon
StatusbarBackColor StatusbarElementName StatusbarElementVisible
StatusbarElementAdd StatusbarElementRemove StatusbarElementWidth
StatusbarElementAutoSize StatusbarElementRename StatusbarFontColor
StatusbarElementCount StatusbarElementRepos StatusbarShowTooltips
StatusbarElementIconId StatusbarElementText StatusbarText
StatusbarElementId StatusbarElementTooltipText StatusbarUseBackColor
StatusbarElementIndex StatusbarElementUserDefined StatusbarVisible
TableColor TitleColor TitleLightShadowColor
TableColor2 TitleCut TitleSort
TableForeColor TitleDarkShadowColor TitleStyle
TableForeColor2 TitleForeColor
TimeBase TitleGridLineColor
ToolbarAlignment ToolbarButtonHotKey ToolbarButtonRepos
ToolbarBackColor ToolbarButtonId ToolbarButtonTooltipText
ToolbarButtonActive ToolbarButtonIndex ToolbarButtonUserDefined
ToolbarButtonAdd ToolbarButtonLocked ToolbarButtonVisible
ToolbarButtonBeginGroup ToolbarButtonName ToolbarShowTooltips
ToolbarButtonClick ToolbarButtonPasswordLevel ToolbarUseBackColor
WinCC: Scripting (VBS, ANSI-C, VBA)
242 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ToolbarButtonCount ToolbarButtonRemove ToolbarUseHotKeys
ToolbarButtonEnabled ToolbarButtonRename ToolbarVisible
UseMessageColor UseSelectedTitleColor UseTableColor2
VerticalGridLines
Example
A selection of messages is defined in an existing WinCC AlarmControl. The column properties
are configured in the script.
Requirement
● A "WinCC AlarmControl" with the name "Control1" has already been inserted in a process
picture in Graphics Designer. The picture "C_015_Native_Alarms_Sel.pdl" from the demo
project was used for this example.
● A button is inserted in the Graphics Designer. You have configured the event "mouse click"
with a VBS action and the following script for the button.
● You have already configured messages in your project. Or you are using the demo project
from which we have taken the messages used for the example.
● Messages have already been triggered in Runtime. The buttons "incoming" and "outgoing"
were clicked in the demo project.
'VBS366
Sub OnClick(ByVal Item)
Dim objControl
Dim objMessColumn
Dim objMessBlock
Set objControl = ScreenItems("Control1")
objControl.ApplyProjectSettings = False
Set objMessBlock = objControl.GetMessageBlock("Date")
objMessBlock.DateFormat = "dd.MM.yy"
Set objMessColumn = objControl.GetMessageColumn("Time")
objMessColumn.Visible = False
objControl.MsgFilterSQL = "MSGNR >= 5 AND Priority = 0"
End Sub
Note
More examples for use of properties and methods are available in the descriptions of the Get
methods of the controls and under "Examples for VBScript/Examples in WinCC/Dynamizing
controls".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 243
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Controls (Page 216)
WinCC Digital/Analog Clock
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC Digital/Analog
Clock"
Type Identifier in VBS
HMIClock
Usage
In the following example, the object with the name "Control1" is moved 11 pixels to the right:
'VBS55
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left +11
See also
Parent Property (Page 529)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Controls (Page 216)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
WinCC: Scripting (VBS, ANSI-C, VBA)
244 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Top Property (Page 644)
Ticks Property (Page 603)
TicksColor Property (Page 603)
SquareExtent Property (Page 587)
SecondNeedleWidth Property (Page 564)
SecondNeedleHeight Property (Page 563)
Picture Property (Page 537)
ObjectName Property (Page 513)
Object Property (Page 512)
MinuteNeedleWidth Property (Page 508)
MinuteNeedleHeight Property (Page 508)
LocaleID Property (Page 483)
Left Property (Page 477)
Layer Object (Page 118)
HourNeedleWidth Property (Page 451)
HourNeedleHeight Property (Page 450)
Height Property (Page 444)
Handtype Property (Page 443)
HandFillColor Property (Page 443)
ForeColor Property (Page 435)
Font property (before WinCC V7) (Page 431)
FocusRect Property (Page 430)
Enabled Property (Page 407)
BackStyle Property (Page 321)
BackColor Property (Page 318)
Analog Property (Page 307)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 245
VBS for Creating Procedures and Actions
1.14 VBS Reference
WinCC FunctionTrendControl
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC
FunctionTrendControl" as of WinCC V7.0.
Type Identifier in VBS
HMIFunctionTrendControl
Available list objects
StatusbarElement (Page 227) Trend (Page 231) XAxis (Page 235)
ToolbarButton (Page 230) TrendWindow (Page 232) YAxis (Page 236)
Methods Available in VBS
Activate ActivateDynamic AttachDB
DeactivateDynamic DetachDB
Export
GetStatusbarElement GetTrend GetXAxis
GetStatusbarElementCollection GetTrendCollection GetXAxisCollection
GetToolbarButton GetTrendWindow GetYAxis
GetToolbarButtonCollection GetTrendWindowCollection GetYAxisCollection
MoveAxis
WinCC: Scripting (VBS, ANSI-C, VBA)
246 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
NextTrend
OneToOneView
PreviousTrend Print
ShowHelp ShowTagSelection ShowTrendSelection
ShowPropertyDialog ShowTimeSelection StartStopUpdate
ZoomArea ZoomInOutX ZoomMove
ZoomInOut ZoomInOutY
Properties Available in VBS
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "xaxisobj.XAxisName", the listing name "XAxis" is dropped:
"xaxisobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
BackColor BorderColor BorderWidth
Caption Closeable ConnectTrendWindows
ExportDirectoryChangeable ExportFilenameChangeable ExportShowDialog
ExportDirectoryname ExportFormatGuid ExportParameters
ExportFileExtension ExportFormatName ExportXML
ExportFilename ExportSelection
Font
GraphDirection
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 247
VBS for Creating Procedures and Actions
1.14 VBS Reference
LineColor LineWidth LoadDataImmediately
Moveable
Online
PrintJobName
RTPersistence RTPersistencePasswordLevel RTPersistenceType
ShowRuler ShowTitle SkinName
ShowRulerInAxis Sizeable
ShowScrollbars ShowTrendIcon
StatusbarBackColor StatusbarElementName StatusbarElementVisible
StatusbarElementAdd StatusbarElementRemove StatusbarElementWidth
StatusbarElementAutoSize StatusbarElementRename StatusbarFontColor
StatusbarElementCount StatusbarElementRepos StatusbarShowTooltips
StatusbarElementIconId StatusbarElementText StatusbarText
StatusbarElementId StatusbarElementTooltipText StatusbarUseBackColor
StatusbarElementIndex StatusbarElementUserDefined StatusbarVisible
TimeBase ToolbarButtonHotKey ToolbarButtonTooltipText
ToolbarAlignment ToolbarButtonId ToolbarButtonUserDefined
ToolbarBackColor ToolbarButtonIndex ToolbarButtonVisible
ToolbarButtonActive ToolbarButtonLocked ToolbarShowTooltips
ToolbarButtonAdd ToolbarButtonName ToolbarUseBackColor
ToolbarButtonBeginGroup ToolbarButtonPasswordLevel ToolbarUseHotKeys
ToolbarButtonClick ToolbarButtonRemove ToolbarVisible
ToolbarButtonCount ToolbarButtonRename
ToolbarButtonEnabled ToolbarButtonRepos
TrendActualize TrendLowerLimit TrendSelectTagNameX
TrendAdd TrendLowerLimitColor TrendSelectTagNameY
WinCC: Scripting (VBS, ANSI-C, VBA)
248 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendBeginTime TrendLowerLimitColoring TrendTagNameX
TrendColor TrendMeasurePoints TrendTagNameY
TrendCount TrendName TrendTimeRangeBase
TrendEndTime TrendPointColor (Page 653) TrendTimeRangeFactor
TrendExtendedColorSet TrendPointStyle TrendTrendWindow
TrendFill TrendPointWidth TrendUncertainColor
TrendFillColor TrendProvider TrendUncertainColoring
TrendIndex TrendProviderCLSID TrendUpperLimit
TrendLabel TrendRangeType TrendUpperLimitColor
TrendLineStyle TrendRemove TrendUpperLimitColoring
TrendLineType TrendRename TrendVisible
TrendLineWidth TrendRepos
TrendWindowAdd TrendWindowHorizontalGrid TrendWindowRulerStyle
TrendWindowCoarseGrid TrendWindowIndex TrendWindowRulerWidth
TrendWindowCount TrendWindowName TrendWindowSpacePortion
TrendWindowCoarseGridColor TrendWindowRemove TrendWindowVerticalGrid
TrendWindowFineGrid TrendWindowRename TrendWindowVisible
TrendWindowFineGridColor TrendWindowRepos TrendXAxis
TrendWindowForegroundTrendGrid TrendWindowRulerColor TrendYAxis
TrendWindowGridInTrendColor TrendWindowRulerLayer
UseTrendNameAsLabel
XAxisAdd XAxisEndValue XAxisRemove
XAxisAlign XAxisExponentialFormat XAxisRename / YAxisRename
XAxisAutoPrecisions XAxisIndex / YAxisIndex XAxisRepos
XAxisAutoRange XAxisInTrendColor XAxisScalingType
XAxisBeginValue XAxisLabel XAxisTrendWindow
XAxisColor XAxisName XAxisVisible
XAxisCount / YAxisCount XAxisPrecisions
Examples
A trend is displayed in a WinCC FunctionTrendControl that is linked with a user archive.
Different properties are configured for the trend in the script. The "StartID" of the user archive
and the number of measurement points is changed regarding data connection.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 249
VBS for Creating Procedures and Actions
1.14 VBS Reference
Requirement
● A "WinCC FunctionTrendControl" with the name "Control1" is inserted in a process picture
in Graphics Designer.
● A button is inserted in the Graphics Designer. You have configured the event "mouse click"
with a VBS action and the following script for the button.
● You have already configured a user archive in your project. Or you are using the demo
project from which we have taken the user archive for the example.
'VBS363
Sub OnClick(ByVal Item)
Dim objFXControl
Dim objTrendWindow
Dim objTrend
Dim objXAxis
Dim objYAxis
Dim startID
Dim FXServerDataX(3)
Dim FXServerDataY(3)
' create reference to FXControl
Set objFXControl = ScreenItems("Control1")
' create reference to new window, x and y axis
Set objTrendWindow = objFXControl.GetTrendWindowCollection.AddItem("myWindow")
Set objXAxis = objFXControl.GetXAxisCollection.AddItem("myXAxis")
Set objYAxis = objFXControl.GetYAxisCollection.AddItem("myYAxis")
' assign x and y axis to the window
objXAxis.TrendWindow = objTrendWindow.Name
objYAxis.TrendWindow = objTrendWindow.Name
' add new trend
Set objTrend = objFXControl.GetTrendCollection.AddItem("myTrend1")
' configure trend data connection (UserArchive)
objTrend.Provider = 3
startID = CLng(4)
FXServerDataX(0) = "Setpoint"
FXServerDataX(1) = "ParabelX"
FXServerDataX(3) = startID
FXServerDataY(0) = "Setpoint"
FXServerDataY(1) = "ParabelY"
FXServerDataY(3) = startID
objTrend.MeasurePoints = 50
objTrend.SetTagName "Setpoint\ParabelX", "Setpoint\ParabelY", FXServerDataX, FXServerDataY
' assign trend properties
objTrend.Color = RGB(255,0,0)
objTrend.PointStyle = 1
objTrend.TrendWindow = objTrendWindow.Name
objTrend.XAxis = objXAxis.Name
objTrend.YAxis = objYAxis.Name
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
250 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Note
More examples for use of properties and methods are available in the descriptions of the Get
methods of the controls and under "Examples for VBScript/Examples in WinCC/Dynamizing
controls".
See also
Controls (Page 216)
ServerDataX (Page 570)
ServerDataY (Page 570)
WinCC Gauge Control
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC Gauge Control"
Type Identifier in VBS
HMIGauge
Usage
In the following example, the object with the name "Control1" is moved 14 pixels to the right:
'VBS58
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left +14
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 251
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WarningColor Property (Page 700)
Object Property (Page 512)
BackColor Property (Page 318)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Object types of the ScreenItem object (Page 141)
Width Property (Page 701)
Warning Property (Page 700)
Visible Property (Page 699)
ValueMin Property (Page 698)
ValueMax Property (Page 698)
ValueColumnAlignment Property (Page 691)
UnitText Property (Page 674)
UnitOffset Property (Page 674)
UnitFont Property (Page 674)
UnitColor Property (Page 673)
Type Property (Page 669)
Top Property (Page 644)
TicWidth Property (Page 602)
TicTextOffset Property (Page 602)
TicTextColor Property (Page 602)
TicOffset Property (Page 601)
TicFont Property (Page 601)
TicColor Property (Page 601)
ShowWarning Property (Page 579)
ShowPeak Property (Page 574)
ShowNormal Property (Page 574)
ShowDecimalPoint Property (Page 573)
ShowDanger Property (Page 573)
Rectangular Property (Page 549)
Parent Property (Page 529)
ObjectName Property (Page 513)
WinCC: Scripting (VBS, ANSI-C, VBA)
252 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
NormalColor Property (Page 511)
NeedleColor Property (Page 511)
LocaleID Property (Page 483)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
FrameScale Property (Page 437)
FramePicture Property (Page 437)
FrameColor Property (Page 436)
Enabled Property (Page 407)
Delta Property (Page 401)
DangerColor Property (Page 396)
CenterScale Property (Page 364)
CenterColor Property (Page 364)
CaptionOffset Property (Page 361)
CaptionFont Property (Page 361)
Caption Property (Page 360)
CaptionColor Property (Page 361)
BorderWidth Property (Page 353)
BevelWidth Property (Page 343)
BevelOuter Property (Page 342)
BevelInner Property (Page 342)
BackStyle Property (Page 321)
BackgroundPicture Property (Page 321)
AngleMin Property (Page 308)
AngleMax Property (Page 308)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 253
VBS for Creating Procedures and Actions
1.14 VBS Reference
WinCC Media Control
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the "WinCC Media Control" graphic object as
of WinCC V7.0.
Object Type of ScreenItem Object. Represents the "WinCC Media Control" graphic object as
of WinCC V7.0.
Type Identifier in VBS
HMIMediaControl
Usage
In the following example, the object with the name "Control1" is moved 16 pixels to the right:
'VBS60
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left 16
WinCC OnlineTableControl
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC
OnlineTableControl" as of WinCC V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
254 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Type Identifier in VBS
HMIOnlineTableControl
Available list objects
Row (Page 223) ToolbarButton (Page 230)
StatusbarElement (Page 227) ValueColumn (Page 234)
TimeColumn (Page 229)
Methods Available in VBS
Activate ActivateDynamic AttachDB
CalculateStatistic CopyRows
DeactivateDynamic DetachDB
Edit Export
GetRow (Page 733) GetStatusbarElement GetToolbarButton
GetRowCollection (Page 734) GetStatusbarElementCollection GetToolbarButtonCollection
GetSelectedRow (Page 740) GetTimeColumn GetValueColumn
GetSelectedRows (Page 741) GetTimeColumnCollection GetValueColumnCollection
MoveToFirst MoveToNext MoveToPrevious
MoveToLast
NextColumn
PreviousColumn Print
SelectedStatisticArea ShowPropertyDialog ShowTimeSelection
ShowColumnSelection ShowTagSelection StartStopUpdate
ShowHelp
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 255
VBS for Creating Procedures and Actions
1.14 VBS Reference
Properties Available in VBS
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "timecolobj.TimeColumnName", the listing name
"TimeColumn" is dropped: "timecolobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
AutoCompleteColumns AutoSelectionColors AutoSelectionRectColor
AutoCompleteRows
BackColor BorderColor BorderWidth
Caption CellSpaceRight ColumnScrollbar
CellCut CellSpaceTop ColumnTitleAlign
CellSpaceBottom Closeable ColumnTitles
CellSpaceLeft ColumnResize
EnableEdit ExportFilename ExportParameters
ExportDirectoryChangeable ExportFilenameChangeable ExportSelection
ExportDirectoryname ExportFormatGuid ExportShowDialog
ExportFileExtension ExportFormatName ExportXML
Font
GridLineColor GridLineWidth
HorizontalGridLines
IconSpace
LineColor LineWidth LoadDataImmediately
Moveable
WinCC: Scripting (VBS, ANSI-C, VBA)
256 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Online
PrintJobName
RowCellCount (Page 362) RowScrollbar RTPersistence
RowCellText (Page 363) RowTitleAlign RTPersistencePasswordLevel
RowCount (Page 382) RowTitles RTPersistenceType
RowNumber (Page 554)
SelectedCellColor SelectionColoring ShowSortIcon
SelectedCellForeColor SelectionRect ShowSortIndex
SelectedRowColor SelectionRectColor ShowTitle
SelectedRowForeColor SelectionRectWidth Sizeable
SelectedTitleColor SelectionType SkinName
SelectedTitleForeColor ShowSortButton SortSequence
StatusbarBackColor StatusbarElementName StatusbarElementVisible
StatusbarElementAdd StatusbarElementRemove StatusbarElementWidth
StatusbarElementAutoSize StatusbarElementRename StatusbarFontColor
StatusbarElementCount StatusbarElementRepos StatusbarShowTooltips
StatusbarElementIconId StatusbarElementText StatusbarText
StatusbarElementId StatusbarElementTooltipText StatusbarUseBackColor
StatusbarElementIndex StatusbarElementUserDefined StatusbarVisible
TableColor TableForeColor TimeBase
TableColor2 TableForeColor2
TimeColumnActualize TimeColumnHideText TimeColumnShowDate
TimeColumnAdd TimeColumnHideTitleText TimeColumnShowIcon
TimeColumnAlign TimeColumnIndex TimeColumnShowTitleIcon
TimeColumnBackColor TimeColumnLength TimeColumnSort
TimeColumnBeginTime TimeColumnMeasurePoints TimeColumnSortIndex
TimeColumnCaption TimeColumnName TimeColumnTimeFormat
TimeColumnCount TimeColumnRangeType TimeColumnTimeRangeBase
TimeColumnDateFormat TimeColumnRemove TimeColumnTimeRangeFactor
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 257
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeColumnEndTime TimeColumnRename TimeColumnUseValueColumnColors
TimeColumnForeColor TimeColumnRepos TimeColumnVisible
TimeStepBase TitleDarkShadowColor TitleLightShadowColor
TimeStepFactor TitleForeColor TitleSort
TitleColor TitleGridLineColor TitleStyle
TitleCut
ToolbarAlignment ToolbarButtonHotKey ToolbarButtonRepos
ToolbarBackColor ToolbarButtonId ToolbarButtonTooltipText
ToolbarButtonActive ToolbarButtonIndex ToolbarButtonUserDefined
ToolbarButtonAdd ToolbarButtonLocked ToolbarButtonVisible
ToolbarButtonBeginGroup ToolbarButtonName ToolbarShowTooltips
ToolbarButtonClick ToolbarButtonPasswordLevel ToolbarUseBackColor
ToolbarButtonCount ToolbarButtonRemove ToolbarUseHotKeys
ToolbarButtonEnabled ToolbarButtonRename ToolbarVisible
UseColumnBackColor UseSelectedTitleColor UseTableColor2
UseColumnForeColor
ValueColumnAdd ValueColumnIndex ValueColumnShowIcon
ValueColumnAlign ValueColumnLength ValueColumnShowTitleIcon
ValueColumnAutoPrecisions ValueColumnName ValueColumnSort
ValueColumnBackColor ValueColumnPrecisions ValueColumnSortIndex
ValueColumnCaption ValueColumnProvider ValueColumnState
ValueColumnCount ValueColumnProviderCLSID ValueColumnTagName
ValueColumnExponentialFormat ValueColumnRemove ValueColumnTimeColumn
ValueColumnForeColor ValueColumnRename ValueColumnVisible
ValueColumnHideText ValueColumnRepos VerticalGridLines
ValueColumnHideTitleText ValueColumnSelectTagName
Example
An additional column is added in an existing WinCC OnlineTableControl that is linked with an
archive tag. Different properties are configured for the control and the column in the script.
WinCC: Scripting (VBS, ANSI-C, VBA)
258 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Requirement
● A "WinCC OnlineTableControl" with the name "Control1" has already been inserted in a
process picture in Graphics Designer. The control consists of a time column and three value
columns. The picture "B_025_V7_Arch_TableControl.PDL" from the demo project was used
for this example.
● A button is inserted in the Graphics Designer. You have configured the event "mouse click"
with a VBS action and the following script for the button.
● You have already configured archives and archive tags in your project. Or you are using
the demo project from which we have taken the archive for the example.
‘VBS362
Sub OnClick(ByVal Item)
Dim objControl
Dim objTimeColumn
Dim objValueColumn
Set objControl = ScreenItems("Control1")
' Control wide specification
objControl.ColumnResize = False
objControl.TimeBase = 1
objControl.TimeColumnTimeFormat = "HH:mm:ss tt"
objControl.TimeColumnLength = 20
' properties for Time column
Set objTimeColumn = objControl.GetTimeColumn("Time column 1")
objTimeColumn.DateFormat = "dd/MM/yy"
' properties for a new 4th value column with connection to archive tag "Trend_4"
Set objValueColumn = objControl.GetValueColumnCollection.AddItem("Trend 4")
objValueColumn.Caption = "Trend 4"
objValueColumn.Length = 10
objValueColumn.Align = 1
objValueColumn.Provider = 1
objValueColumn.TagName = "G_Archive\Trend_4"
objValueColumn.TimeColumn = "Time column 1"
End Sub
Note
More examples for use of properties and methods are available in the descriptions of the Get
methods of the controls and under "Examples for VBScript/Examples in WinCC/Dynamizing
controls".
See also
Controls (Page 216)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 259
VBS for Creating Procedures and Actions
1.14 VBS Reference
WinCC OnlineTrendControl
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC
OnlineTrendControl" as of WinCC V7.0.
Type Identifier in VBS
HMIOnlineTrendControl
Available list objects
StatusbarElement (Page 227) ToolbarButton (Page 230) TrendWindow (Page 232)
TimeAxis (Page 228) Trend (Page 231) ValueAxis (Page 233)
Methods Available in VBS
Activate ActivateDynamic-Methode AttachDB-Methode
CalculateStatistic
DeactivateDynamic DetachDB
Export
GetStatusbarElement GetToolbarButton (Page 754) GetTrendWindow
GetStatusbarElementCollection GetToolbarButtonCollection (Page 755) GetTrendWindowCollection
GetTimeAxis GetTrend GetValueAxis
GetTimeAxisCollection GetTrendCollection GetValueAxisCollection
WinCC: Scripting (VBS, ANSI-C, VBA)
260 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
MoveAxis MoveToLast MoveToPrevious
MoveToFirst MoveToNext
NextTrend
OneToOneView
PreviousTrend Print
ShowHelp ShowTagSelection StartStopUpdate
ShowPercentageAxis ShowTimeSelection
ShowPropertyDialog ShowTrendSelection
ZoomArea ZoomInOutTime ZoomMove
ZoomInOut ZoomInOutValues
Properties Available in VBS
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "trendobj.Trendname", the listing name "Trend" is dropped:
"trendobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
BackColor BorderColor BorderWidth
Caption Closeable ConnectTrendWindows
ExportDirectoryChangeable ExportFilenameChangeable ExportSelection
ExportDirectoryname ExportFormatGuid ExportShowDialog
ExportFileExtension ExportFormatName ExportXML
ExportFilename ExportParameters
Font
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 261
VBS for Creating Procedures and Actions
1.14 VBS Reference
GraphDirection
LineColor LineWidth LoadDataImmediately
Moveable
Online
PercentageAxis PercentageAxisColor PrintJobName
PercentageAxisAlign
RTPersistence RTPersistencePasswordLevel RTPersistenceType
ShowRuler ShowStatisticRuler Sizeable
ShowRulerInAxis ShowTitle SkinName
ShowScrollbars ShowTrendIcon
StatusbarBackColor StatusbarElementName StatusbarElementVisible
StatusbarElementAdd StatusbarElementRemove StatusbarElementWidth
StatusbarElementAutoSize StatusbarElementRename StatusbarFontColor
StatusbarElementCount StatusbarElementRepos StatusbarShowTooltips
StatusbarElementIconId StatusbarElementText StatusbarText
StatusbarElementId StatusbarElementTooltipText StatusbarUseBackColor
StatusbarElementIndex StatusbarElementUserDefined StatusbarVisible
TimeAxisActualize TimeAxisIndex TimeAxisRepos
TimeAxisAdd TimeAxisInTrendColor TimeAxisShowDate
TimeAxisAlign TimeAxisLabel TimeAxisTimeFormat
TimeAxisBeginTime TimeAxisMeasurePoints TimeAxisTimeRangeBase
TimeAxisColor TimeAxisName TimeAxisTimeRangeFactor
TimeAxisCount TimeAxisRangeType TimeAxisTrendWindow
TimeAxisDateFormat TimeAxisRemove TimeAxisVisible
TimeAxisEndTime TimeAxisRename TimeBase
WinCC: Scripting (VBS, ANSI-C, VBA)
262 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ToolbarAlignment ToolbarButtonHotKey ToolbarButtonRepos
ToolbarBackColor ToolbarButtonId ToolbarButtonTooltipText
ToolbarButtonActive ToolbarButtonIndex ToolbarButtonUserDefined
ToolbarButtonAdd ToolbarButtonLocked ToolbarButtonVisible
ToolbarButtonBeginGroup ToolbarButtonName ToolbarShowTooltips
ToolbarButtonClick ToolbarButtonPasswordLevel ToolbarUseBackColor
ToolbarButtonCount ToolbarButtonRemove ToolbarUseHotKeys
ToolbarButtonEnabled ToolbarButtonRename ToolbarVisible
TrendAdd TrendLineType TrendSelectTagName
TrendAutoRangeBeginTagName TrendLineWidth TrendTagName
TrendAutoRangeBeginValue TrendLowerLimit TrendTimeAxis
TrendAutoRangeEndTagName TrendLowerLimitColor TrendTrendWindow
TrendAutoRangeEndValue TrendLowerLimitColoring TrendUncertainColor
TrendAutoRangeSource TrendName TrendUncertainColoring
TrendColor TrendPointColor (Page 653) TrendUpperLimit
TrendCount TrendPointStyle TrendUpperLimitColor
TrendExtendedColorSet TrendPointWidth TrendUpperLimitColoring
TrendFill TrendProvider TrendValueAlignment (Page 661)
TrendFillColor TrendProviderCLSID TrendValueAxis
TrendIndex TrendRemove TrendValueUnit (Page 661)
TrendLabel TrendRename TrendVisible
TrendLineStyle TrendRepos
TrendWindowAdd TrendWindowHorizontalGrid TrendWindowRulerStyle
TrendWindowCoarseGrid TrendWindowIndex TrendWindowRulerWidth
TrendWindowCoarseGridColor TrendWindowName TrendWindowSpacePortion
TrendWindowCount TrendWindowRemove TrendWindowStatisticRulerColor
TrendWindowFineGrid TrendWindowRename TrendWindowStatisticRulerStyle
TrendWindowFineGridColor TrendWindowRepos TrendWindowStatisticRulerWidth
TrendWindowForegroundTrendGrid TrendWindowRulerColor TrendWindowVerticalGrid
TrendWindowGridInTrendColor TrendWindowRulerLayer TrendWindowVisible
UseTrendNameAsLabel
ValueAxisAdd ValueAxisEndValue ValueAxisRemove
ValueAxisAlign ValueAxisExponentialFormat ValueAxisRename
ValueAxisAutoPrecisions ValueAxisIndex ValueAxisRepos
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 263
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueAxisAutoRange ValueAxisInTrendColor ValueAxisScalingType
ValueAxisBeginValue ValueAxisLabel ValueAxisTrendWindow
ValueAxisColor ValueAxisName ValueAxisVisible
ValueAxisCount ValueAxisPrecisions
Example
Three trends are displayed in a WinCC OnlineTrendControl that are linked with archive tags.
Different properties are configured for the trends in the script.
Requirement
● A "WinCC OnlineTrendControl" with the name "Control1" is inserted in a process picture
in Graphics Designer.
● A button is inserted in the Graphics Designer. You have configured the event "mouse click"
with a VBS action and the following script for the button.
● You have already configured archives and archive tags in your project. Or you are using
the demo project from which we have taken the archives for the example.
WinCC: Scripting (VBS, ANSI-C, VBA)
264 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
'VBS361
Sub OnClick(ByVal Item)
Dim objTrendControl
Dim objTrendWindow
Dim objTimeAxis
Dim objValueAxis
Dim objTrend
'create reference to TrendControl
Set objTrendControl = ScreenItems("Control1")
'create reference to new window, time and value axis
Set objTrendWindow = objTrendControl.GetTrendWindowCollection.AddItem("myWindow")
Set objTimeAxis = objTrendControl.GetTimeAxisCollection.AddItem("myTimeAxis")
Set objValueAxis = objTrendControl.GetValueAxisCollection.AddItem("myValueAxis")
'assign time and value axis to the window
objTimeAxis.TrendWindow = objTrendWindow.Name
objValueAxis.TrendWindow = objTrendWindow.Name
' assign properties to trendwindow
objTrendWindow.HorizontalGrid = False
' add new trend and assign properties
Set objTrend = objTrendControl.GetTrendCollection.AddItem("myTrend1")
objTrend.Provider = 1
objTrend.TagName = "G_Archive\Trend_1"
objTrend.TrendWindow = objTrendWindow.Name
objTrend.TimeAxis = objTimeAxis.Name
objTrend.ValueAxis = objValueAxis.Name
objTrend.Color = RGB(255,0,0)
objTrend.PointStyle = 0
'add new trend and assign properties
Set objTrend = objTrendControl.GetTrendCollection.AddItem("myTrend2")
objTrend.Provider = 1
objTrend.TagName = "G_Archive\Trend_2"
objTrend.TrendWindow = objTrendWindow.Name
objTrend.TimeAxis = objTimeAxis.Name
objTrend.ValueAxis = objValueAxis.Name
objTrend.Color = RGB(0,255,0)
objTrend.LineWidth = 3
'add new trend and assign properties
Set objTrend = objTrendControl.GetTrendCollection.AddItem("myTrend3")
objTrend.Provider = 1
objTrend.TagName = "G_Archive\Trend_3"
objTrend.TrendWindow = objTrendWindow.Name
objTrend.TimeAxis = objTimeAxis.Name
objTrend.ValueAxis = objValueAxis.Name
objTrend.Color = RGB(0,0,255)
objTrend.LineType = 2
End Sub
Note
More examples for use of properties and methods are available in the descriptions of the Get
methods of the controls and under "Examples for VBScript/Examples in WinCC/Dynamizing
controls".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 265
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Controls (Page 216)
WinCC RulerControl
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC RulerControl" as
of WinCC V7.0.
Type Identifier in VBS
HMIRulerControl
Available list objects
Row (Page 223) StatisticResultColumn (Page 226)
RulerBlock (Page 224) StatusbarElement (Page 227)
RulerColumn (Page 225) ToolbarButton (Page 230)
StatisticAreaColumn (Page 226)
Methods Available in VBS
Activate ActivateDynamic
DeactivateDynamic
Export
GetRow (Page 733) GetSelectedRow (Page 740) GetStatusbarElement
GetRowCollection (Page 734) GetSelectedRows (Page 741) GetStatusbarElementCollection
GetRulerBlock GetStatisticAreaColumn GetToolbarButton
WinCC: Scripting (VBS, ANSI-C, VBA)
266 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetRulerBlockCollection GetStatisticAreaColumnCollection GetToolbarButtonCollection
GetRulerColumn GetStatisticResultColumn
GetRulerColumnCollection GetStatisticResultColumnCollection
ShowHelp ShowPropertyDialog
Properties Available in VBS
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "rulercolobj.ColumnName", the listing name "Column" is
dropped: "rulercolobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
AutoCompleteColumns AutoPositon AutoSelectionRectColor
AutoCompleteRows AutoSelectionColors AutoShow
BackColor BlockHideText BlockShowDate
BlockAlign BlockHideTitleText BlockShowIcon
BlockAutoPrecisions BlockID BlockShowTitleIcon
BlockCaption BlockIndex BlockTimeFormat
BlockCount BlockLength BlockUseSourceFormat
BlockDateFormat BlockName BorderColor
BlockExponentialFormat BlockPrecisions BorderWidth
Caption ColumnAdd ColumnScrollbar
CellCut ColumnCount ColumnSort
CellSpaceBottom ColumnIndex ColumnSortIndex
CellSpaceLeft ColumnName ColumnTitleAlign
CellSpaceRight ColumnRemove ColumnTitles
CellSpaceTop ColumnRepos ColumnVisible
Closeable ColumnResize
ExportDirectoryChangeable ExportFilenameChangeable ExportSelection
ExportDirectoryname ExportFormatGuid ExportShowDialog
ExportFileExtension ExportFormatName ExportXML
ExportFilename ExportParameters
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 267
VBS for Creating Procedures and Actions
1.14 VBS Reference
Font
GridLineColor GridLineWidth
HorizontalGridLines
IconSpace
LineColor LineWidth
Moveable
PrintJobName
RowCellCount (Page 362) RowScrollbar RTPersistencePasswordLevel
RowCellText (Page 363) RowTitleAlign RTPersistenceType
RowCount (Page 382) RowTitles RulerType
RowNumber (Page 554) RTPersistence
SelectedCellColor SelectionRect ShowSortIndex
SelectedCellForeColor SelectionRectColor ShowTitle
SelectedRowColor SelectionRectWidth Sizeable
SelectedRowForeColor SelectionType SkinName
SelectedTitleColor ShareSpaceWithSourceControl SortSequence
SelectedTitleForeColor ShowSortButton SourceControl
SelectionColoring ShowSortIcon SourceControlType
StatusbarBackColor StatusbarElementName StatusbarElementVisible
StatusbarElementAdd StatusbarElementRemove StatusbarElementWidth
StatusbarElementAutoSize StatusbarElementRename StatusbarFontColor
StatusbarElementCount StatusbarElementRepos StatusbarShowTooltips
StatusbarElementIconId StatusbarElementText StatusbarText
WinCC: Scripting (VBS, ANSI-C, VBA)
268 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
StatusbarElementId StatusbarElementTooltipText StatusbarUseBackColor
StatusbarElementIndex StatusbarElementUserDefined StatusbarVisible
TableColor TitleColor TitleGridLineColor
TableColor2 TitleCut TitleLightShadowColor
TableForeColor TitleDarkShadowColor TitleSort
TableForeColor2 TitleForeColor TitleStyle
ToolbarAlignment ToolbarButtonHotKey ToolbarButtonRepos
ToolbarBackColor ToolbarButtonId ToolbarButtonTooltipText
ToolbarButtonActive ToolbarButtonIndex ToolbarButtonUserDefined
ToolbarButtonAdd ToolbarButtonLocked ToolbarButtonVisible
ToolbarButtonBeginGroup ToolbarButtonName ToolbarShowTooltips
ToolbarButtonClick ToolbarButtonPasswordLevel ToolbarUseBackColor
ToolbarButtonCount ToolbarButtonRemove ToolbarUseHotKeys
ToolbarButtonEnabled ToolbarButtonRename ToolbarVisible
UseSelectedTitleColor UseSourceForeColors UseTableColor2
UseSourceBackColors
VerticalGridLines
Example
A WinCC Ruler Control is inserted in a picture with an existing WinCC OnlineTableControl.
The RulerControl contains a statistics window that displays the "Minimum", "Maximum" and
"Average" columns. The static values are then displayed for the selected rows of the
OnlineTableControl.
Requirement
● A "WinCC OnlineTableControl" with the name "Control1" has already been inserted in a
process picture in Graphics Designer. The control is linked with archive tags or process
tags. The picture "B_025_V7_Arch_TableControl.PDL" from the demo project was used for
this example.
● You have added an additional "WinCC RulerControl" with the name "Control2" in the picture.
● A button is inserted in the Graphics Designer. You have configured the event "mouse click"
with a VBS action and the following script for the button.
● You have selected some rows in OnlineTableControl.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 269
VBS for Creating Procedures and Actions
1.14 VBS Reference
'VBS364
Sub OnClick(ByVal Item)
Dim objRulerControl
Dim objTableControl
Dim objstatColumn
Dim rows
Set objRulerControl = ScreenItems("Control2")
' Use Statistic-window
objRulerControl.RulerType = 2
objRulerControl.SourceControl = "Control1"
' In Statistic-window only columns "Name", "MinValue", MaxValue" and "Average" are shown
Set objstatColumn = objRulerControl.GetStatisticResultColumnCollection
objstatColumn.RemoveItem(4)
objstatColumn.RemoveItem(5)
objstatColumn.RemoveItem(6)
' Get the selected rows of tablecontrol and calculate statistic
Set objTrendControl = ScreenItems("Control1")
Set rows = objTableControl.SelectAll
objTableControl.CalculateStatistic
End Sub
Note
More examples for use of properties and methods are available in the descriptions of the Get
methods of the controls and under "Examples for VBScript/Examples in WinCC/Dynamizing
controls".
See also
Controls (Page 216)
WinCC Slider Control
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC Slider Control"
WinCC: Scripting (VBS, ANSI-C, VBA)
270 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Type Identifier in VBS
HMISlider
Usage
In the following example, the object with the name "Control1" is moved 19 pixels to the right:
'VBS63
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left +19
Notes on Error Handling
Sliders and WinCC slider controls are mapped in the object model to an "HMISlider" type.
Since the objects have different properties, the availability of the property (dynamic type
compilation in Runtime) should be queried via an exception measure. The exception measure
is activated for the corresponding procedure by the following instruction:
On Error Resume Next
The instruction causes the VBScript engine to initiate the follow-on command in the case of a
Runtime error.
The error code can subsequently be checked using the Err object. In order to deactivate the
handling of Runtime errors in scripts, use the following command:
On Error Goto 0
Handling errors always relates to the procedure layer. If a script in a procedure causes an
error, VBScript checks whether an error handling measure is implemented in this layer. If not,
control is transferred one layer up (to the calling procedure). If there is no error handling
measure here either, the control is transferred yet another layer up. This continues until either
the top module level is reached or the code for Runtime error handling is located. If the
activation of the Runtime error handling fails, the control is transferred to the top level on the
internal VBScript Runtime error handing. This opens an error dialog and stops the script.
The "On Error Resume Next" command can be installed on all layers (i.e. also in procedures).
When the error handling measure is use, it can basically be determined whether the user is
actually using the required implementation type.
In addition, it can be ensured that there is no termination of execution due to a faulty access
to the object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 271
VBS for Creating Procedures and Actions
1.14 VBS Reference
Examples of error handling
Sub OnClick(Byval Item)
'VBS193
Dim ScreenItem
' activating error handling:
On Error Resume Next
For Each ScreenItem In ScreenItems
If ScreenItem.Type = "HMISlider" Then
'=== Property "BevelColorUp" only exists for a WinCC Slider Control
ScreenItem.BevelColorUp = 1
If (Err.Number <> 0) Then
HMIRuntime.Trace(ScreenItem.ObjectName + ": no Windows-Slider" + vbCrlf)
' delete error message
Err.Clear
End If
'=== Property "BorderStyle" only exists for a Windows-Slider
ScreenItem.BorderStyle = 1
If (Err.Number <> 0) Then
HMIRuntime.Trace(ScreenItem.ObjectName + ": no WinCC Slider Control" + vbCrlf)
Err.Clear
End If
End If
Next
On Error GoTo 0 ' deactivating error handling
End Sub
See also
PictureThumb Property (Page 539)
BarFillColor Property (Page 325)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Controls (Page 216)
WithLabels Property (Page 704)
WithAxes Property (Page 704)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
TickStyle Property (Page 603)
ThumbBackColor Property (Page 600)
ShowThumb Property (Page 577)
WinCC: Scripting (VBS, ANSI-C, VBA)
272 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ShowPosition Property (Page 574)
ShowBar Property (Page 572)
RangeMin Property (Page 549)
RangeMax Property (Page 549)
Position Property (Page 542)
PictureBack Property (Page 537)
Parent Property (Page 529)
OuterBevelWidth Property (Page 528)
OuterBevelStyle Property (Page 527)
ObjectName Property (Page 513)
Object Property (Page 512)
LocaleID Property (Page 483)
Left Property (Page 477)
Layer Object (Page 118)
LabelColor Property (Page 458)
InnerBevelWidth Property (Page 454)
InnerBevelStyle Property (Page 453)
InnerBevelOffset Property (Page 453)
Height Property (Page 444)
ForeColor Property (Page 435)
FontPosition Property (Page 433)
Font property (before WinCC V7) (Page 431)
FocusWidth Property (Page 430)
FocusColor Property (Page 430)
Enabled Property (Page 407)
ContinousChange Property (Page 381)
Caption Property (Page 360)
BevelColorUp Property (Page 341)
BevelColorDown Property (Page 341)
BarBackColor Property (Page 323)
BackStyle Property (Page 321)
BackColor Property (Page 318)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 273
VBS for Creating Procedures and Actions
1.14 VBS Reference
WinCC UserArchiveControl
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC
UserArchiveControl" as of WinCC V7.0.
Type Identifier in VBS
HMIUserArchiveControl
Available list objects
Column (Page 219) StatusbarElement (Page 227)
Row (Page 223) ToolbarButton (Page 230)
Methods Available in VBS
Activate ActivateDynamic
CopyRows CutRows
DeactivateDynamic
Export
GetColumn GetSelectedRow (Page 740) GetToolbarButton
GetColumnCollection GetSelectedRows (Page 741) GetToolbarButtonCollection
GetRow (Page 733) GetStatusbarElement
GetRowCollection (Page 734) GetStatusbarElementCollection
WinCC: Scripting (VBS, ANSI-C, VBA)
274 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
MoveToFirst MoveToNext MoveToPrevious
MoveToLast
PasteRows Print
ReadTags
ServerExport ShowPropertyDialog ShowSelectTimeBase
ServerImport ShowSelectArchive ShowSort
ShowHelp ShowSelection
WriteTags
Properties Available in VBS
If you access the properties with the listing object, you do not have to enter the name of the
listing. For example, when using "colobj.ColumnName", the listing name "Column" is dropped:
"colobj.Name".
Note that properties are available for WinCC controls that can have the effect of methods.
These properties are characterized by the respective names, e.g. "Add", "Remove" or
"Rename".
ArchiveName AutoCompleteColumns AutoSelectionColors
ArchiveType AutoCompleteRows AutoSelectionRectColor
BackColor BorderColor BorderWidth
Caption CellSpaceLeft CellSpaceTop
CellCut CellSpaceRight Closeable
CellSpaceBottom
ColumnAlias ColumnLeadingZeros ColumnShowIcon
ColumnAlign ColumnLength ColumnShowTitleIcon
ColumnAutoPrecisions ColumnMaxValue ColumnSort
ColumnCaption ColumnMinValue ColumnSortIndex
ColumnCount ColumnName ColumnStartValue
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 275
VBS for Creating Procedures and Actions
1.14 VBS Reference
ColumnDateFormat ColumnPosition (Page 387) ColumnStringLength
ColumnDMVarName ColumnPrecisions ColumnTimeFormat
ColumnExponentialFormat ColumnReadAccess ColumnTitleAlign
ColumnFlagNotNull ColumnReadonly ColumnTitles
ColumnFlagUnique ColumnRepos ColumnType
ColumnHideText ColumnResize ColumnVisible
ColumnHideTitleText ColumnScrollbar ColumnWriteAccess
ColumnIndex ColumnShowDate
EnableDelete ExportFileExtension ExportParameters
EnableEdit ExportFilename ExportSelection
EnableInsert ExportFilenameChangeable ExportShowDialog
ExportDirectoryChangeable ExportFormatGuid ExportXML
ExportDirectoryname ExportFormatName
FilterSQL Font
GridLineColor GridLineWidth
HorizontalGridLines
IconSpace
LineColor LineWidth
Moveable
PrintJobName
RowCellCount (Page 362) RowScrollbar RTPersistence
RowCellText (Page 363) RowTitleAlign RTPersistencePasswordLevel
RowCount (Page 382) RowTitles RTPersistenceType
RowNumber (Page 554)
WinCC: Scripting (VBS, ANSI-C, VBA)
276 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
SelectArchiveName SelectionColoring ShowSortIcon
SelectedCellColor SelectionRect ShowSortIndex
SelectedCellForeColor SelectionRectColor ShowTitle
SelectedRowColor SelectionRectWidth Sizeable
SelectedRowForeColor SelectionType SkinName
SelectedTitleColor ShowSortButton SortSequence
SelectedTitleForeColor
StatusbarBackColor StatusbarElementName StatusbarElementVisible
StatusbarElementAdd StatusbarElementRemove StatusbarElementWidth
StatusbarElementAutoSize StatusbarElementRename StatusbarFontColor
StatusbarElementCount StatusbarElementRepos StatusbarShowTooltips
StatusbarElementIconId StatusbarElementText StatusbarText
StatusbarElementId StatusbarElementTooltipText StatusbarUseBackColor
StatusbarElementIndex StatusbarElementUserDefined StatusbarVisible
TableColor TitleColor TitleGridLineColor
TableColor2 TitleCut TitleLightShadowColor
TableForeColor TitleDarkShadowColor TitleSort
TableForeColor2 TitleForeColor TitleStyle
TimeBase
ToolbarAlignment ToolbarButtonHotKey ToolbarButtonRepos
ToolbarBackColor ToolbarButtonId ToolbarButtonTooltipText
ToolbarButtonActive ToolbarButtonIndex ToolbarButtonUserDefined
ToolbarButtonAdd ToolbarButtonLocked ToolbarButtonVisible
ToolbarButtonBeginGroup ToolbarButtonName ToolbarShowTooltips
ToolbarButtonClick ToolbarButtonPasswordLevel ToolbarUseBackColor
ToolbarButtonCount ToolbarButtonRemove ToolbarUseHotKeys
ToolbarButtonEnabled ToolbarButtonRename ToolbarVisible
UseSelectedTitleColor UseTableColor2
VerticalGridLines
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 277
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
A user archive is displayed in a WinCC UserArchiveControl.
The following actions are initiated via script:
● Selecting data
● Exporting data
● Printing a table
Requirement
● A "WinCC UserArchiveControl" with the name "Control1" is inserted in a process picture in
Graphics Designer.
● A button is inserted in the Graphics Designer. You have configured the event "mouse click"
with a VBS action and the following script for the button.
● You have already configured a user archive in your project. Or you are using the demo
project from which you can use a user archive.
VBS365
Sub OnClick(ByVal Item)
Dim objUAControl
Dim objColumn
Dim coll
Dim field
' create reference to UserArchivControl
Set objUAControl = ScreenItems("Control1")
' Select user archive and general column properties
objUAControl.SelectArchiveName = True
objUAControl.ColumnResize = False
objUAControl.ColumnTitleAlign = 1
' properties for ID column
Set objColumn = objUAControl.GetColumn("ID")
objColumn.Length = 2
objColumn.Align = 0
' Select data
objUAControl.FilterSQL = "ID >=3"
'export the content as a CSV-file in the "ua" directory of the project folder
objUAControl.ServerExport
' print the control
objUAControl.PrintJobName = "UserArchiveControl - Table"
objUAControl.Print
End Sub
Note
More examples for use of properties and methods are available in the descriptions of the Get
methods of the controls and under "Examples for VBScript/Examples in WinCC/Dynamizing
controls".
WinCC: Scripting (VBS, ANSI-C, VBA)
278 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Controls (Page 216)
Controls before WinCC V7
WinCC Alarm Control (before WinCC V7)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC Alarm Control"
Type Identifier in VBS
HMIMessageView
Usage
In the following example, the object with the name "Control1" is moved 10 pixels to the right:
'VBS54
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left + 10
See also
ProjectPath Property (Page 546)
BackColor Property (Page 318)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Controls (Page 216)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 279
VBS for Creating Procedures and Actions
1.14 VBS Reference
WindowType Property (Page 703)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolbarButtons Property (Page 640)
Titleline Property (Page 628)
TitleCut property (before WinCC V7) (Page 627)
StatusbarPanes Property (Page 592)
ServerNames property (before WinCC V7) (Page 571)
SelectionType property (before WinCC V7) (Page 568)
SelectionRectWidth property (before WinCC V7) (Page 567)
SelectionRectColor property (before WinCC V7) (Page 567)
SelectionMode Property (Page 566)
PersistentRTPermission Property (Page 534)
PersistentRTCSPermission Property (Page 534)
Parent Property (Page 529)
ObjectName Property (Page 513)
Object Property (Page 512)
MsgFilterSQL property (before WinCC V7) (Page 509)
MsgCtrlFlags property (before WinCC V7) (Page 509)
LineTitle Property (Page 481)
LineHeight Property (Page 481)
LineFont Property (Page 480)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
HeaderSort Property (Page 444)
GridLineVert Property (Page 442)
GridLineHorz Property (Page 440)
Font property (before WinCC V7) (Page 431)
Enabled Property (Page 407)
ColWidth Property (Page 377)
ColTitle Property (Page 376)
ColMove Property (Page 372)
WinCC: Scripting (VBS, ANSI-C, VBA)
280 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
CellCut property (before WinCC V7) (Page 362)
Caption Property (Page 360)
ButtonCommand Property (Page 355)
AutoScroll property (before WinCC V7) (Page 314)
AllServer property (before WinCC V7) (Page 306)
Activate property (before WinCC V7) (Page 298)
LocaleSpecificSettings Property (Page 484)
SortOrder Property (Page 581)
TableFocusOnButtonCommand Property (Page 595)
CursorMode Property (Page 395)
CursorModePrefetch Property (Page 395)
LongTimeArchiveConsistency property (before WinCC V7) (Page 487)
WinCC Function Trend Control (before WinCC V7)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC Function Trend
Control"
Type Identifier in VBS
HMIFunctionTrendView
Usage
In the following example, the object with the name "Control1" is moved 13 pixels to the right:
'VBS57
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left +13
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 281
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Top Property (Page 644)
ScalingTypeY Property (Page 560)
Layer Object (Page 118)
DesiredCurveSourceUAArchive Property (Page 402)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Controls (Page 216)
Width Property (Page 701)
Visible Property (Page 699)
UpperLimitValue Property (Page 677)
UpperLimit Property (Page 676)
UpperLimitColor Property (Page 676)
Type Property (Page 669)
ToolbarHotKeys Property (Page 641)
ToolbarButtons Property (Page 640)
ToolbarAlignment property (before WinCC V7) (Page 631)
Titleline Property (Page 628)
TimeZone Property (Page 626)
TimeAxisX Property (Page 611)
TagProviderClsid Property (Page 598)
SourceUAColumnY Property (Page 586)
SourceUAColumnX Property (Page 586)
SourceUAArchiveStartID Property (Page 585)
SourceUAArchive Property (Page 585)
SourceTimeRange Property (Page 585)
SourceTagProviderDataY Property (Page 584)
SourceTagProviderDataX Property (Page 584)
SourceTagNameY Property (Page 584)
SourceTagNameX Property (Page 583)
SourceNumberOfValues Property (Page 583)
SourceNumberOfUAValues Property (Page 583)
SourceEndTime Property (Page 582)
WinCC: Scripting (VBS, ANSI-C, VBA)
282 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
SourceBeginTime Property (Page 581)
ShowValuesExponentialY Property (Page 579)
ShowValuesExponentialX Property (Page 578)
ShowRulerImmediately Property (Page 575)
ScalingTypeX Property (Page 560)
RulerPrecisionY Property (Page 557)
RulerPrecisionX Property (Page 556)
Replacement Property (Page 551)
ReplacementColor Property (Page 551)
RelayCurves Property (Page 550)
ProviderType Property (Page 546)
PrecisionY Property (Page 543)
PrecisionX Property (Page 543)
PersistentRTPermission Property (Page 534)
PersistentRT Property (Page 533)
PersistentRTCSPermission Property (Page 534)
PersistentRTCS Property (Page 533)
Parent Property (Page 529)
Online property (before WinCC V7) (Page 517)
ObjectName Property (Page 513)
Object Property (Page 512)
NumItems Property (Page 512)
Name Property (Page 510)
LowerLimitValue Property (Page 488)
LowerLimit Property (Page 487)
LowerLimitColor Property (Page 488)
LoadDataImmediately property (before WinCC V7) (Page 483)
Left Property (Page 477)
LabelY Property (Page 458)
LabelX Property (Page 458)
ItemVisible Property (Page 457)
InsertData Property (Page 454)
Index Property (Page 452)
Height Property (Page 444)
GridlinesY Property (Page 441)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 283
VBS for Creating Procedures and Actions
1.14 VBS Reference
GridlinesX Property (Page 441)
GridlinesValueY Property (Page 441)
GridlinesValueX Property (Page 441)
GraphDirection property (before WinCC V7) (Page 439)
FreezeProviderConnections Property (Page 438)
Font property (before WinCC V7) (Page 431)
FineGridY Property (Page 423)
FineGridX Property (Page 423)
FineGridValueY Property (Page 423)
FineGridValueX Property (Page 422)
EndY Property (Page 411)
EndX Property (Page 411)
Enabled Property (Page 407)
DesiredCurveVisible Property (Page 404)
DesiredCurveSourceUAColumnY Property (Page 403)
DesiredCurveSourceUAColumnX Property (Page 403)
DesiredCurveSourceUAArchiveStartID Property (Page 403)
DesiredCurveSourceNumberOfUAValues Property (Page 402)
DesiredCurveCurveForm Property (Page 402)
DesiredCurveColor Property (Page 401)
DeleteData Property (Page 401)
DataY Property (Page 399)
DataXY Property (Page 398)
DataX Property (Page 398)
DataIndex Property (Page 397)
CurveForm Property (Page 395)
CommonY Property (Page 379)
CommonX Property (Page 378)
Color Property (Page 372)
CoarseGridY Property (Page 370)
CoarseGridX Property (Page 370)
CoarseGridValueY Property (Page 371)
CoarseGridValueX Property (Page 371)
Closeable property (before WinCC V7) (Page 368)
Caption Property (Page 360)
WinCC: Scripting (VBS, ANSI-C, VBA)
284 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BeginY Property (Page 341)
BeginX Property (Page 340)
BackColor Property (Page 318)
AutorangeY Property (Page 313)
AutorangeX Property (Page 313)
AllowPersistence Property (Page 306)
LocaleSpecificSettings Property (Page 484)
PrintBackgroundColor Property (Page 544)
PrintJob Property (Page 545)
RulerFont Property (Page 556)
WinCC Online Table Control (before WinCC V7)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC Online Table
Control"
Type Identifier in VBS
HMITableView
Usage
In the following example, the object with the name "Control1" is moved 15 pixels to the right:
'VBS59
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left +15
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 285
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
TimeOverlap Property (Page 622)
ItemVisible Property (Page 457)
PrintBackgroundColor Property (Page 544)
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Controls (Page 216)
Width Property (Page 701)
Visible Property (Page 699)
Variable Property (Page 698)
ValueColumnAlignment Property (Page 691)
UpperLimitValue Property (Page 677)
UpperLimit Property (Page 676)
UpperLimitColor Property (Page 676)
Type Property (Page 669)
Top Property (Page 644)
ToolbarHotKeys Property (Page 641)
Toolbar Property (Page 630)
ToolbarButtons Property (Page 640)
ToolbarAlignment property (before WinCC V7) (Page 631)
Titleline Property (Page 628)
TimeZone Property (Page 626)
TimeRangeFactor Property (Page 624)
TimeRange Property (Page 623)
TimeRangeBase Property (Page 623)
TimeOverlapColor Property (Page 622)
TimeJump Property (Page 621)
TimeJumpColor Property (Page 622)
TimeFormat Property (Page 621)
TimeColumnAlignment Property (Page 613)
Statusbar Property (Page 588)
PrintJob Property (Page 545)
Precisions Property (Page 543)
WinCC: Scripting (VBS, ANSI-C, VBA)
286 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
PersistentRTPermission Property (Page 534)
PersistentRT Property (Page 533)
PersistentRTCSPermission Property (Page 534)
PersistentRTCS Property (Page 533)
Parent Property (Page 529)
Online property (before WinCC V7) (Page 517)
ObjectName Property (Page 513)
Object Property (Page 512)
NumItems Property (Page 512)
LowerLimitValue Property (Page 488)
LowerLimit Property (Page 487)
LowerLimitColor Property (Page 488)
LoadDataImmediately property (before WinCC V7) (Page 483)
Left Property (Page 477)
Layer Object (Page 118)
Index Property (Page 452)
Height Property (Page 444)
Font property (before WinCC V7) (Page 431)
EndTime Property (Page 410)
Enabled Property (Page 407)
Edit Property (Page 406)
Editable Property (Page 406)
CommonTime Property (Page 378)
Command Property (Page 377)
Color Property (Page 372)
Closeable property (before WinCC V7) (Page 368)
Caption Property (Page 360)
BeginTime Property (Page 340)
BackColor Property (Page 318)
Archive Property (Page 310)
AllowPersistence Property (Page 306)
Actualize Property (Page 301)
Activate property (before WinCC V7) (Page 298)
LocaleSpecificSettings Property (Page 484)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 287
VBS for Creating Procedures and Actions
1.14 VBS Reference
WinCC Online Trend Control (before WinCC V7)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC Online Trend
Control"
Type Identifier in VBS
HMITrendView
Usage
In the following example, the object with the name "Control1" is moved 16 pixels to the right:
'VBS60
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left +16
See also
Properties (Page 297)
TimeAxis Property (Page 604)
LowerLimitColor Property (Page 488)
Caption Property (Page 360)
Activate Method (Page 714)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Controls (Page 216)
Width Property (Page 701)
Visible Property (Page 699)
UpperLimitValue Property (Page 677)
UpperLimit Property (Page 676)
WinCC: Scripting (VBS, ANSI-C, VBA)
288 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
UpperLimitColor Property (Page 676)
Type Property (Page 669)
Top Property (Page 644)
ToolbarHotKeys Property (Page 641)
Toolbar Property (Page 630)
ToolbarButtons Property (Page 640)
ToolbarAlignment property (before WinCC V7) (Page 631)
Titleline Property (Page 628)
TimeZone Property (Page 626)
TimeRangeFactor Property (Page 624)
TimeRange Property (Page 623)
TimeRangeBase Property (Page 623)
TimeOverlap Property (Page 622)
TimeOverlapColor Property (Page 622)
TimeJump Property (Page 621)
TimeJumpColor Property (Page 622)
TimeAxisFormat Property (Page 606)
TagName Property (Page 596)
Statusbar Property (Page 588)
ShowRulerImmediately Property (Page 575)
ServerData Property (Page 569)
RulerPrecisions Property (Page 556)
Replacement Property (Page 551)
ReplacementColor Property (Page 551)
RelayCurves Property (Page 550)
ProviderClsid Property (Page 546)
PrintJob Property (Page 545)
Precisions Property (Page 543)
PersistentRTPermission Property (Page 534)
PersistentRT Property (Page 533)
PersistentRTCSPermission Property (Page 534)
PersistentRTCS Property (Page 533)
Parent Property (Page 529)
Online property (before WinCC V7) (Page 517)
ObjectName Property (Page 513)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 289
VBS for Creating Procedures and Actions
1.14 VBS Reference
Object Property (Page 512)
NumItems Property (Page 512)
MeasurePoints Property (Page 495)
LowerLimitValue Property (Page 488)
LowerLimit Property (Page 487)
LoadDataImmediately property (before WinCC V7) (Page 483)
Left Property (Page 477)
Layer Object (Page 118)
Label Property (Page 457)
ItemVisible Property (Page 457)
Index Property (Page 452)
Height Property (Page 444)
GridLineValue Property (Page 442)
GridLines Property (Page 440)
GraphDirection property (before WinCC V7) (Page 439)
Font property (before WinCC V7) (Page 431)
FineGridValue Property (Page 422)
FineGrid Property (Page 422)
EndValue Property (Page 411)
EndTime Property (Page 410)
Enabled Property (Page 407)
CurveForm Property (Page 395)
CommonY Property (Page 379)
CommonX Property (Page 378)
Command Property (Page 377)
Color Property (Page 372)
CoarseGridValue Property (Page 370)
CoarseGrid Property (Page 369)
Closeable property (before WinCC V7) (Page 368)
BeginValue Property (Page 340)
BeginTime Property (Page 340)
BackColor Property (Page 318)
Autorange Property (Page 313)
AllowPersistence Property (Page 306)
Actualize Property (Page 301)
WinCC: Scripting (VBS, ANSI-C, VBA)
290 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Activate property (before WinCC V7) (Page 298)
AdjustRuler Property (Page 303)
LineWidth property (before WinCC V7) (Page 482)
ScalingType Property (Page 559)
UseRangeSubstitutes Property (Page 679)
XAxisColor property (before WinCC V7) (Page 704)
HideTagNames Property (Page 445)
LocaleSpecificSettings Property (Page 484)
PrintBackgroundColor Property (Page 544)
ItemProviderClsid Property (Page 456)
OneY Property (Page 516)
AllowXAxisColor - Property (Page 306)
AnchorRuler Property (Page 307)
SavedTrend Property (Page 558)
SelectedTrend Property (Page 566)
ShowSpanNames Property (Page 577)
DefaultPrecision Property (Page 399)
DefaultRulerPrecision Property (Page 399)
LowerLimitTagName Property (Page 488)
UpperLimitTagName Property (Page 676)
UseOnlineTags Property (Page 678)
WinCC Push Button Control (up to WinCC V7.3)
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "WinCC Push Button Control"
As of WinCC V7, the control was replaced by the Windows object "Button" and "Round Button".
Up to WinCC V7.3, the "WinCC Push Button Control" is still available in the "Controls" selection
window. You can still use the control in migrated projects.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 291
VBS for Creating Procedures and Actions
1.14 VBS Reference
Type Identifier in VBS
HMIButton
Usage
In the following example, the object with the name "Control1" is moved 17 pixels to the right:
'VBS61
Dim objControl
Set objControl = ScreenItems("Control1")
objControl.Left = objControl.Left + 17
Note
The events KeyDown, KeyUp and KeyPress cannot be addressed by VBS. If it is required to
make controls dynamic with the help of VBS, no parameter must be declared with ByRef.
Notes on Error Handling
Buttons and pushbuttons are mapped in the object model to an "HMIButton" type. Since the
objects have different properties, the availability of the property (dynamic type compilation in
Runtime) should be queried via an exception measure. The exception measure is activated
for the corresponding procedure by the following instruction:
On Error Resume Next
The instruction causes the VBScript engine to initiate the follow-on command in the case of a
Runtime error.
The error code can subsequently be checked using the Err object. In order to deactivate the
handling of Runtime errors in scripts, use the following command:
On Error Goto 0
Handling errors always relates to the procedure layer. If a script in a procedure causes an
error, VBScript checks whether an error handling measure is implemented in this layer. If not,
control is transferred one layer up (to the calling procedure). If there is no error handling
measure here either, the control is transferred yet another layer up. This continues until either
the top module level is reached or the code for Runtime error handling is located. If the
activation of the Runtime error handling fails, the control is transferred to the top level on the
internal VBScript Runtime error handing. This opens an error dialog and stops the script.
WinCC: Scripting (VBS, ANSI-C, VBA)
292 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The "On Error Resume Next" command can be installed on all layers (i.e. also in procedures).
When the error handling measure is use, it can basically be determined whether the user is
actually using the required implementation type.
In addition, it can be ensured that there is no termination of execution due to a faulty access
to the object.
Examples of error handling
'VBS62
Dim objScreenItem
On Error Resume Next 'Activation of error handling
For Each objScreenItem In ScreenItems
If objScreenItem.Type = "HMIButton" Then
'
'=== Property "Text" available only for Standard-Button
objScreenItem.Text = "Windows"
If 0 <> Err.Number Then
HMIRuntime.Trace objScreenItem.ObjectName & ": no Windows-Button" & vbCrLf
Err.Clear 'Delete error message
End If
'
'=== Property "Caption" available only for PushButton
objScreenItem.Caption = "Push"
If 0 <> Err.Number Then
HMIRuntime.Trace objScreenItem.ObjectName & ": no Control" & vbCrLf
Err.Clear
End If
End If
Next
On Error Goto 0 'Deactivation of errorhandling
See also
Properties (Page 297)
FontName Property (Page 433)
Activate Method (Page 714)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Controls (Page 216)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Transparent Property (Page 646)
Top Property (Page 644)
PictureUnselected Property (Page 540)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 293
VBS for Creating Procedures and Actions
1.14 VBS Reference
PictureSelected Property (Page 539)
Parent Property (Page 529)
Outline Property (Page 528)
ObjectName Property (Page 513)
Object Property (Page 512)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
FrameWidth Property (Page 438)
FrameColorUp Property (Page 437)
FrameColorDown Property (Page 436)
ForeColor Property (Page 435)
FontUnderline Property (Page 434)
FontStrikeThru Property (Page 434)
FontSize Property (Page 433)
FontItalic Property (Page 432)
Font property (before WinCC V7) (Page 431)
FontBold Property (Page 432)
FocusRect Property (Page 430)
Enabled Property (Page 407)
Caption Property (Page 360)
BackColor Property (Page 318)
AutoSize Property (Page 316)
1.14.3.7 Customized Object
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Customized Object".
WinCC: Scripting (VBS, ANSI-C, VBA)
294 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Type Identifier in VBS
HMIScreenModule
Usage
You access customized properties in a customized object via the attribute name in VBS.
Intellisense is only applicable to the customized object as a whole.
You will locate the attribute name under Properties of the properties placed outside (right-click
Property) and can be modified there.
In the following example, the object with the name "CustomizedObject1" is moved 10 pixels
to the right:
'VBS65
Dim objCustomObject
Set objCustomObject = ScreenItems("CustomizedObject1")
objCustomObject.Left = objCustomObject.Left + 10
See also
Activate Method (Page 714)
Properties (Page 297)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Object types of the ScreenItem object (Page 141)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
Parent Property (Page 529)
ObjectName Property (Page 513)
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
Enabled Property (Page 407)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 295
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.3.8 Group
Description
6FUHHQV
6FUHHQ
6FUHHQ,WHPV
6FUHHQ,WHP
Object Type of ScreenItem Object. Represents the graphic object "Group"
Type Identifier in VBS
HMIGroup
Usage
In the following example, the object with the name "Group1" is moved 10 pixels to the right:
'VBS66
Dim objGroup
Set objGroup = ScreenItems("Group1")
objGroup.Left = objGroup.Left + 10
See also
Properties (Page 297)
Activate Method (Page 714)
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Object types of the ScreenItem object (Page 141)
Width Property (Page 701)
Visible Property (Page 699)
Type Property (Page 669)
Top Property (Page 644)
ToolTipText Property (Page 643)
Parent Property (Page 529)
ObjectName Property (Page 513)
WinCC: Scripting (VBS, ANSI-C, VBA)
296 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Left Property (Page 477)
Layer Object (Page 118)
Height Property (Page 444)
Enabled Property (Page 407)
1.14.4 Properties
1.14.4.1 Properties
Overview
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.
Properties on graphic objects can be addressed via the following syntax:
'VBS191
Dim obj
Set obj = ScreenItems("object1")
obj.property = Value
In the following example, the object with the name "Control1" is moved 10 pixels to the right:
'VBS192
Dim obj
Set obj = ScreenItems("control1")
obj.Left = obj.Left + 10
1.14.4.2 A
Aa - Ad
AccessPath Property
Description
Displays the storage path (with hierarchy information) of a screen object (picture). The property
corresponds to the full access code on the Screens Collections.
STRING (read only)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 297
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
In the following example, the path of the picture "ScreenWindow1" is issued:
'VBS67
Dim objScreen
Set objScreen = HMIRuntime.Screens("ScreenWindow1")
MsgBox objScreen.AccessPath
See also
ScreenItem Object (Page 123)
Screens Object (List) (Page 132)
Activate property (before WinCC V7)
Description
The data to be displayed is only requested from the archive server when this attribute is set.
In order to reduce the picture opening times, this attribute should not be set and the value only
dynamically changed when necessary.
Write/Read access
To differentiate between the "Activate" property form the "Activate" method, the property is
accessed via "Object".
Example:
Dim ctrl
Set ctrl = ScreenItems("Control")
ctrl.Object.activate = true
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
Activate property
Activate
WinCC: Scripting (VBS, ANSI-C, VBA)
298 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The data to be displayed in the message window are only requested from the message server
if you set this attribute. Instead of setting this attribute, it is advisable to change the value
dynamically in order to reduce picture activation times.
To differentiate the "Activate" property from the "Activate" method, the property is addressed
via "Object".
Example
Dim ctrlSet
ctrl = ScreenItems("Control")
ctrl.Object.activate = true
The attribute can be assigned dynamic properties by means of the name Activate . The data
type is BOOLEAN.
ActiveProject Property
Description
Returns an object of type "Project".
See also
Path Property (Page 531)
Name Property (Page 510)
Ellipse segment (Page 145)
HMIRuntime Object (Page 116)
ActiveScreen Property
Description
Supplies a reference to the picture which contains the object with the current focus.
Use
"ActiveScreen" is used in runtime to address the properties of the picture which contains the
currently focussed object.
Picture window
If the current focus is on a picture window, the process picture in the picture window is
addressed.
To address the process picture in which the picture window is called, use the following call:
● HMIRuntime.ActiveScreen.Parent.ObjectName
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 299
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
The following example assigns the name of the current picture to the tag "strScrName" and
outputs it in a message:
'VBS68
Dim strScrName
strScrName = HMIRuntime.ActiveScreen.Objectname
MsgBox strScrName
See also
Screen Object (Page 129)
HMIRuntime Object (Page 116)
ActiveScreenItem Property
Description
Supplies a reference to the object currently in focus.
Usage
"ActiveScreenItem" is used in Runtime in order to address the properties of the object currently
in focus.
Example:
The following example displays the name of the object in the "ScreenWindow1" picture which
has the focus:
'VBS69
Dim objScreen
Set objScreen = HMIRuntime.Screens("ScreenWindow1")
MsgBox objScreen.ActiveScreenItem.ObjectName
See also
ScreenItem Object (Page 123)
HMIRuntime Object (Page 116)
WinCC: Scripting (VBS, ANSI-C, VBA)
300 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Actualize Property
Description
The "Index" property references a column pair or a trend. "Actualize" defines whether a static
or dynamic representation should be used for this column pair/trend.
● 0: Static display
● -1: Dynamic display
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
ActualPointLeft Property
Description
Defines or returns the x-coordinate of the current corner point in relation to the original picture
(top left). Each corner point is identified by an index which is derived from the number
("PointCount") of corner point available.
A change of the value can affect the properties "Width" (object width) and "Left" (x-coordinate
of the object position).
See also
Polyline (Page 156)
Polygon (Page 154)
ScreenItem Object (Page 123)
ActualPointTop Property
Description
Defines or returns the y-coordinate of the current corner point in relation to the original picture
(top left). Each corner point is identified by an index which is derived from the number
("PointCount") of corner point available.
A change of the value can affect the properties "Height" (object height) and "Top" (y-coordinate
of the position).
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 301
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Polyline (Page 156)
Polygon (Page 154)
ScreenItem Object (Page 123)
AdaptBorder Property
Description
TRUE, when the border should be dynamically adjusted to the size of the text. BOOLEAN write-
read access.
For text list and I/O field: Read only access.
See also
Button (Page 199)
Static text (Page 163)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
I/O Field (Page 182)
ScreenItem Object (Page 123)
AdaptPicture Property
Description
Defines whether the picture displayed in a picture window should be adapted to the size of the
picture window in Runtime or not. Read only access.
TRUE, when the picture adapts to the picture window size.
FALSE, when the picture does not adapt to the picture window size.
See also
Picture Window (Page 177)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
302 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
AdaptSize Property
Description
Defines whether the picture window should adapt to the size of the picture displayed in it during
Runtime or not. Read only access.
TRUE, when the picture window adapts to the picture size.
FALSE, when the picture window does not adapt to the picture size.
See also
Picture Window (Page 177)
ScreenItem Object (Page 123)
AdjustRuler Property
Description
Specifies if the ruler window should be adjusted to the trend window upon each appearance.
TRUE, if you move the ruler window and make it appear and disappear again, it will be
displayed in its original position and its original size.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
Al - Ap
AlarmID property
Description
Returns the AlarmID of the Alarm object. The AlarmID is unique, and is assigned by the system.
AlarmID (readonly)
See also
Alarms object (list) (Page 108)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 303
VBS for Creating Procedures and Actions
1.14 VBS Reference
AlarmHigh Property
Description
Defines the top limit value at which an alarm should be triggered or returned.
The type of the evaluation (in percent or absolute) is defined in the "TypeAlarmHigh" property.
The "CheckAlarmHigh" property determines whether the monitoring for this limit value is
activated.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
AlarmLogs Property
Description
Returns an object of type "AlarmLogs".
AlarmLogs (read-only)
See also
HMIRuntime Object (Page 116)
AlarmLow Property
Description
Defines the bottom limit value at which an alarm should be triggered or returned.
The type of the evaluation (in percent or absolute) is defined in the "TypeAlarmLow" property.
The "CheckAlarmLow" property determines whether the monitoring for this limit value is
activated.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
304 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Alignment Property
Description
Defines or returns the representation of the scale (left/right or top/bottom) according to the
position of the bar graph object. The "Scaling" property must be set to TRUE for the scale to
be displayed.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
AlignmentLeft Property
Description
Defines or returns the horizontal alignment of the text. Value range from 0 to 2.
0 = left
1 = centered
2 = right
See also
Group Display (Page 192)
Static text (Page 163)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
Button (Page 199)
I/O Field (Page 182)
ScreenItem Object (Page 123)
AlignmentTop Property
Description
Defines or returns the vertical alignment of the text. Value range from 0 to 2.
0 = top
1 = centered
2 = bottom
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 305
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Group Display (Page 192)
Static text (Page 163)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
Button (Page 199)
I/O Field (Page 182)
ScreenItem Object (Page 123)
AllowPersistence Property
Description
TRUE, when settings regarding persistence are possible. BOOLEAN write-read access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
AllowXAxisColor - Property
Description
TRUE if the defined color of the common X-axis is displayed in runtime. BOOLEAN write-read
access.
AllServer property (before WinCC V7)
Description
Defines that the data to be displayed in the message window is required by all servers
participating in a distributed system on which Alarm Logging is activated. Write/Read access.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
306 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
AllServer property
All servers - AllServer
Selects all servers whose packages were loaded and on which "Alarm Logging Runtime" is
activated in the startup list.
Value Explanation
TRUE All servers are activated.
FALSE Activates only the servers entered in "Server selection".
The attribute can be assigned dynamic properties by means of the name AllServer. The data
type is BOOLEAN.
Analog Property
Description
TRUE, when the clock is to be displayed as an analog clock. BOOLEAN write-read access.
See also
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
AnchorRuler Property
Description
TRUE if the ruler window is firmly linked to the curve window. BOOLEAN write-read access.
AngleAlpha Property
Description
Defines or returns depth angle a for the 3D-effect of the "3DBarGraph" object. Value range in
degrees from 0 to 90.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 307
VBS for Creating Procedures and Actions
1.14 VBS Reference
AngleBeta Property
Description
Defines or returns depth angle b for the 3D-effect of the "3DBarGraph" object. Value range in
degrees from 0 to 90.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
AngleMax Property
Description
Defines or returns the angle on the scale at which the scale graduation ends. LONG write-read
access.
The start and end of the scale graduation are described by the attributes "AngleMin" and
"AngleMax" in angular degrees. AngleMin < AngleMax applies.
Angle 0 degrees is at the right side of the horizontal diameter of the graduated scale disk.
Positive angle values are counted in a counterclockwise direction.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
AngleMin Property
Description
Defines or returns the angle on the scale at which the scale graduation begins. LONG write-
read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
308 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Appearance property
Appearance
Specifies the appearance of the table in WinCC UserAdminControl.
Value Explanation
0 The table is displayed normally.
1 The table is displayed in button style.
The attribute can be assigned dynamic properties using the name Appearance. The data type
is SHORT.
Application Property
Description
Returns the Graphics Designer application when the application property is used without an
object identifier. If the application property is used with object identifier, it returns an application
object which displays the application with which the defined object was created. Read only
access.
See also
Application Window (Page 171)
ScreenItem Object (Page 123)
ApplyProjectSettings property
Apply project settings - ApplyProjectSettings
Activates the project settings derived from "Alarm Logging".
Value Explanation
TRUE The "Apply project settings" check box is selected. The message blocks configured in "Alarm Logging"
and their properties are activated in AlarmControl. The message blocks are displayed with these prop‐
erties in the message window.
FALSE The "Apply project settings" check box is deactivated. You can add or remove message blocks, or edit
their properties.
The attribute can be assigned dynamic properties by means of the name
ApplyProjectSettings. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 309
VBS for Creating Procedures and Actions
1.14 VBS Reference
Ar - Ax
Archive Property
Description
The "Index" property references a pair of columns. "Archive" defines process archive values
linked to the column pair. The name of the process value archive is specified in the following
form: Server name::Archive name
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
ArchiveName property
Name - ArchiveName
Specifies the user archive or view to be displayed. Open the "Package Browser" dialog for
configuring an archive or a view by clicking the button.
The attribute can be assigned dynamic properties by means of the name ArchiveName. The
data type is STRING.
ArchiveType property
Type - ArchiveType
Specifies whether the selected user archive is an archive or a view. The field cannot be edited.
The attribute can be assigned dynamic properties by means of the name ArchiveType. The
data type is LONG.
AspectRatio property
AspectRatio
Specifies if the aspect ratio is kept in movies.
The attribute can be assigned dynamic properties by means of the name AspectRatio. The
data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
310 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Assignments Property
Description
A list which contains the assignments between the output values and the actual output texts
to be output.
The assignments depend on the set list type. The list type is defined with the ListType property.
Read only access.
See also
Text list (Page 194)
ScreenItem Object (Page 123)
AssumeOnExit Property
Description
TRUE, if the entered text is assumed upon exiting the entry field (e.g., with the key or mouse
click). BOOLEAN write-read access.
See also
I/O Field (Page 182)
Text list (Page 194)
ScreenItem Object (Page 123)
AssumeOnFull Property
Description
TRUE, when the content of the input field is full (specified number of characters have been
entered) and should be exited automatically and the input accepted. BOOLEAN write-read
access.
See also
I/O Field (Page 182)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 311
VBS for Creating Procedures and Actions
1.14 VBS Reference
AuthorizedGroups property
User for the electronic signature (AuthorizedGroups)
The attribute "User for the electronic signature" specifies which user can sign an operation.
In Runtime, the configured user authenticates him or herself with the password during
operation. The user has the option to enter a comment which is saved with the triggered system
message.
In the "Selection" dialog, select the users in the "User group" column. To activate the drop-
down list, select the empty row in the "Group" column.
The "User for the electronic signature" attribute can be dynamized with the "AuthorizedGroups"
name.
WinCC/Audit: Additional options
With WinCC/Audit, you can select multiple users and group them via operands and
parentheses.
The option "Later" allows signing after the operation.
AutoCompleteColumns property
Show empty columns - AutoCompleteColumns
Adds empty columns if the Control width is greater than the width of columns configured.
Value Explanation
TRUE Enables the display of empty columns.
FALSE Disables the display of empty columns.
The attribute can be assigned dynamic properties by means of the name
AutoCompleteColumns. The data type is BOOLEAN.
AutoCompleteRows property
Show empty rows - AutoCompleteRows
Enables the insertion of empty rows if the Control length is greater than the number of rows
configured.
Value Explanation
TRUE Enables the display of empty rows.
FALSE Disables the display of empty rows.
The attribute can be assigned dynamic properties by means of the name
AutoCompleteRows. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
312 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
AutoPosition property
Automatic positioning - AutoPosition
Defines whether to position the RulerControl exactly below the source control.
The following settings are available:
Value Explanation
TRUE The RulerControl is positioned exactly below the source control.
FALSE The RulerControl is displayed in accordance with your configuration of the control position.
The attribute can be assigned dynamic properties by means of the name AutoPosition. The
data type is BOOLEAN.
Autorange Property
Description
TRUE, when the value range of the Y-axis is determined automatically or defined by using the
"BeginValue" and "EndValue"attributes. BOOLEAN write-read access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
AutorangeX Property
Description
TRUE, when the value range of the X-axis is determined automatically. FALSE, when it is
determined by means of the "BeginX" and "EndX" attributes. BOOLEAN write-read access.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
AutorangeY Property
Description
TRUE, when the value range of the Y-axis is determined automatically. FALSE, when it is
determined by means of the "BeginY" and "EndY" attributes. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 313
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
AutoScroll property (before WinCC V7)
Description
Defines the behavior of the message window when a new message is received. BOOLEAN
write-read access.
TRUE : A newly received message is appended to the list displayed in the message window
and is automatically selected. The visible range of the message window is moved, if necessary.
FALSE : A newly received message is not selected. The visible range of the message window
is not changed.
The targeted selection of messages is only possible when "AutoScroll" is not active.
The "AutoScroll" property is deactivated when the attribute "MsgCtrlFlag" = "-1" is set. This
means that the most recent message is displayed at the top of the list in the message window.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
AutoScroll Property
Auto scrolling - AutoScroll
Defines the behavior of the message window after a new message events.
You can only select message lines if "Auto scrolling" is disabled.
Value Explanation
TRUE If "AutoScroll" is activated, a new activated message is appended to the list displayed in the
message window and selected automatically. The visible area of the message window is
shifted as required.
FALSE New message events are not selected if "Autoscroll" is disabled. The visible area of the
message window is not changed.
The attribute can be assigned dynamic properties by means of the name AutoScroll. The data
type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
314 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
AutoSelectionColors property
Automatic selection coloring - AutoSelectionColor
Enables the display of default system colors as selection color for cells and rows.
Value Explanation
TRUE The system colors are in use.
FALSE The custom colors are used.
The attribute can be assigned dynamic properties by means of the name
AutoSelectionColors. The data type is BOOLEAN.
AutoSelectionRectColor property
Automatic color assignment - AutoSelectionRectColor
Defines a system color for the selection border.
Value Explanation
TRUE The system color is in use.
FALSE The custom color is used.
The attribute can be assigned dynamic properties by means of the name
AutoSelectionRectColors. The data type is BOOLEAN.
AutoShow property
Show/hide automatically - AutoShow
Enables/disables automatic activation of the RulerControl on the display if you selected the
button functions for the ruler, statistics range and for statistics in the source control.
The RulerControl is hidden again if you are no longer using the ruler, statistics range and
statistics functions.
Value Explanation
TRUE The RulerControl is displayed automatically.
FALSE The RulerControl is not displayed automatically.
The attribute can be assigned dynamic properties by means of the name AutoShow. The data
type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 315
VBS for Creating Procedures and Actions
1.14 VBS Reference
AutoSize Property
Description
Defines or returns the size adaptation of the object. The following values can be set:
● 0: No size adaptation.
● 1: The picture ("PictureSelected", "PictureUnselected" properties) is adapted to the button.
● 2: The button is adapted to the picture ("PictureSelected", "PictureUnselected" properties).
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
ScreenItem Object (Page 123)
Autostart property
Autostart
Specifies if movies are started automatically.
The attribute can be assigned dynamic properties by means of the name Autostart. The data
type is BOOLEAN.
Average Property
Average
TRUE, if the mean value is calculated based on the last 10 values. A value change is
conditional for calculation of a new mean value. The mean value is reset when you change a
picture. If only one value is available when you change the picture, the following mean value
is calculated: (5+0+0+0+0+0+0+0+0+0)/10=0,5.
BOOLEAN write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
Axe Property
Description
Defines or returns the position of the 3D bar in the coordinate system. Value range from 0 to
2.
WinCC: Scripting (VBS, ANSI-C, VBA)
316 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
0: The 3D-bar is displayed on the X-axis.
1: The 3D-bar is displayed on the Y-axis.
2: The 3D-bar is displayed on the Z-axis.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
AxisSection Property
Description
Defines or returns the distance between two long axis sections. The information on the distance
is given in scale units and is dependent on the minimum and maximum values configured.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
1.14.4.3 B
Ba
BackBorderWidth Property
Description
Defines or returns the width of the 3D border in pixels. The value for the width is dependent
on the size of the object.
See also
ScreenItem Object (Page 123)
Button (Page 199)
Round Button (Page 207)
Slider (Page 210)
Group Display (Page 192)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 317
VBS for Creating Procedures and Actions
1.14 VBS Reference
BackColor property
Background - BackColor
Specifies the background color of the control. The button opens the "Color selection" dialog.
The attribute can be assigned dynamic properties by means of the name BackColor. The data
type is LONG.
BackColor property
Background Color (BackColor)
Specifies the icon background color in the "Color selection" dialog. The background color is
displayed in "opaque" style.
The attribute can be assigned dynamic properties by means of the name BackColor. The data
type is LONG.
BackColor Property
Function
Defines or returns the background color for the object.
For objects with a fill pattern, the background color is not displayed if "transparent" is defined
as the fill style.
Special features of the WinCC slider control
The background color only takes effect when the object is at least partially filled.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Enter the appropriate decimal value
for each of the three RGB values.
Example:
RGB(200, 150, 100)
Example:
The following example defines the background of the "ScreenWindow1" picture to red:
'VBS70
Dim objScreen
Set objScreen = HMIRuntime.Screens("ScreenWindow1")
objScreen.BackColor = RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
318 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
FillStyle Property (Page 420)
FillColor Property (Page 418)
ScreenItem Object (Page 123)
BackColor2 Property
Description
Defines or returns the bar color for the display of the current value. LONG write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
BackColor3 Property
Description
Defines or returns the color of the bar background. LONG write-read access.
See also
ScreenItem Object (Page 123)
Bar (Page 172)
BackColorBottom Property
Description
Defines or returns the color for the bottom/right part of the slider. LONG write-read access.
See also
Slider (Page 210)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 319
VBS for Creating Procedures and Actions
1.14 VBS Reference
BackColorTop Property
Description
Defines or returns the color for the top/left part of the slider. LONG write-read access.
See also
Slider (Page 210)
ScreenItem Object (Page 123)
BackFlashColorOff Property
Description
Defines or returns the color of the object background for the flash status "Off". LONG write-
read access.
See also
ScreenItem Object (Page 123)
BackFlashColorOn Property
Description
Defines or returns the color of the object background for the flash status "On". LONG write-
read access.
See also
ScreenItem Object (Page 123)
Background Property
Description
TRUE, when the background of the 3D-bar graph object should be visible. BOOLEAN write-
read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
320 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
BackgroundPicture Property
Description
Returns the picture name of the background picture for the graduated scale disk. Read only
access
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
BackPictureAlignment property
Description
Defines or returns the mode of representation of the background image in the process picture.
LONG write-read access.
BackPictureName property
Description
Defines the path and file name of the background image in the process picture or returns it.
LONG write-read access.
BackStyle Property
Description
WinCC Digital/Analog Clock
Defines the type of background of the analog clock:
● 0: The rectangular background of the clock is filled by the specified background color.
● 1: The round numbered face of the clock is filled by the specified background color. This
enables a round analog clock to be displayed.
● 2: Numbered face and rectangular background are transparent.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 321
VBS for Creating Procedures and Actions
1.14 VBS Reference
WinCC Gauge Control
Defines the type of background of the gauge:
● 0: The rectangular or square background of the gauge has a border color is filled with the
specified color. The circular graduated scale disk is filled by the specified background color.
● 1: The rectangular or square background of the gauge is transparent. The circular
graduated scale disk is filled by the specified background color. This enables a circular
gauge to be displayed.
● 2: The rectangular or square background and graduated scale disk are transparent.
WinCC Slider Control
Defines whether the object background should be transparent.
● 0: The object background is not transparent
● 1: The object background is transparent
HMI Symbol Library
Defines the icon background transparency. Write/Read access.
● 0: The background is transparent and, thus, invisible.
● 1: The background is visible, the color of the background is defined by the "Background
Color" attribute.
See also
HMI Symbol Library (Page 237)
WinCC Slider Control (Page 270)
WinCC Gauge Control (Page 251)
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
Bar
BarAdd property
New - BarAdd
Creates a new diagram.
The attribute can be assigned dynamic properties using the name BarAdd. The data type is
STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
322 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BarBackColor Property
Description
Defines the background color in the area of the slider. The area stretches form "RangeMin" to
"RangeMax".
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
BarBarGradientColor property
Fill pattern color - BarBarGradientColor
The "Fill Pattern Color" attribute defines the color of the pattern that is displayed on a filled
area.
The attribute can be assigned dynamic properties using the name BarBarGradientColor. The
data type is LONG.
BarBarGradientPattern property
Fill pattern - BarBarGradientPattern
The "Fill Pattern" attribute specifies the pattern for the display of bars.
So that the fill pattern becomes visible, the color of the fill pattern must differ from the
background color.
49 fill patterns are available for selection:
● Fill pattern 1 "Solid" fills the object with the set background color.
● Fill pattern 2 "Transparent" means neither a background nor a fill pattern is displayed.
The attribute can be assigned dynamic properties using the name BarBarGradientPattern. The
data type is LONG.
BarBarWindow property
Diagram window - BarBarWindow
Specifies the diagram window in which the selected diagram will be displayed. You specify the
available diagram windows on the "Diagram window" tab.
The attribute can be assigned dynamic properties using the name BarWindow. The data type
is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 323
VBS for Creating Procedures and Actions
1.14 VBS Reference
BarChartType property
Diagram type - BarChartType
Specifies how the diagram will be displayed.
The following settings are available:
Value Description Explanation
0 Bar diagram A diagram with bars will be displayed.
1 Bars with value In addition to the bars, the values will be displayed in the diagram. The display of values
conforms to the configuration of the "Alignment" property and the write direction of the bars.
The attribute can be assigned dynamic properties using the name BarChartType. The data
type is LONG.
BarColor property
Border color - BarColor
Indicates the border color of the bar. Use the button to open the "Color selection" dialog to
select the color.
The attribute can be assigned dynamic properties using the name BarColor. The data type is
LONG.
BarCount property
BarCount
Specifies the number of configured diagrams.
The attribute can be assigned dynamic properties using the name BarCount. The data type is
LONG.
BarDepth Property
Description
Defines or returns the depth of the bar in pixels.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
324 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BarFillColor property
Bar color - BarFillColor
Indicates the fill color of the bars. For the "Bars with value" diagram type, the text background
color is specified.
Use the button to open the "Color selection" dialog to select the color.
The attribute can be assigned dynamic properties using the name BarFillColor. The data type
is LONG.
BarFillColor Property
Description
Defines the fill color in the area of the slider. The area stretches from "RangeMin" to the position
of the slider.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
BarHeight Property
Description
Defines or returns the height of the bar in pixels.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
BarIndex property
BarIndex
References a configured diagram. Using this attribute, you can assign the values of other
attributes to a specific diagram. The index must always be set before you change the properties
of a diagram in Runtime.
Valid values for "BarIndex" are between 0 and "BarCount" minus 1. The "BarCount" attribute
specifies the number of configured diagrams.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 325
VBS for Creating Procedures and Actions
1.14 VBS Reference
The "BarIndex" attribute can be assigned dynamic properties using the attribute BarRepos.
The data type is LONG.
BarLabel property
Label - BarLabel
Specifies the label of the selected diagram. The label is displayed in Runtime when the
"UseBarNameAsLabel" attribute has the value "FALSE".
The attribute can be assigned dynamic properties using the name BarLabel. The data type is
STRING.
BarLineStyle property
Border style - BarLineStyle
Specifies which border type is used to represent the border of the bar.
The following settings are available:
Value Description Explanation
0 Solid The border is displayed as a solid border.
1 Dashed The border is displayed as a dashed border.
2 Dotted The border is displayed as a dotted line.
3 Dash dot The border is displayed as a dash-dot line.
4 Dash-dot-dot The border is displayed as a dash-dot-dot line.
The attribute can be assigned dynamic properties using the name BarLineStyle. The data type
is LONG.
BarLineWidth property
Border width - BarLineWidth
Specifies the border width of the bar.
The attribute can be assigned dynamic properties using the name BarLineWidth. The data
type is LONG.
BarLowerLimit property
BarLowerLimit
Specifies the low limit of a tag. If the tag value is less than "BarLowerLimit", the values are
designated with the color set in "BarLowerLimitColor". This setting is enabled when the
"BarLowerLimitColoring" attribute has the value "TRUE".
WinCC: Scripting (VBS, ANSI-C, VBA)
326 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties using the name BarLowerLimit. The data
type is DOUBLE.
BarLowerLimitColor property
BarLowerLimitColor
Specifies the color for designating tag values below the value at "BarLowerLimit". The setting
is enabled when the "BarLowerLimitColoring" attribute has the value "TRUE".
The attribute can be assigned dynamic properties using the name BarLowerLimitColor. The
data type is LONG.
BarLowerLimitColoring property
BarLowerLimitColoring
Specifies whether the "BarLowerLimitColor" attribute is used for designating tag values that
are lower than the value at "BarLowerLimit".
Value Explanation
TRUE The "BarLowerLimitColor" attribute is enabled.
FALSE The "BarLowerLimitColor" attribute is disabled.
The attribute can be assigned dynamic properties using the name BarLowerLimitColoring. The
data type is BOOLEAN.
BarName property
Object name - BarName
Specifies the name of the selected diagram.
The "BarName" attribute can be assigned dynamic properties using the attribute BarRename.
BarProvider property
Data source - BarProvider
Specifies the data source of the selected diagram.
The following settings are available:
Value Description Explanation
0 None No data source configured to create a connection in Runtime by means of a script.
1 Archive tags Data source with archive tags of a process value archive.
The attribute can be assigned dynamic properties using the name BarProvider.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 327
VBS for Creating Procedures and Actions
1.14 VBS Reference
BarProviderCLSID property
BarProviderCLSID
Displays the data source of the selected diagram.
Value Explanation
No data source configured to create a connection in Runtime by means of a
script.
{416A09D2-8B5A-11D2- Data source with archive tags of a process value archive.
8B81-006097A45D48}
The attribute can be assigned dynamic properties using the name BarProviderCLSID. The
data type is STRING.
BarRemove property
Remove - BarRemove
Removes the selected diagram from the list.
The attribute can be assigned dynamic properties using the name BarRemove. The data type
is STRING.
BarRename property
BarRename
Renames the diagram that is referenced using the "BarIndex" attribute.
The attribute can be assigned dynamic properties using the name BarRename. You can use
"BarRename" to also assign dynamic properties to the "BarName" attribute. The data type is
STRING.
BarRepos property
Up/down - BarRepos
Changes the order of the selected diagrams in the diagram window. "Up" and "Down" move
the selected diagrams up and down in the list. As a result, the diagram is displayed further in
the foreground or background in runtime.
The attribute can be assigned dynamic properties using the name BarRepos. The data type
is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
328 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BarSelectTagName property
BarSelectTagName
Opens a dialog for selecting the tag name for the data source of the diagram. Programmers
can set this attribute to allow users to select a tag name using a button, for example.
The attribute can be assigned dynamic properties using the name BarSelectTagName. The
data type is BOOLEAN.
BarTagName property
Tag name - BarTagName
Displays the tag name of the connected tag. With the button you open a dialog for selecting
an archive tag.
The attribute can be assigned dynamic properties using the name BarTagName. The data
type is STRING.
BarTimeAxis property
Time axis - BarTimeAxis
Specifies which time axis will be used for the selected diagram. You specify the available time
axes on the "Time axes" tab.
The attribute can be assigned dynamic properties using the name BarTimeAxis. The data type
is STRING.
BarUncertainColor property
BarUncertainColor
Values have an uncertain status if the initial value is unknown when Runtime starts or if a
substitute value is used. You can use the "BarUncertainColor" attribute to specify the color
used for identifying these values. The "BarUncertainColoring" attribute determines whether or
not this setting is evaluated.
The attribute can be assigned dynamic properties using the name BarUncertainColor. The
data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 329
VBS for Creating Procedures and Actions
1.14 VBS Reference
BarUncertainColoring property
BarUncertainColoring
Values have an uncertain status if the initial value is unknown when Runtime starts or if a
substitute value is used. You can use the "BarUncertainColoring" attribute to enable
identification of such values based on the color set in "BarUncertainColor".
Value Explanation
TRUE The setting for the "BarUncertainColor" attribute is enabled.
FALSE The setting for the " BarUncertainColor " attribute is disabled.
The attribute can be assigned dynamic properties using the name BarUncertainColoring. The
data type is BOOLEAN.
BarUpperLimitColoring property
BarUpperLimitColoring
Specifies whether the "BarUpperLimitColor" attribute is used for designating tag values that
are higher than the value at "BarUpperLimit".
Value Explanation
TRUE The setting for the "BarUpperLimitColor" attribute is enabled.
FALSE The setting for the "BarUpperLimitColor" attribute is disabled.
The attribute can be assigned dynamic properties using the name BarUpperLimitColoring. The
data type is BOOLEAN.
BarUpperLimitColor property
BarUpperLimitColor
Specifies the color for designating tag values above the value at "BarUpperLimit". The setting
is enabled when the "BarUpperLimitColoring" attribute has the value "TRUE" hat.
The attribute can be assigned dynamic properties using the name BarUpperLimitColor. The
data type is LONG.
BarUpperLimit property
BarUpperLimit
Specifies the high limit of a tag. If the tag value is higher than "BarUpperLimit", the values are
designated with the color set in "BarUpperLimitColor". This setting is enabled when the
"BarUpperLimitColoring" attribute has the value "TRUE".
WinCC: Scripting (VBS, ANSI-C, VBA)
330 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties using the name BarUpperLimit. The data
type is DOUBLE.
BarValueAlignment property
Alignment - BarValueAlignment
Specifies the alignment of the displayed values for the "Bars with value" diagram type.
The following settings are available depending on the write direction of the bars:
● The write direction of bars is "From the right" or "From the left"
Value Description Explanation
0 Bottom The values are displayed at the bottom of the diagram window.
1 Centered The values are displayed at the center of the diagram window.
2 Top The values are displayed at the top of the diagram window.
● The write direction of bars is "From the top" or "From the bottom"
Value Description Explanation
0 Left The values are displayed at the left of the diagram window.
1 Centered The values are displayed at the center of the diagram window.
2 Right The values are displayed at the right of the diagram window.
The attribute can be assigned dynamic properties using the name BarValueAlignment. The
data type is LONG.
BarValueAxis property
Value axis - BarValueAxis
Specifies which value axis will be used for the selected diagram. You specify the available
value axes on the "Value axes" tab.
The attribute can be assigned dynamic properties using the name BarValueAxis. The data
type is STRING.
BarValueUnit property
Unit - BarValueUnit
Specifies a unit of the values that will be appended to the value to be displayed for the "Bars
with value" diagram type. e.g. "%" or "°C"
The attribute can be assigned dynamic properties using the name BarValueUnit. The data type
is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 331
VBS for Creating Procedures and Actions
1.14 VBS Reference
BarVisible property
Diagram - BarVisible
The list shows the diagrams you have created.
Select the diagrams in the list that you want to display in the diagram windows.
Click on a diagram in the list to adapt the properties and to assign axes and diagram windows
to the diagram.
The attribute can be assigned dynamic properties using the name BarVisible. The data type
is BOOLEAN.
BarWindowAdd property
New - BarWindowAdd
Creates a new diagram window.
The attribute can be assigned dynamic properties using the name BarWindowAdd. The data
type is STRING.
BarWindowCoarseGrid property
Main scaling - BarWindowCoarseGrid
Enables the display of grid lines for the main scale.
Value Explanation
TRUE Enables the display of grid lines for the main scale.
FALSE Disables the display of grid lines for the main scale.
The attribute can be assigned dynamic properties using the name BarWindowCoarseGrid. The
data type is BOOLEAN.
BarWindowCoarseGridColor property
Color main scale - BarWindowCoarseGridColor
Specifies the color of the grid lines for the main scale. Use the button to open the "Color
selection" dialog to select the color.
The attribute can be assigned dynamic properties using the name
BarWindowCoarseGridColor. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
332 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BarWindowCount property
BarWindowCount
Specifies the number of configured diagrams.
The attribute can be assigned dynamic properties using the name BarWindowCount. The data
type is LONG.
BarWindowFineGrid property
Secondary scaling - BarWindowFineGrid
Specifies whether the grid lines are displayed for the secondary scale.
Value Explanation
TRUE Enables the display of grid lines for the secondary scale.
FALSE Disables the display of grid lines for the secondary scale.
The attribute can be assigned dynamic properties using the name BarWindowFineGrid. The
data type is BOOLEAN.
BarWindowFineGridColor property
Color secondary scale - BarWindowFineGridColor
Specifies the color of the grid lines for the secondary scale. Use the button to open the "Color
selection" dialog to select the color.
The attribute can be assigned dynamic properties using the name BarWindowFineGridColor.
The data type is LONG.
BarWindowForegroundBarGrid property
For foreground diagram only - BarWindowForegroundBarGrid
Specifies whether the grid lines for the foreground diagram only will be displayed in the selected
diagram window.
Value Explanation
TRUE The grid lines for the foreground diagram are displayed in the diagram window.
FALSE The grid lines for all diagrams are displayed in the diagram window.
The attribute can be assigned dynamic properties using the name
BarWindowForegroundBarGrid. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 333
VBS for Creating Procedures and Actions
1.14 VBS Reference
BarWindowGapWidth property
Gap width - BarWindowGapWidth
Specifies the gap between two bars of a bar diagram in % of the bar width.
The attribute can be assigned dynamic properties using the name BarWindowGapWidth. The
data type is LONG.
BarWindowGridInBarColor property
In diagram color - BarWindowGridInBarColor
Specifies whether the grid lines for the main scaling will be displayed in the color of the bars.
Value Explanation
TRUE The grid lines are displayed in the color of the bars.
FALSE The grid lines are displayed with the color set in the "Color" field.
The attribute can be assigned dynamic properties using the name BarWindowGridInBarColor.
The data type is BOOLEAN.
BarWindowHorizontalGrid property
For value axes - BarWindowHorizontalGrid
Enables the display of horizontal grid lines for value axes.
Value Explanation
TRUE Display of horizontal grids for value axes is enabled.
FALSE Display of horizontal grid lines for value axes is disabled.
The attribute can be assigned dynamic properties using the name BarWindowHorizontalGrid.
BarWindowIndex property
BarWindowIndex
References a configured diagram. Using this attribute, you can assign the values of other
attributes to a specific diagram.
Valid values for "BarWindowIndex" are between 0 and "BarWindowCount" minus 1. The
"BarWindowCount" attribute specifies the number of configured diagrams.
The "BarWindowIndex" attribute can be assigned dynamic properties using the attribute
BarWindowRepos. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
334 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BarWindowName property
Object name - BarWindowName
Specifies the name of the selected diagram window.
The "BarWindowName" attribute can be assigned dynamic properties using the attribute
BarWindowRename. The data type is STRING.
BarWindowRemove property
Remove - BarWindowRemove
Removes the selected diagram window from the list.
The attribute can be assigned dynamic properties using the name BarWindowRemove. The
data type is STRING.
BarWindowRename property
BarWindowRename
Renames the diagram window, which is referenced using the "BarWindowIndex" attribute.
The attribute can be assigned dynamic properties using the name BarWindowRename. You
can use "BarWindowRename" to also assign dynamic properties to the "BarWindowName"
attribute. The data type is STRING.
BarWindowRepos property
Up/down - BarWindowRepos
Changes the order of the diagram windows. "Up" and "Down" move the selected diagram
windows up and down in the list.
The order in the list determines the position in the Control. The first diagram window is
displayed at the bottommost position, the last diagram window is displayed at the topmost
position.
The attribute can be assigned dynamic properties using the name BarWindowRepos. The data
type is LONG.
BarWindowSeriesOverlap property
Overlap - BarWindowBarOverlap
Specifies the overlap of various bars of a time instant in % of the bar width.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 335
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties using the name BarWindowBarOverlap. The
data type is LONG.
BarWindowSpacePortion property
Proportional area - BarWindowSpacePortion
Specifies the portion of the selected diagram window for the display in the control.
The attribute can be assigned dynamic properties using the name BarWindowSpacePortion.
The data type is LONG.
BarWindowVerticalGrid property
For time axes- BarWindowVerticalGrid
Enables the display of vertical grid lines for time axes.
Value Explanation
TRUE Display of vertical grid lines for time axes is enabled.
FALSE Display of vertical grid lines for time axes is disabled.
The attribute can be assigned dynamic properties using the name BarWindowVerticalGrid.
BarWindowVisible property
Diagram window - BarWindowVisible
The list shows the diagram windows you have created.
Select the diagram windows in the list that you want to display in the control.
Click on an entry in the list to adapt the properties of the bar display and the grid lines.
The attribute can be assigned dynamic properties using the name BarWindowVisible. The data
type is BOOLEAN.
BarWidth Property
Description
Defines or returns the width of the bar in pixels.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
336 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BarChartAlignment property
Alignment - BarChartAlignment
Specifies the alignment of the bar in the diagram.
The following settings are available depending on the write direction of the bars:
● The write direction of bars is "From the right" or "From the left"
Value Description Explanation
0 Left The bars are shown left justified on the graph.
1 Centered The bars are centered in the graph.
2 Right The bars are shown right justified on the graph.
● The write direction of bars is "From the top" or "From the bottom"
Value Description Explanation
0 Top The bars are shown at the top of the graph.
1 Centered The bars are centered in the graph.
2 Bottom The bars are shown at the bottom of the graph.
The attribute can be dynamized with the BarChartAlignment name. The data type is LONG.
BasePicReferenced Property
Description
TRUE, when the picture assigned in the object status display should be saved. Otherwise,
only the associated object reference is saved. Read only access.
See also
Status display (Page 197)
ScreenItem Object (Page 123)
BasePicTransColor Property
Description
Defines or returns which color of the assigned bitmap object (.bmp, .dib) should be set to
"transparent". LONG Write/Read Access.
The color is only set to "Transparent" if the value of the "BasePicUseTransColor" property is
"True".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 337
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Status display (Page 197)
ScreenItem Object (Page 123)
BasePicture Property
Description
Returns the basic picture for the object status display. Read-only access.
The picture (*.BMP or *.DIB) must be located in the "GraCS" directory of the current project
so that it can be integrated.
In this context, the "BasePicReferenced" property defines whether the basic picture should be
saved together with the object status display or referenced.
See also
Status display (Page 197)
ScreenItem Object (Page 123)
BasePicUseTransColor Property
Description
TRUE, when the configured color ("BasePicTransColor" property) of the bitmap objects should
be set to "transparent". BOOLEAN write-read access.
See also
Status display (Page 197)
ScreenItem Object (Page 123)
BaseScreenName Property
Function
Defines or returns the current basic picture.
STRING (write-read access)
A picture change is executed using the
HMIRuntime.BaseScreenName = (<Serverpräfix>::)<Neues Grundbild>
command.
WinCC: Scripting (VBS, ANSI-C, VBA)
338 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
When reading out the "BaseScreenName" property, only the picture name without server prefix
is returned.
Note
Always enter picture names without the extension "PDL" for reasons of compatibility with future
versions.
Example:
The following example executes a picture change to "bild1.pdl":
HMIRuntime.BaseScreenName = "bild1"
See also
ScreenItem Object (Page 123)
HMIRuntime Object (Page 116)
BaseY Property
Description
Defines or returns the vertical distance of the bottom bar edge to the top edge of the objet field.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
BaseX Property
Description
Defines or returns the horizontal distance of the right bar edge to the left edge of the object
field in pixels.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 339
VBS for Creating Procedures and Actions
1.14 VBS Reference
Be - Bl
BeginTime Property
Description
WinCC Online Trend Control
The "Index" property references a pair of columns. "BeginTime" defines the start time for
displaying this column pair. Write/Read access.
WinCC Online Trend Control
The "Index" property references a trend. "BeginTime" defines the start time for displaying this
trend. Whether the information is evaluated is dependent on the TimeRange" and "CommonX"
properties.
Use the "yyyy-mm-dd hh:mm:ss" format when creating a dynamic time range.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
BeginValue Property
Description
The "Index" property references a trend. "BeginValue" defines the lower limit of the value range
to be displayed for the trend. Whether the information is evaluated is dependent on the
"Autorange" and "CommonY" properties.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
BeginX Property
Description
Defines or returns the lower limit of the X-axis of a trend referenced with the "Index" property.
Whether the information is evaluated is dependent on the "AutorangeX" and "CommonX"
properties.
WinCC: Scripting (VBS, ANSI-C, VBA)
340 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
BeginY Property
Description
Defines or returns the lower limit of the Y-axis of a trend referenced with the "Index" property.
Whether the information is evaluated is dependent on the "AutorangeY" and "CommonY"
properties.
See also
ScreenItem Object (Page 123)
WinCC Function Trend Control (before WinCC V7) (Page 281)
BevelColorDown Property
Description
Defines the color of the following border sections in the case of 3D representation of the
borders:
● with depressed bevel ("BevelStyle" = 1): top and left bevel section
● with raised bevel ("BevelStyle" = 2): bottom and right bevel section
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
BevelColorUp Property
Description
Defines the color of the following border sections in the case of 3D representation of the
borders:
● with depressed bevel ("BevelStyle" = 1): bottom and right bevel section
● with raised bevel ("BevelStyle" = 2): top and left bevel section
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 341
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
BevelInner Property
Description
Defines or returns the appearance of the inner part of the object bevel. Write/Read access.
● 0: inner part not available
● 1: "depressed" appearance
● 2: "raised" appearance
● 3: uniform gray border
● 4 or higher: uniformly colored order, border color = background color
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
BevelOuter Property
Description
Defines or returns the appearance of the outer part of the object bevel. Write/Read access.
● 0: inner part not available
● 1: "depressed" appearance
● 2: "raised" appearance
● 3: uniform gray border
● 4 or higher: uniformly colored order, border color = background color
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
342 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BevelWidth Property
Description
Defines or returns the border width for the inner part of the border (inner bevel) and for the
outer border part (outer bevel) in pixels. Write/Read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
BitNumber Property
Description
Defines or returns the bit whose status must change in order to trigger a change of value. The
tag used must be of the type BYTE, WORD or DWORD.
See also
Text list (Page 194)
ScreenItem Object (Page 123)
BlinkColor Property
Description
Defines the color of the icon in the flash picture. LONG write-read access.
See also
HMI Symbol Library (Page 237)
ScreenItem Object (Page 123)
BlinkMode property
Flash mode (BlinkMode)
Specifies the flash mode of the icon in runtime.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 343
VBS for Creating Procedures and Actions
1.14 VBS Reference
The following settings are available:
Value Description Comments
0 No flashing The icon does not flash.
1 Hidden The icon flashes in the background color.
2 Shadow The icon flashes with shading in the foreground color.
3 Solid The icon flashes in the foreground color.
The attribute can be assigned dynamic properties by means of the name BlinkMode. The data
type is LONG.
BlinkSpeed property
Flash rate (BlinkSpeed)
Specifies the length of the icon flash interval in Runtime.
The following settings are available:
Value Description Comments
250 Fast Flash interval of 250 ms.
500 Medium Flash interval of 500 ms.
1000 Slow Flash interval of 1000 ms.
The attribute can be assigned dynamic properties by means of the name BlinkSpeed. You can
also use other values. The data type is LONG.
BlockAlign property
Block alignment - BlockAlign
Defines the mode of aligning the caption of blocks in column headers.
The following settings are available:
Value Description Explanation
0 left The block caption is left justified.
1 centered The block caption is aligned to center.
2 right The block caption is right justified.
The attribute can be assigned dynamic properties by means of the name BlockAlign. The data
type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
344 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BlockAutoPrecisions property
Decimal places automatic - BlockAutoPrecisions
Enables automatic setting of the decimal precision.
Value Explanation
TRUE The decimal precision is defined automatically. The value in the "Decimal places" field is disabled.
FALSE The value in the "Decimal places" field is enabled.
The attribute can be assigned dynamic properties by means of the name
BlockAutoPrecisions. The data type is BOOLEAN.
BlockCaption property
Caption - BlockCaption
Defines the caption of the column header in the control for the selected message block.
The caption is active in all Runtime languages.
The attribute can be assigned dynamic properties by means of the name BlockCaption. The
data type is STRING.
BlockCount property
BlockCount
Specifies the number of blocks to be made available as columns for the control.
The attribute can be assigned dynamic properties by means of the name BlockCount. The
data type is LONG.
BlockDateFormat property
Date format - BlockDateFormat
Defines the date format for visualization.
The following date formats are available:
Value Explanation
Automatic The date format is set automatically.
dd.MM.yy Day.Month.Year, e.g. 24.12.07.
dd.MM.yyyy Day.Month.Year, e.g. 24.12.2007.
dd/MM/yy Day/Month/Year, e.g. 24/12/07.
dd/MM/yyyy Day/Month/Year, e.g. 24/12/2007.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 345
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name BlockDateFormat.
The data type is STRING.
BlockDurationTimeFormat property
BlockDurationTimeFormat
Defines which duration format will be used for the display in the block.
To change the setting, the option “Take from source" must be deactivated or
"BlockUseSourceFormat" must be set to "FALSE".
The following time duration formats are available:
Value Explanation
Automatic The time duration format is determined automatically.
d H:mm:ss Day Hours:Minutes:Seconds
Example: 1 2:03:55
H:mm:ss. Hours:Minutes:Seconds
Example: 26:03:55
m:ss Minutes:Seconds
Example: 1563:55
s Seconds
Example: 93835
d H:mm:ss. Day Hours:Minutes:Seconds.Milliseconds
ms Example: 1 2:03:55.150
H:mm:ss.m Hours:Minutes:Seconds.Milliseconds
s Example: 26:03:55.150
m:ss.ms Minutes:Seconds.Milliseconds
Example: 1563:55.150
s.ms Seconds.Milliseconds
Example: 2.150
The attribute can be assigned dynamic properties by means of the name
BlockDurationTimeFormat. The data type is STRING.
BlockExponentialFormat property
Exponential notation - BlockExponentialFormat
Specifies exponential notation for the display of values of a selected block.
Value Explanation
TRUE The values are displayed with exponential notation.
FALSE The values are displayed with decimal notation.
The attribute can be assigned dynamic properties by means of the name
BlockExponentialFormat. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
346 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BlockHideText property
Content as text - BlockHideText
Enables the textual display of the content of a selected block.
Value Explanation
TRUE The content is not displayed in text format. The option is disabled.
FALSE The content is displayed in text format. The option is enabled.
The attribute can be assigned dynamic properties by means of the name BlockHideText. The
data type is BOOLEAN.
BlockHideTitleText property
Title as text - BlockHideTitleText
Enables the display of the header of a selected block in text format.
Value Explanation
TRUE The header is not displayed in text format. The option is disabled.
FALSE The header is displayed in text format. The option is enabled.
The attribute can be assigned dynamic properties by means of the name BlockHideTitleText.
The data type is BOOLEAN.
BlockId property
BlockId
Default assignment of the ID number and of the block in WinCC RulerControl:
Value Description
0 No block
1 Name
2 Index
3 Designation
4 Display
5 Tag name Y
6 Tag name X
7 Y value
8 X value/time stamp
9 Y value (LL)
10 Time stamp (LL)
11 Y value (UL)
12 Time stamp (UL)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 347
VBS for Creating Procedures and Actions
1.14 VBS Reference
Value Description
13 Minimum
14 Minimum - Time stamp
15 Maximum
16 Maximum - Time stamp
17 Average
18 Standard deviation
19 Integral
20 Weighted mean value
21 Duration
22 Number of values
The attribute can be assigned dynamic properties by means of the name BlockID. The data
type is LONG.
BlockIndex property
BlockIndex
References a block. Using this attribute you can assign the values of other attributes to a
specific block.
Values between 0 and "BlockCount" minus 1 are valid for "BlockIndex". Attribute "BlockCount"
defines the number of available blocks.
The attribute can be assigned dynamic properties by means of the name BlockIndex. The data
type is LONG.
BlockLength property
Length in characters - BlockLength
Specifies the column width for a selected block.
The attribute can be assigned dynamic properties by means of the name BlockLength. The
data type is LONG.
BlockName property
Object name - BlockName
Displays the name of the block selected. You cannot edit this name.
The attribute can be assigned dynamic properties by means of the name BlockName. The
data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
348 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BlockPrecisions property
Decimal places - BlockPrecisions
Specifies the number of decimal places of the values in the selected column. You can only
enter the value if the "Automatic" option is disabled.
The attribute can be assigned dynamic properties by means of the name BlockPrecisions. The
data type is SHORT.
BlockShowDate property
Display date - BlockShowDate
Specifies if the "Time" block is displayed with time and date in a field.
Value Explanation
TRUE The date and time are displayed. The date format is defined in the "Date format" field.
FALSE The time is displayed.
The attribute can be assigned dynamic properties by means of the name BlockShowDate. The
data type is BOOLEAN.
BlockShowIcon property
Content as icon - BlockShowIcon
Enables the display of the content of a selected block as icon. This function is only available
in WinCC Alarm Control.
Value Explanation
TRUE The content is visualized as icon.
FALSE The content is not visualized as icon.
The attribute can be assigned dynamic properties by means of the name BlockShowIcon. The
data type is BOOLEAN.
BlockShowTitleIcon property
Title as icon - BlockShowTitleIcon
Enables the display of the header of a selected block as icon. This function is only available
in WinCC Alarm Control.
Value Explanation
TRUE The header is displayed as icon.
FALSE The header is not displayed as icon.
The attribute can be assigned dynamic properties by means of the name BlockShowTitleIcon.
The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 349
VBS for Creating Procedures and Actions
1.14 VBS Reference
BlockTimeFormat property
Time format - BlockTimeFormat
Defines the time format to be used for visualization.
The following time formats are available:
Value Explanation
Automatic The time format is set automatically.
HH:mm:ss.ms Hours:Minutes:Seconds, e.g. 15:35:44.240.
hh:mm:ss tt Hours:Minutes:Seconds AM/PM, e.g. 03:35:44 PM.
hh:mm:ss.ms tt Hours:Minutes:Seconds.Milliseconds AM/PM, e.g. 03:35:44.240 PM.
The attribute can be assigned dynamic properties by means of the name BlockTimeFormat.
The data type is STRING.
BlockUseSourceFormat property
Use source format - BlockUseSourceFormat
Specifies that the format is inherited from the interconnected control. Here the size of the
control, the zoom factor and the value range are taken into consideration to display the optimal
number of decimal places.
Value Explanation
TRUE The formats are derived from the interconnected control.
FALSE The formats configured in Ruler Control are used, for example, the display of a precisely specified number of
decimal places.
The attribute can be assigned dynamic properties by means of the name
BlockUseSouceFormat. The data type is BOOLEAN.
Bo - Bu
BorderBackColor Property
Description
Defines or returns the background color of the line for the object. LONG write-read access.
The background color is only visible with the property setting "BorderWidth" > 0.
See also
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
350 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BorderColor Property
Description
Defines or returns the line color for the object. LONG write-read access.
See also
ScreenItem Object (Page 123)
BorderColor property
Border color - BorderColor
Specifies the border color. The button opens the "Color selection" dialog.
The attribute can be assigned dynamic properties by means of the name BorderColor. The
data type is LONG.
BorderColorBottom Property
Description
Defines or returns the border color for the bottom/right part of the object. LONG write-read
access.
See also
ScreenItem Object (Page 123)
Button (Page 199)
Round Button (Page 207)
BorderColorTop Property
Description
Defines or returns the border color for the top/left part of the object. LONG write-read access.
See also
Button (Page 199)
Round Button (Page 207)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 351
VBS for Creating Procedures and Actions
1.14 VBS Reference
BorderEndStyle Property
Description
Defines or returns the line end style of the object. LONG write-read access.
See also
Polyline (Page 156)
Line (Page 152)
ScreenItem Object (Page 123)
BorderFlashColorOff Property
Description
Defines or returns the color of the object lines for the flashing status "Off". LONG write-read
access.
See also
ScreenItem Object (Page 123)
BorderFlashColorOn Property
Description
Defines or returns the color of the object lines for the flashing status "On". LONG write-read
access.
See also
ScreenItem Object (Page 123)
BorderStyle Property
Description
Defines or returns the line style for the object. Value range from 0 to 4.
0 = solid line
1 = dashed line
2 = dotted line
3 = dash-dotted line
WinCC: Scripting (VBS, ANSI-C, VBA)
352 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
4 = dash-dot-dot line
See also
ScreenItem Object (Page 123)
BorderWidth Property
Description
Defines or returns the line weight (in pixels) for the object.
WinCC Gauge Control:
Defines or returns the width of the middle border part in pixels.
The object border is composed of three parts. The middle part of the object border is described
by the "BorderWidth" property.
The color of the middle border part is in the background color.
See also
ScreenItem Object (Page 123)
BorderWidth property
Border width - BorderWidth
Specifies the line weight of the border in pixels.
The attribute can be assigned dynamic properties by means of the name BorderWidth. The
data type is LONG.
BottomConnectedConnectionPointIndex Property
Description
Specifies or sets the index number of the bottom connecting point.
LONG write-read access.
See also
Connector (Page 165)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 353
VBS for Creating Procedures and Actions
1.14 VBS Reference
BottomConnectedObjectName Property
Description
Specifies or sets the object name of the object which is docked on at the bottom connecting
point.
LONG write-read access.
See also
Connector (Page 165)
ScreenItem Object (Page 123)
BoxAlignment Property
Description
TRUE, when the fields are arranged aligned to the right. BOOLEAN write-read access.
See also
Radio box (Page 205)
Check box (Page 202)
ScreenItem Object (Page 123)
BoxCount Property
Description
Defines or returns the number of fields. Value range from 0 to 63.
See also
Radio box (Page 205)
Check box (Page 202)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
354 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
BoxType Property
Description
Defines or returns the field type. Value range from 0 to 2:
● 0: Edition
● 1: Input
● 2: I/O field
See also
Text list (Page 194)
I/O Field (Page 182)
ScreenItem Object (Page 123)
ButtonColor Property
Description
Defines or returns the color of the slider. LONG write-read access.
See also
Slider (Page 210)
ScreenItem Object (Page 123)
ButtonCommand Property
Description
Upon changing a value of "ButtonCommand", a message is issued to the WinCC Alarm Control
in order to adapt the display in the message window.
Value (hex); value (dec); Retrieved Function:
● 0x00000001; 1; Message list
● 0x00000002; 2; Short-term archive list
● 0x00000004; 4; Long-term archive list
● 0x00200000; 2097152; Lock list
● 0x00000008; 8; Acknowledge central signaling device
● 0x00000010; 16; Single Acknowledgment
● 0x00000020; 32; Group Acknowledge
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 355
VBS for Creating Procedures and Actions
1.14 VBS Reference
● 0x00000040; 64; Autoscroll
● 0x00000080; 128; Selection Dialog
● 0x00000100; 256; Lock Dialog
● 0x00000200; 512; Print Message Log
● 0x00000800; 2048; Emergency Acknowledgment
● 0x00001000; 4096; First Message
● 0x00002000; 8192; Last Message
● 0x00004000; 16384; Next Message
● 0x00008000; 32768; Previous Message
● 0x00010000; 65536; Infotext Dialog
● 0x00020000; 131072; Comments Dialog
● 0x00040000; 262144; Loop in Alarm
● 0x00100000; 1048576; Print current view
● 0x00400000; 4194304; Lock/unlock message
● 0x00800000; 8388608; Sorting Dialog
● 0x01000000; 16777216; Time base dialog
● 0x02000000; 33554432; Hit list
● 0x04000000; 67108864; List of messages to be hidden
● 0x08000000; 134217728; Show/hide message
● 0x10000000; 268435456; Display option dialog
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
Button1MessageClasses property
Message Types for Button 1 (Button1MessageClasses)
Define one or more message events for displaying the first button in the group display. This is
done by entering the numbers of the bits in the collect value. The display of the message events
is configured in the "Message Types" property group.
If you want to assign several message events, separate the numbers with a comma. The
sequence of the assignment defines the priority. If there are more than one selected event for
one button, the event that has been entered first is displayed.
One event can be displayed simultaneously in more than one button.
The "Message Types for Button 1" attribute can be assigned dynamic properties with the name
"Button1MessageClasses".
WinCC: Scripting (VBS, ANSI-C, VBA)
356 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Button2MessageClasses property
Message Types for Button 2 (Button2MessageClasses)
For displaying both buttons, define one or more message events in the group display. This is
done by entering the number of the bit in the collect value. The display of the message events
is configured in the "Message Types" property group.
If you want to assign several message events, separate the numbers with a comma. The
sequence of the assignment defines the priority. If there are more than one selected event for
one button, the event that has been entered first is displayed.
The same event can be visualized simultaneously in several buttons.
The "Message Types for Button 2" attribute can be assigned dynamic properties with the name
"Button2MessageClasses".
Button3MessageClasses property
Message Types for Button 3 (Button3MessageClasses)
For displaying the third button, define one or more message events in the group display. This
is done by entering the number of the bit in the collect value. The display of the message events
is configured in the "Message Types" property group.
If you want to assign several message events, separate the numbers with a comma. The
sequence of the assignment defines the priority. If there are more than one selected event for
one button, the event that has been entered first is displayed.
The same event can be visualized simultaneously in several buttons.
The "Message Types for Button 3" attribute can be assigned dynamic properties with the name
"Button3MessageClasses".
Button4MessageClasses property
Message Types for Button 4 (Button4MessageClasses)
For displaying the fourth button, define one or more message events in the group display. This
is done by entering the number of the bit in the collect value. The display of the message events
is configured in the "Message Types" property group.
If you want to assign several message events, separate the numbers with a comma. The
sequence of the assignment defines the priority. If there are more than one selected event for
one button, the event that has been entered first is displayed.
The same event can be visualized simultaneously in several buttons.
The "Message Types for Button 4" attribute can be assigned dynamic properties with the name
"Button4MessageClasses".
Button5MessageClasses property
Message Types for Button 5 (Button5MessageClasses)
For displaying the fifth button, define one or more message events in the group display. This
is done by entering the number of the bit in the collect value. The display of the message events
is configured in the "Message Types" property group.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 357
VBS for Creating Procedures and Actions
1.14 VBS Reference
If you want to assign several message events, separate the numbers with a comma. The
sequence of the assignment defines the priority. If there are more than one selected event for
one button, the event that has been entered first is displayed.
The same event can be visualized simultaneously in several buttons.
The "Message Types for Button 5" attribute can be assigned dynamic properties with the name
"Button5MessageClasses".
Button6MessageClasses property
Message Types for Button 6 (Button6MessageClasses)
For displaying the sixth button, define one or more message events in the group display. This
is done by entering the number of the bit in the collect value. The display of the message events
is configured in the "Message Types" property group.
If you want to assign several message events, delimit the numbers with a comma. The order
of assignment defines the priority. If there are more than one selected event for one button,
the event that has been entered first is displayed.
The same event can be visualized simultaneously in several buttons.
The "Message Types for Button 6" attribute can be assigned dynamic properties with the name
"Button6MessageClasses".
Button7MessageClasses property
Message Types for Button 7 (Button7MessageClasses)
For displaying the seventh button, define one or more message events in the group display.
This is done by entering the number of the bit in the collect value. The display of the message
events is configured in the "Message Types" property group.
If you want to assign several message events, delimit the numbers with a comma. The order
of assignment defines the priority. If there are more than one selected event for one button,
the event that has been entered first is displayed.
The same event can be visualized simultaneously in several buttons.
The "Message Types for Button 7" attribute can be assigned dynamic properties with the name
"Button7MessageClasses".
Button8MessageClasses property
Message Types for Button 8 (Button8MessageClasses)
For displaying the eighth button, define one or more message events in the group display. This
is done by entering the number of the bit in the collect value. The display of the message events
is configured in the "Message Types" property group.
If you want to assign several message events, delimit the numbers with a comma. The order
of assignment defines the priority. If there are more than one selected event for one button,
the event that has been entered first is displayed.
The same event can be visualized simultaneously in several buttons.
WinCC: Scripting (VBS, ANSI-C, VBA)
358 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The "Message Types for Button 8" attribute can be assigned dynamic properties with the name
"Button8MessageClasses".
Button1Width Property
Description
Defines or returns the width of the Button 1 in pixels.
When the SameSize property is set to TRUE, all the buttons are specified the same width.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
Button2Width Property
Description
Defines or returns the width of the Button 2 in pixels.
When the SameSize property is set to TRUE, all the buttons are specified the same width.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
Button3Width Property
Description
Defines or returns the width of the Button 3 in pixels.
When the SameSize property is set to TRUE, all the buttons are specified the same width.
See also
ScreenItem Object (Page 123)
Group Display (Page 192)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 359
VBS for Creating Procedures and Actions
1.14 VBS Reference
Button4Width Property
Description
Defines or returns the width of the Button 4 in pixels.
When the SameSize property is set to TRUE, all the buttons are specified the same width.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
1.14.4.4 C
Ca - Cl
Caption Property
Description
Application and picture windows
TRUE, when the application or picture window has a title bar in Runtime. Read only access.
The Caption property must be set to TRUE when the application or picture window should
have Maximize and Close buttons.
Controls before WinCC V7
Defines or returns the text to be displayed on the label on the button or in the title bar (Online
Trend Control and Online Table Control). Write/Read access.
See also
Controls (Page 216)
Picture Window (Page 177)
Application Window (Page 171)
ScreenItem Object (Page 123)
Caption property
Text - Caption
Defines the text of the window caption.
WinCC: Scripting (VBS, ANSI-C, VBA)
360 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name Caption. The data
type is STRING.
CaptionColor Property
Description
Defines or returns the color of the element labeling. LONG write-read access.
See also
ScreenItem Object (Page 123)
WinCC Gauge Control (Page 251)
CaptionFont Property
Description
Returns the values for font, font style and font size as well as the "Underline" and
"Strikethrough" effects for the element labeling. Read only access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
CaptionOffset Property
Description
Defines or returns the distance of the element labeling in relation to the top edge of the object.
The element labeling can only be positioned along the vertical diameter of the graduated scale
disk. The value of the attribute is related to the height of the object and is measured from the
top edge of the object to the base of the text. Write/Read access.
The value range is 0 to 1:
0: The base of the text is at the top limit of the object. The text is no longer visible because it
is outside the object.
1: The base of the text is at the bottom limit of the object.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 361
VBS for Creating Procedures and Actions
1.14 VBS Reference
CaptionText property
Description
Defines the window title that is displayed in Runtime or returns it. The window title is displayed
as "Header" object property.
The Caption property must be set to TRUE.
See also
Picture Window (Page 177)
ScreenItem Object (Page 123)
CellCount property
CellCount
Specifies the number of cells of the Row object of a Table Control. The number of cells
corresponds to the number of columns.
CellCut property (before WinCC V7)
Description
TRUE, when the content of the cells in a message line should be cut if the column width is too
small. BOOLEAN write-read access.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
CellCut property
Shorten contents - CellCut
Shortens cell contents if the cell width is insufficient.
Value Explanation
TRUE Enables shortening of cell contents.
FALSE Disables shortening of cell contents.
The attribute can be assigned dynamic properties by means of the name CellCut. The data
type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
362 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
CellSpaceBottom property
CellSpaceBottom
Defines the bottom margin of the table cells.
The attribute can be assigned dynamic properties by means of the name CellSpaceBottom.
The data type is LONG.
CellSpaceLeft property
CellSpaceLeft
Defines the left indent of the table cells.
The attribute can be assigned dynamic properties by means of the name CellSpaceLeft . The
data type is LONG.
CellSpaceRight property
CellSpaceRight
Defines the right indent of the table cells.
The attribute can be assigned dynamic properties by means of the name CellSpaceRight . The
data type is LONG.
CellSpaceTop property
CellSpaceTop
Defines the top margin of the table cells.
The attribute can be assigned dynamic properties by means of the name CellSpaceTop . The
data type is LONG.
CellText property
CellText
Returns the contents of a cell as a string. The cell is determined from the column number of
the row object, e.g. CellText(3) for the third column. Numbering runs from "1" to "CellCount".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 363
VBS for Creating Procedures and Actions
1.14 VBS Reference
CenterColor Property
Description
Defines or returns the color of the circular center of the scale (cover of the pointer axis). LONG
write-read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
CenterScale Property
Description
Defines or returns the diameter of the circular center of the scale (cover of the pointer axis) in
relation to the smaller value of the geometric width and height attributes. Write/Read access.
The value range is 0.03 to 1:
1: The diameter corresponds to the smaller value of the "Width" or "Height" geometric values.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
CheckAlarmHigh Property
Description
TRUE, when the "AlarmHigh" limit value is to be monitored. BOOLEAN write/read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
by means of the "AlarmHigh", "ColorAlarmHigh" and "TypeAlarmHigh" properties.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
364 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
CheckAlarmLow Property
Description
TRUE, when the "AlarmLow" limit value is to be monitored. BOOLEAN write/read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
by means of the "AlarmLow", "ColorAlarmLow" and "TypeAlarmLow" properties.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
CheckLimitHigh4 Property
Description
TRUE, when the "Reserve 4" upper limit value should be monitored. BOOLEAN write/read
access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
by means of the "LimitHigh4", "ColorLimitHigh4" and "TypeLimitHigh4" properties.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
CheckLimitHigh5 Property
Description
TRUE, when the "Reserve 5" upper limit value should be monitored. BOOLEAN write/read
access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
by means of the "LimitHigh5", "ColorLimitHigh5" and "TypeLimitHigh5" properties.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 365
VBS for Creating Procedures and Actions
1.14 VBS Reference
CheckLimitLow4 Property
Description
TRUE, when the "Reserve 4" lower limit value should be monitored. BOOLEAN write/read
access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
by means of the "LimitLow4", "ColorLimitLow4" and "TypeLimitLow4" properties.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
CheckLimitLow5 Property
Description
TRUE, when the "Reserve 5" lower limit value should be monitored. BOOLEAN write/read
access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
by means of the "LimitLow5", "ColorLimitLow5" and "TypeLimitLow5" properties.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
CheckToleranceHigh Property
Description
TRUE, when the "ToleranceHigh" limit value is to be monitored. BOOLEAN write/read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
by means of the "ToleranceHigh", "ColorToleranceHigh" and "TypeToleranceHigh" properties.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
366 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
CheckToleranceLow Property
Description
TRUE, when the "ToleranceLow" limit value is to be monitored. BOOLEAN write/read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
by means of the "ToleranceLow", "ColorToleranceLow" and "TypeToleranceLow" properties.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
CheckWarningHigh Property
Description
TRUE, when the "WarningHigh" limit value is to be monitored. BOOLEAN write/read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
by means of the "WarningHigh", "ColorWarningHigh" and "TypeWarningHigh" properties.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
CheckWarningLow Property
Description
TRUE, when the "WarningLow" limit value is to be monitored. BOOLEAN write/read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
by means of the "WarningLow", "ColorWarningLow" and "TypeWarningLow" properties.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 367
VBS for Creating Procedures and Actions
1.14 VBS Reference
ClearOnError Property
Description
TRUE, when the field entry is automatically deleted in the case of invalid input. BOOLEAN
write-read access.
See also
I/O Field (Page 182)
ScreenItem Object (Page 123)
ClearOnNew Property
Description
TRUE, when the field entry is deleted as soon as the I/O field has the focus. BOOLEAN write-
read access.
See also
I/O Field (Page 182)
ScreenItem Object (Page 123)
Closeable property (before WinCC V7)
Description
TRUE, when the window can be closed in Runtime. BOOLEAN write-read access.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
368 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Closeable property
Closeable
Defines whether the control can be closed in Runtime.
Value Explanation
TRUE The control can be closed in Runtime.
FALSE The control cannot be closed in Runtime.
The attribute can be assigned dynamic properties by means of the name Closeable. The data
type is BOOLEAN.
CloseButton Property
Description
TRUE, when the window is provided with a "Close" button. Read only access.
See also
Picture Window (Page 177)
Application Window (Page 171)
ScreenItem Object (Page 123)
Co
CoarseGrid Property
Description
TRUE when the value axis is scaled by long tick marks. The distance between two long tick
marks can be changed using the "CoarseGridValue" property. BOOLEAN write-read access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 369
VBS for Creating Procedures and Actions
1.14 VBS Reference
CoarseGridX Property
Description
TRUE, when the X-axis graduation is scaled by long tick marks. The distance between two
long tick marks can be changed using the "CoarseGridValueX" property. BOOLEAN write-read
access.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
CoarseGridY Property
Description
TRUE, when the Y-axis graduation is scaled by long tick marks. The distance between two
long tick marks can be changed using the "CoarseGridValueY" property. BOOLEAN write-read
access.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
CoarseGridValue Property
Description
Defines the distance between two long tick marks in the scale. Whether the information is
evaluated is dependent on the value of the "CoarseGrid" property.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
370 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
CoarseGridValueX Property
Description
Defines or returns the distance between two long tick marks on the graduation scale of the X-
axis. Whether the information is evaluated is dependent on the value of the "CoarseGridX"
property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
CoarseGridValueY Property
Description
Defines or returns the distance between two long tick marks on the graduation scale of the Y-
axis. Whether the information is evaluated is dependent on the value of the "CoarseGridY"
property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
CollectValue Property
Description
Contains the respective status of the active message class in Runtime as the start value. LONG
write/read access.
The value can be determined from the group display of hierarchically subordinate pictures by
making it dynamic using a tag.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 371
VBS for Creating Procedures and Actions
1.14 VBS Reference
ColMove Property
Description
TRUE, when the arrangement of columns can be changed. BOOLEAN write-read access.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
Color Property
Description
The "Index" property references a column pair or a trend. "Color" defines the color of the font
in the column or the trend. LONG write-read access. The color is defined as an RGB value.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
ColorAlarmHigh Property
Description
Defines or returns the bar color for the "AlarmHigh" limit value. LONG write/read access.
The "CheckAlarmHigh" property must have been set to TRUE if the bar color should change
on reaching the limit value.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
372 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ColorAlarmLow Property
Description
Defines or returns the bar color for the "AlarmLow" limit value. LONG write/read access.
The "CheckAlarmLow" property must have been set to TRUE if the bar color should change
on reaching the limit value.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
ColorBottom Property
Description
Defines or returns the color for the bottom/right stop of the slider object. LONG write-read
access.
See also
Slider (Page 210)
ScreenItem Object (Page 123)
ColorChangeType Property
Description
TRUE, if the change of color should occur segment by segment in the case of a color change
(e.g. on reaching a limit value). If set to FALSE, it defines the change of color for the entire
bar. BOOLEAN write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 373
VBS for Creating Procedures and Actions
1.14 VBS Reference
ColorLimitHigh4 Property
Description
Defines or returns the color for the "Reserve 4" upper limit value. LONG write/read access.
The "CheckLimitHigh4" property must have been set to TRUE if the bar color should change
on reaching the limit value.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
ColorLimitHigh5 Property
Description
Defines or returns the color for the "Reserve 5" upper limit value. LONG write/read access.
The "CheckLimitHigh5" property must have been set to TRUE if the bar color should change
on reaching the limit value.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
ColorLimitLow4 Property
Description
Defines or returns the color for the "Reserve 4" lower limit value. LONG write/read access.
The "CheckLimitLow4" property must have been set to TRUE if the bar color should change
on reaching the limit value.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
374 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ColorLimitLow5 Property
Description
Defines or returns the color for the "Reserve 5" lower limit value. LONG write/read access.
The "CheckLimitLow5" property must have been set to TRUE if the bar color should change
on reaching the limit value.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
ColorToleranceHigh Property
Description
Defines or returns the color for the "ToleranceHigh" upper limit value. LONG write/read access.
The "CheckToleranceHigh" property must have been set to TRUE if the bar color should
change on reaching the limit value.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
ColorToleranceLow Property
Description
Defines or returns the color for the "ToleranceLow" lower limit value. LONG write/read access.
The "CheckToleranceLow" property must have been set to TRUE if the bar color should change
on reaching the limit value.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
ColorTop Property
Description
Defines or returns the color for the top/left stop of the slider object. LONG write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 375
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Slider (Page 210)
ScreenItem Object (Page 123)
ColorWarningHigh Property
Description
Defines or returns the color for the "WarningHigh" upper limit value. LONG write/read access.
The "CheckWarningHigh" property must have been set to TRUE if the bar color should change
on reaching the limit value.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
ColorWarningLow Property
Description
Defines or returns the color for the "WarningLow" lower limit value. LONG write/read access.
The "CheckWarningLow" property must have been set to TRUE if the bar color should change
on reaching the limit value.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
ColTitle Property
Description
TRUE, when the columns in the message window should have a title bar. BOOLEAN write-
read access.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
376 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ColWidth Property
Description
TRUE, when it should be possible to change the widths of the columns in the message window.
The width of the columns can only be changed, however, when the "AutoScroll" property is
not active. BOOLEAN write-read access.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
Command Property
Description
TRUE, when updating of the values displayed in the control should be forced.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
Comment property (Alarm Logging)
Description
Reads or sets the Alarm object comment.
See also
Alarms object (list) (Page 108)
Comment property (Tag Logging)
Description
Reads the tag comment.
The comment text is language neutral.
STRING (read only)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 377
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
The example shows how the comment for the "Tag1" tag is output.
'VBS376
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
MsgBox objTag.Comment
The following example adds two tags to the TagSet list and outputs the comment of each tag
as trace.
'VBS377
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
HMIRuntime.Trace "Comment of Motor1: " & group(“Motor1”).Comment & vbNewLine
HMIRuntime.Trace "Comment of Motor2: " & group(“Motor2”).Comment & vbNewLine
See also
Tag Object (Page 135)
CommonTime Property
Description
TRUE, when a common time column is to be used in the table window. BOOLEAN write-read
access.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
CommonX Property
Description
TRUE, when the trends in the trend window should be displayed with a common X-axis.
BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
378 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
CommonY Property
Description
TRUE, when the trends in the trend window should be displayed with a common Y-axis.
BOOLEAN write-read access.
See also
ScreenItem Object (Page 123)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ComputerName property
Description
Returns the name of the computer on which the alarm object was triggered.
ComputerName (readonly)
See also
Alarms object (list) (Page 108)
Context property
Description
Reads or sets the alarm object server prefix.
See also
Alarms object (list) (Page 108)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 379
VBS for Creating Procedures and Actions
1.14 VBS Reference
ConnectBarWindows property
Connected diagram window - ConnectBarWindows
Specifies whether the configured diagram windows are connected. You must have configured
several diagram windows for this.
The connected diagram windows have the following properties:
● They can have a common X axis.
● They have a scroll bar.
● The zoom functions for a diagram window affect the connected diagram windows.
Value Description
TRUE All configured diagram windows are connected.
FALSE The diagram windows are displayed separately.
The attribute can be assigned dynamic properties using the name ConnectBarWindows. The
data type is BOOLEAN.
ConnectTrendWindows property
Connect trend windows - ConnectTrendWindows
Enables the connection of trend windows configured. You must have configured several trend
windows.
The connected trend windows have the following properties:
● They can have a common X axis.
● They have a scroll bar.
● They have a ruler.
● The zoom functions for a trend window affect the connected trend windows.
Value Description
TRUE All trend windows configured are connected.
FALSE The trend windows are displayed separately.
The attribute can be assigned dynamic properties by means of the name
ConnectTrendWindows. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
380 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ContinousChange Property
Description
Defines the type of transfer of the value defined by the slider ("Position" property) in Runtime:
● FALSE : The value of the "Position" property is transferred when the mouse button is
released.
● TRUE : The value of the "Position" property is transferred immediately following a change
of the slider position.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
Count property (listing)
Description
Supplies the number of elements in a list.
INTEGER (read-only access).
Example:
The example shows how the number of objects in a DataSet list is output.
'VBS165
HMIRuntime.Trace "Count: " & HMIRuntime.DataSet.Count & vbNewLine
The following example adds two tags to the TagSet list and outputs the count properties as
Trace.
'VBS177
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
HMIRuntime.Trace "Count: " & group.Count & vbNewLine
See also
CreateTagSet Method (Page 719)
TagSet Object (List) (Page 139)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 381
VBS for Creating Procedures and Actions
1.14 VBS Reference
ScreenItems Object (List) (Page 127)
Screens Object (List) (Page 132)
Layers Object (Listing) (Page 119)
DataSet Object (List) (Page 113)
ProcessValues Object (List) (Page 122)
Count property
Count
Specifies the number of rows of the row listing object of a table control.
Column
ColumnAdd property
Apply - ColumnAdd
Copies the selected column from the list of existing columns to the list of selected columns.
The attribute can be assigned dynamic properties by means of the name ColumnAdd. The
data type is STRING.
ColumnAlias property
ColumnAlias
Defines the alias specified in the user archive for the column name.
The attribute can be assigned dynamic properties by means of the name ColumnAlias. The
data type is STRING.
ColumnAlign property
Alignment - ColumnAlign
Specifies the mode of alignment of a selected column.
The following settings are available:
Value Description Explanation
0 left The selected column is aligned left.
1 centered The selected column is aligned to center.
2 right The selected column is aligned right.
WinCC: Scripting (VBS, ANSI-C, VBA)
382 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name ColumnAlign. The
data type is LONG.
ColumnAutoPrecisions property
Decimal places automatic - ColumnAutoPrecisions
Enables automatic setting of the decimal precision.
Value Explanation
TRUE The decimal precision is defined automatically. The value in the "Decimal places" field is disabled.
FALSE The value in the "Decimal places" field is enabled.
The attribute can be assigned dynamic properties by means of the name
ColumnAutoPrecisions. The data type is BOOLEAN.
ColumnCaption property
Caption - ColumnCaption
Sets the caption for a selected column.
The attribute can be assigned dynamic properties by means of the name ColumnCaption. The
data type is STRING.
ColumnCount property
ColumnCount
Defines the number of columns configured.
The attribute can be assigned dynamic properties by means of the name ColumnCount. The
data type is LONG.
ColumnDateFormat property
Date format - ColumnDateFormat
Defines the date format for visualization.
The following date formats are available:
Value Explanation
Automatic The date format is set automatically.
dd.MM.yy Day.Month.Year, e.g. 24.12.07.
dd.MM.yyyy Day.Month.Year, e.g. 24.12.2007.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 383
VBS for Creating Procedures and Actions
1.14 VBS Reference
Value Explanation
dd/MM/yy Day/Month/Year, e.g. 24/12/07.
dd/MM/yyyy Day/Month/Year, e.g. 24/12/2007.
The attribute can be assigned dynamic properties by means of the name ColumnDateFormat.
The data type is STRING.
ColumnDMVarName property
ColumnDMVarName
Defines the name of the tag you assigned to the column in the user archive.
The attribute can be assigned dynamic properties by means of the name
ColumnDMVarName. The data type is STRING.
ColumnExponentialFormat property
Exponential notation - ColumnExponentialFormat
Sets exponential notation for the display of values of a selected column.
Value Explanation
TRUE The values are displayed with exponential notation.
FALSE The values are displayed with decimal notation.
The attribute can be assigned dynamic properties by means of the name
ColumnExponentialFormat. The data type is BOOLEAN.
ColumnFlagNotNull property
ColumnFlagNotNull
Specifies whether the user archive field assigned to the column must have a value.
Value Explanation
Yes The column must have a value.
No The column can have a value.
The attribute cannot be dynamized.
ColumnFlagUnique property
ColumnFlagUnique
WinCC: Scripting (VBS, ANSI-C, VBA)
384 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Specifies whether the user archive field assigned to the column must have a unique value.
Values in this column must not be redundant.
Value Explanation
TRUE The column must have a unique value.
FALSE The column must not have a unique value.
The attribute cannot be dynamized.
ColumnHideText property
Content as text - ColumnHideText
Defines textual display of the contents of a selected column.
Value Explanation
TRUE The content is not displayed in text format. The option is disabled.
FALSE The content is displayed in text format. The option is enabled.
The attribute can be assigned dynamic properties by means of the name ColumnHideText.
The data type is BOOLEAN.
ColumnHideTitleText property
Text header - ColumnHideTitleText
Sets textual display of the header of a selected column.
Value Explanation
TRUE The header is not displayed in text format. The option is disabled.
FALSE The header is displayed in text format. The option is enabled.
The attribute can be assigned dynamic properties by means of the name
ColumnHideTitleText. The data type is BOOLEAN.
ColumnId property
ColumnId
Default assignment of the ID number and column in the WinCC control:
The attribute can be assigned dynamic properties by means of the name ColumnId . The data
type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 385
VBS for Creating Procedures and Actions
1.14 VBS Reference
ColumnIndex property
ColumnIndex
References a control column. Using this attribute you can assign the values of other properties
to a specific column.
Values between 0 and "ColumnCount" minus 1 are valid for "ColumnIndex"; the attribute
"ColumnCount" defines the number of available columns.
The "ColumnIndex" attribute can be assigned dynamic properties by means of attribute
ColumnIndex. The data type is LONG.
ColumnInInspectorView property
ColumnInInspectorView
Specifies whether the diagnostic data in the detail view are displayed in columns instead of
rows.
The attribute can be assigned dynamic properties using the name ColumnInInspectorView.
The data type is BOOLEAN.
ColumnLeadingZeros property
With leading zeros - ColumnLeadingZeros
Enables the display of values with leading zeros for the column selected. Use "Number of
digits" or "ColumnLeadingZeros" to specify the number of leading zeros. The maximum
number is "11". No leading zeros are displayed with the value "0". The "With leading zeros"
option is deactivated.
The attribute can be assigned dynamic properties by means of the name
ColumnLeadingZeros. The data type is LONG.
ColumnLength property
Length in Characters - ColumnLength
Specifies the width of a selected column.
The attribute can be assigned dynamic properties by means of the name ColumnLength. The
data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
386 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ColumnMaxValue property
ColumnMaxValue
Defines the maximum column value specified in the user archive.
The attribute can be assigned dynamic properties by means of the name ColumnMaxValue.
The data type is STRING.
ColumnMinValue property
ColumnMinValue
Defines the minimum column value specified in the user archive.
The attribute can be assigned dynamic properties by means of the name ColumnMinValue.
The data type is STRING.
ColumnName property
ColumnName
Defines the name of the column which is referenced by means of "ColumnIndex" attribute.
The attribute can be assigned dynamic properties by means of the name ColumnName. The
data type is STRING.
ColumnPosition property
ColumnPosition
Displays the field position defined in the user archive.
The attribute can be assigned dynamic properties by means of the name ColumnPosition. The
data type is LONG.
ColumnPrecisions property
Decimal places - ColumnPrecisions
Specifies the number of decimal places of the values in the selected column. You can only
enter the value if the "Automatic" option is disabled.
The attribute can be assigned dynamic properties by means of the name ColumnPrecisions.
The data type is SHORT.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 387
VBS for Creating Procedures and Actions
1.14 VBS Reference
ColumnReadAccess property
ColumnReadAccess
Defines authorizations for read access to the column as specified in the user archive. The
number corresponds with the number assigned to the authorization in the "User Administrator"
editor.
The attribute cannot be dynamized.
ColumnReadonly property
Write protected - ColumnReadonly
Sets the write protection of a selected column.
Value Explanation
TRUE This column is write protected.
FALSE This column is not write protected. You can edit the column values in Runtime by activating the "Change"
option in the General" tab.
The attribute can be assigned dynamic properties by means of the name ColumnReadonly.
The data type is BOOLEAN.
ColumnRemove property
Remove - ColumnRemove
Cuts selected columns from the list of selected columns and pastes these to the list of available
columns.
The attribute can be assigned dynamic properties by means of the name ColumnRemove. The
data type is STRING.
ColumnRepos property
Up/Down - ColumnRepos
Changes the order of columns. "Up" and "Down" move the column selected up or down in the
list. This moves the column towards the front or towards the back.
The attribute can be assigned dynamic properties by means of the name ColumnRepos. The
data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
388 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ColumnResize property
Width can be resized - ColumnResize
Enables changes to the width of columns.
Value Explanation
TRUE You can change the width of the columns.
FALSE You cannot change the width of the columns.
The attribute can be assigned dynamic properties by means of the name ColumnResize. The
data type is BOOLEAN.
ColumnSrollbar properties
Column scroll bars - ColumnScrollbar
Enables the display of column scroll bars.
The following settings are available:
Value Description Explanation
0 no Column scroll bars are not displayed.
1 as required Column scroll bars are displayed if vertical space requirements of the con‐
trol are greater than the actually available display area.
2 always Column scroll bars are always displayed.
The attribute can be assigned dynamic properties by means of the name ColumnScrollbar.
The data type is LONG.
ColumnShowDate property
Display date - ColumnShowDate
Specifies if the "Time" block is displayed with time and date in a field.
Value Explanation
TRUE The date and time are displayed. The date format is defined in the "Date format" field.
FALSE The time is displayed.
The attribute can be assigned dynamic properties by means of the name ColumnShowDate.
The data type is BOOLEAN.
ColumnShowIcon property
Content as icon - ColumnShowIcon
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 389
VBS for Creating Procedures and Actions
1.14 VBS Reference
Enables the display the contents of a selected column by means of icon. This function is only
available in WinCC Alarm Control.
Value Explanation
TRUE The content is visualized as icon.
FALSE The content is not visualized as icon.
The attribute can be assigned dynamic properties by means of the name ColumnShowIcon.
The data type is BOOLEAN.
ColumnShowTitleIcon property
Header as icon - ColumnShowTitleIcon
Specifies the display of the header of a selected column by means of icon. This function is
only available in WinCC Alarm Control.
Value Explanation
TRUE The header is displayed as icon.
FALSE The header is not displayed as icon.
The attribute can be assigned dynamic properties by means of the name
ColumnShowTitleIcon. The data type is BOOLEAN.
ColumnsMoveable property
ColumnsMoveable
Specifies whether the user can move the columns of the control in runtime.
The attribute can be assigned dynamic properties using the name ColumnsMoveable. The
data type is BOOLEAN.
ColumnSort property
ColumnSort
Defines the sorting order of the user archive column referenced in the "ColumnIndex" attribute.
The following settings are available:
Value Description Explanation
0 No No sorting
1 Ascending Ascending order, starting at the lowest value.
2 Descending Descending order, starting at the highest value.
The attribute can be assigned dynamic properties by means of the name ColumnSort . The
data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
390 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ColumnSortIndex property
ColumnSortIndex
Defines the sorting order of the column referenced in "ColumnIndex". The sorting criterion is
removed from "ColumnSort" if you set a "0" value..
The attribute can be assigned dynamic properties by means of the name ColumnSortIndex.
The data type is LONG.
ColumnStartValue property
ColumnStartValue
Defines the column start value specified in the user archive.
The attribute can be assigned dynamic properties by means of the name ColumnStartValue.
The data type is STRING.
ColumnStringLength property
ColumnStringLength
Displays the string length of the column as defined in the user archive.
The attribute can be assigned dynamic properties by means of the name
ColumnStringLength. The data type is LONG.
ColumnTimeFormat property
Time format - ColumnTimeFormat
Defines the time format to be used for visualization.
The following time formats are available:
Value Explanation
Automatic The time format is set automatically.
HH:mm:ss.ms Hours:Minutes:Seconds, e.g. 15:35:44.240.
hh:mm:ss tt Hours:Minutes:Seconds AM/PM, e.g. 03:35:44 PM.
hh:mm:ss.ms tt Hours:Minutes:Seconds.Milliseconds AM/PM, e.g. 03:35:44.240 PM.
The attribute can be assigned dynamic properties by means of the name
ColumnTimeFormat. The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 391
VBS for Creating Procedures and Actions
1.14 VBS Reference
ColumnTitleAlign property
Column title alignment - ColumnTitleAlign
Specifies the type of column title alignment.
The following settings are available:
Value Description Explanation
0 left The column titles are left justified.
1 centered The column titles are centered.
2 right The column titles are right justified.
3 Same as table The column titles are justified to fit the corresponding column content.
content
The attribute can be assigned dynamic properties by means of the name ColumnTitleAlign.
The data type is LONG.
ColumnTitles property
Show column title - ColumnTitles
Enables the display of the column header.
Value Explanation
TRUE The column header is displayed.
FALSE The column header is not displayed.
The attribute can be assigned dynamic properties by means of the name ColumnTitles. The
data type is BOOLEAN.
ColumnType property
Type - ColumnType
Displays the data type set in the user archive for a selected column.
The attribute can be assigned dynamic properties by means of the name ColumnType. The
data type is LONG.
ColumnType property
ColumnType
Indicates the associated view of the selected column in the SysDiagControl.
The attribute can be assigned dynamic properties using the name ColumnType. The data type
is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
392 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ColumnVisible property
ColumnVisible
Enables the display of a column referenced by means of "ColumnIndex" attribute.
Value Explanation
TRUE The column is displayed.
FALSE The column is not displayed.
The attribute can be assigned dynamic properties by means of the name ColumnVisible . The
data type is BOOLEAN.
ColumnWriteAccess property
ColumnWriteAccess
Defines authorizations for write access to the column as specified in the user archive. The
number corresponds with the number assigned to the authorization in the "User Administrator"
editor.
The attribute cannot be dynamized.
Cu
CurrentContext Property
Description
In the case of a picture window, the server from which the picture comes and contains the
script is read out.
The "CurrentContext" property can return different results: If, for example, a picture window
displaying a server picture is set in a local basic picture, distinction is made between two cases:
● The "CurrentContext" property is used in an action of the picture window picture: The result
is the return of the symbolic computer name of the server (Package property) extended by
two colons, e.g."WinCCProject_MyComputer::“ .
● The "CurrentContext" property is used in an action of the basic picture: The result is returned
in the form of an empty character string.
See also
HMIRuntime Object (Page 116)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 393
VBS for Creating Procedures and Actions
1.14 VBS Reference
Cursor Property
Description
Controls the appearance of the cursor in Runtime when positioned over an icon.
● 0: The cursor appears as an arrow and does not change when positioned over the icon.
● 1: The cursor appears as a 3D arrow accompanied by a green lightening symbol. In
Runtime, this indicates that the object concerned can be operated.
See also
ScreenItem Object (Page 123)
HMI Symbol Library (Page 237)
Cursor property
Mouse pointer (Cursor)
Specifies whether or not to display the mouse pointer on the icon at runtime.
Value Explanation
TRUE The mouse pointer is shown at runtime if positioned on the icon.
FALSE The mouse pointer is hidden at runtime if positioned on the icon.
The attribute can be assigned dynamic properties by means of the name Cursor. The data
type is BOOLEAN.
CursorControl Property
Description
TRUE, when Alpha Cursor mode is activated, the cursor skips to the next field in the TAB
sequence after exiting the field. BOOLEAN write-read access.
To do this, the "CursorMode" property must be set to TRUE.
See also
Text list (Page 194)
I/O Field (Page 182)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
394 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
CurveForm Property
Description
WinCC Function Trend Control
Defines how the measuring points of a trend referenced by the "Index" property should be
connected. Write/Read access.
WinCC Online Trend Control
The "Index" property references a trend. "CurveForm" defines how the measuring points
should be connected.
● 0x00000012 Representation of the measuring points.
● 0x00000014 Measuring points are connected linearly.
● 0x00000011 Measuring points are connected via a step curve.
● 0x00000021 The area under the linearly connected trend is filled.
● 0x00000022: The area under the step curve is filled.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
CursorMode Property
Description
When the "CursorMode" is set to "yes", you can show all messages from the short-term archive
page by page in the long-term archive list. Use the "CursorModePrefetch" property to
determine the number of messages shown per page.
The "Autoscroll" option must be unchecked in order to be able to switch between pages. Write/
Read access.
CursorModePrefetch Property
Description
Sets the number of message that you want to display page by page in the long-term archive
list out of all messages in the short-term archive.
The "CursorMode" object property must be set to "yes".
Write/Read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 395
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.4.5 D
Da
DangerColor Property
Description
Defines or returns the color of the danger zone on the scale. LONG write-read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
Danger Property
Description
Defines or returns the beginning of the "danger zone". The zone stretches from the "danger"
value to the end of the scale. Write/Read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
DataFormat Property
Description
Returns the data type of the I/O field object. Read only access.
Range of values from 0 to 5.
0: Binary
1: Decimal
2: String
3: Hexadecimal
4: Date/time
5: Date/Time (local)
WinCC: Scripting (VBS, ANSI-C, VBA)
396 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
I/O Field (Page 182)
ScreenItem Object (Page 123)
DataIndex Property
Description
Returns the current index of the data of the current trend.
Note
The property is only supported for the controls prior to WinCC V7.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
DataLogs Property
Description
Returns an object of type "DataLogs".
DataLogs (read-only)
See also
DataLogs Object (Page 112)
HMIRuntime Object (Page 116)
DataSet Property
Description
Returns an object of type "DataSet".
DataSet (read-only)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 397
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
DataSet Object (List) (Page 113)
HMIRuntime Object (Page 116)
DataX Property
Description
Inserts a single data record and must be set before calling "InsertData".
Note
The property is only supported for the controls prior to WinCC V7.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
DataXY Property
Description
Inserts several data records as an array with pairs of values and must be set before calling
"InsertData".
The data in the array is assumed when "DataX" is of the VT_EMPTY type. Otherwise, the
"InsertData" attribute used the single value pair resulting from “DataX” and “DataY”.
Note
The property is only supported for the controls prior to WinCC V7.
See also
Example: Calling Methods of an ActiveX Control (Page 843)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
398 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
DataY Property
Description
Inserts a single data record and must be set before calling "InsertData".
Note
The property is only supported for the controls prior to WinCC V7.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
De - Do
DefaultMsgFilterSQL property
DefaultMsgFilterSQL
Defines an SQL statement for a fixed selection of messages.
The SQL statements of "DefaultMsgFilterSQL" and "MsgFilterSQL" are linked logically by
"AND" operation if you define additional custom selections by means of "MsgFilterSQL"
attribute.
The attribute can be assigned dynamic properties by means of the name
DefaultMsgFilterSQL. The data type is STRING.
DefaultPrecision Property
Description
This attribute defines the number of default decimal places, with which the scale value is
specified. Write/Read access.
DefaultRulerPrecision Property
Description
This attribute defines the number of decimal places as standard value with which a measured
value should be displayed when it is determined using the "Display value at this position"
function. Write/Read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 399
VBS for Creating Procedures and Actions
1.14 VBS Reference
DefaultSort property
Default sorting order - DefaultSort
Defines the default sorting order in table columns.
The following settings are available:
Value Description Explanation
0 Ascending The list is updated starting with the bottom line.
1 Descending The list is updated starting with the top line.
The attribute can be assigned dynamic properties by means of the name DefaultSort. The data
type is LONG.
DefaultSort2 property
DefaultSort2
Use this function to define the sorting method in table columns if not using the default "Date/
time/number" sorting order. Instead, you defined a message block in the "DefaultSort2Column"
object property to sort the columns based on the "message block/date/time/number" order.
The following settings are available:
Value Description Explanation
0 Ascending The list is updated starting with the bottom line.
1 Descending The list is updated starting with the top line.
The attribute can be assigned dynamic properties by means of the name DefaultSort2. The
data type is LONG.
DefaultSort2Column property
DefaultSort2Column
Use this function to define the sorting method in table columns if not using the default "Date/
time/number" sorting order.
Define a message block by its object name.
The table columns are now sorted based on the "message block/date/time/number" order.
The attribute can be assigned dynamic properties by means of the name
DefaultSort2Column. The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
400 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
DeleteData Property
Description
Deletes data in the data buffer of the current trend.
TRUE : All trend data is deleted.
FALSE : The value pair at the "DataIndex" position are deleted.
Note
The property is only supported for the controls prior to WinCC V7.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
Delta Property
Description
Defines or returns the value difference between two main scale graduation marks. Write/Read
access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
DesiredCurveColor Property
Description
Defines the color of a setpoint trend which belongs to a trend referenced by the "Index"
property. The color is defined as an RGB value. Whether the information is evaluated is
dependent on the value of the "DesiredCurveVisible" property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 401
VBS for Creating Procedures and Actions
1.14 VBS Reference
DesiredCurveCurveForm Property
Description
Defines the form of representation of a setpoint trend which belongs to a trend referenced by
the "Index" property. Whether the information is evaluated is dependent on the value of the
"DesiredCurveVisible" property.
0x00000011 Measuring points are connected by a solid line via a step curve
0x00000012 Representation of the measuring points
0x00000014 Measuring points are connected linearly with a solid line
0x00000021 The area under the linearly connected trend is filled.
0x00000022: The area under the stepped curve is filled.
0x00000031: Measuring points are connected by a dashed line via a step curve
0x00000032: Measuring points are connected linearly with a dashed line
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
DesiredCurveSourceNumberOfUAValues Property
Description
Defines the number of value pairs of a setpoint trend which belongs to a trend referenced by
the "Index" property. Whether the information is evaluated is dependent on the value of the
"DesiredCurveVisible" property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
DesiredCurveSourceUAArchive Property
Description
Defines the name of the user archive from which the value of a setpoint trend, which belongs
to a trend referenced by "Index", is read. Whether the information is evaluated is dependent
on the value of the "DesiredCurveVisible" property.
WinCC: Scripting (VBS, ANSI-C, VBA)
402 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
DesiredCurveSourceUAArchiveStartID Property
Description
Defines the starting point for the value of a setpoint trend, which belongs to a trend referenced
by "Index", from which the values should be read from the archive. Whether the information is
evaluated is dependent on the value of the "DesiredCurveVisible" property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
DesiredCurveSourceUAColumnX Property
Description
Defines the column in the user archive from which the X-values of a setpoint trend, which
belongs to a trend referenced by "Index", should be read. Whether the information is evaluated
is dependent on the value of the "DesiredCurveVisible" property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
DesiredCurveSourceUAColumnY Property
Description
Defines the column in the user archive from which the Y-values of a setpoint trend, which
belongs to a trend referenced by "Index", should be read. Whether the information is evaluated
is dependent on the value of the "DesiredCurveVisible" property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 403
VBS for Creating Procedures and Actions
1.14 VBS Reference
DesiredCurveVisible Property
Description
TRUE, a setpoint trend which belongs to a trend referenced by "Index" should be displayed.
BOOLEAN write-read access.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
Direction Property
Description
Defines or returns the bar direction or the position of the slider object. BOOLEAN write-read
access. Value range from 0 to 3.
0 = top
1 = bottom
2 = left
3 = right
See also
Slider (Page 210)
Bar (Page 172)
3D Bar (Page 167)
ScreenItem Object (Page 123)
DisplayName property
Display name (DisplayName)
Specifies the user-defined name of the process picture. The attribute is of type "Multilingual
String". You can specify names for all languages installed in WinCC.
The logon name is displayed in the following cases:
WinCC Explorer "Details" view in the data window "Display name" column
"Large Icons" view in the data window Process picture preview
WinCC Runtime "Favorites" system dialog Process picture preview
The "Display name" attribute cannot be made dynamic.
WinCC: Scripting (VBS, ANSI-C, VBA)
404 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
DisplayOptions property
Show messages - DisplayOptions
Select the messages to be displayed.
The following selection options are available:
Value Designation
0 All messages
1 Only displayed messages
2 Only hidden messages
The attribute can be assigned dynamic properties by means of the name DisplayOptions. The
data type is LONG.
DisplayOptions property (before WinCC V7)
Description
Specifies if a button is assigned to a graphic, text, or both.
0 Picture or text: If a picture exists, the button is assigned with the picture, otherwise it is
assigned with text.
1 Graphic and text
2 Text only
3 Graphic only
DoubleClickAction property
Action on double-click - DoubleClickAction
Sepcifies the action to be executed in Runtime by double-clicking on a message line.
The following settings are available:
Value Description Explanation
0 none No action.
1 Loop-in-alarm Calls the "Loop-in-alarm" function.
2 Open comments dialog Calls the "Comments dialog" button function.
3 Open Infotext dialog Calls the "Infotext dialog" button function.
4 Column-dependent The action is determined by the column in which you dou‐
ble-clicked.
The attribute can be assigned dynamic properties by means of the name DoubleClickAction.
The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 405
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.4.6 E
Edit Property
Description
Activates Editing mode for a cell as long as the "Editable" property has been set to TRUE for
the corresponding column.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
Editable Property
Description
The "Index" property references a pair of columns. "Editable" defines whether the column pair
should be editable. BOOLEAN write-read access.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
EditAtOnce Property
Description
TRUE, if accessing the field with the <TAB> key permits input immediately and without further
action. BOOLEAN write-read access.
See also
Text list (Page 194)
I/O Field (Page 182)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
406 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ElectronicSignature property
Activate electronic signature (ElectronicSignature)
The "Activate electronic signature" attribute determines whether a signature is required during
operation in Runtime. With the "User for the electronic signature" property, you define which
user can sign the operation.
Yes An electronic signature is required when the object or control is operated.
No Operation is possible without an electronic signature.
The "Activate electronic signature" attribute can be made dynamic with the name
"ElectronicSignature".
Enabled Property
Function
Enables or disables possible operation of an object or issues the corresponding value. TRUE :
Enable operation, FALSE: Operation is disabled.
BOOLEAN write-read access.
Example:
The following example disables all objects in the picture "NewPDL1":
'VBS71
Dim objScreen
Dim objScrItem
Dim lngIndex
Dim strName
lngIndex = 1
Set objScreen = HMIRuntime.Screens("NewPDL1")
For lngIndex = 1 To objScreen.ScreenItems.Count
strName = objScreen.ScreenItems.Item(lngIndex).ObjectName 'Read names of objects
Set objScrItem = objScreen.ScreenItems(strName)
objScrItem.Enabled=False 'Lock object
Next
See also
Screen Object (Page 129)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 407
VBS for Creating Procedures and Actions
1.14 VBS Reference
EnableDelete property
Delete - EnableDelete
Enables deletion of data from the user archive in Runtime.
Value Explanation
TRUE You can delete data from the user archive in Runtime.
FALSE You cannot delete data from the user archive in Runtime.
The attribute can be assigned dynamic properties by means of the name EnableDelete. The
data type is BOOLEAN.
EnableEdit property
Modify - EnableEdit
Enables editing of the data displayed during runtime.
Value Explanation
TRUE Enables editing of data during runtime.
FALSE Disables editing of data during runtime.
The attribute can be assigned dynamic properties by means of the name EnableEdit. The data
type is BOOLEAN.
EnableInsert property
Add - EnableInsert
Enables insertion of data in the user archive in Runtime.
Value Explanation
TRUE You can add data to the user archive in Runtime.
FALSE You cannot add data to the user archive in Runtime.
The attribute can be assigned dynamic properties by means of the name EnableInsert. The
data type is BOOLEAN.
EnablePopupMenu property
EnablePopupMenu
Specifies if the pop-up menu is enabled in the control.
The attribute can be assigned dynamic properties by means of the name EnablePopupMenu.
The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
408 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
EnableUserAutoLogout property
Automatic user logout - EnableUserAutoLogout
Specifies for the WinCC UserAdminControl whether the settings in the User Administrator for
user logout are inherited from the group or are user-specific.
Value Name Explanation
FALSE Inherit from group Automatic user logout is inherited from the group.
TRUE User-specific The user has his/her own logout.
If you are using the "SIMATIC Logon" option, you will only be able to use automatic logout for
the group. The setting will automatically be applied to each user in this group. Automatic logout
is deactivated if a user logs on with a chip card.
The attribute can be assigned dynamic properties using the name EnableUserAutoLogout.
The data type is BOOL.
EnableUserPermissions property
Operator authorizations of the user - EnableUserPermissions
Defines whether user-specific operator authorizations can be configured for WinCC
UserAdminControl.
Value Explanation
FALSE "Inherit from group"
The operating authorizations are always inherited by the group. The "Authorization levels" button is disabled.
TRUE "User-specific"
When the user is created, the user authorizations of the group are transferred.
You can change the user's authorizations in the "Authorization levels" window.
The attribute can be assigned dynamic properties using the name EnableUserPermissions.
The data type is BOOL.
EnableUserWebOptions property
Web options of the user - EnableUserWebOptions
Specifies for the WinCC UserAdminControl whether the settings in the User Administrator for
the Web options of the user are inherited from the group or are user-specific.
The settings for the Web options refer to the WinCC options WinCC/WebNavigator, WinCC/
DataMonitor and WinCC/WebUX.
Value Name Explanation
FALSE Inherit from group The settings for the Web options are inherited from the group.
TRUE User-specific The user has his/her own settings for the Web options.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 409
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties using the name EnableUserWebOptions.
The data type is BOOL.
EndAngle Property
Description
Defines or returns the end of the object. The information is in counterclockwise direction in
degrees, beginning at the 12:00 clock position.
See also
Pie segment (Page 150)
Circular arc (Page 149)
Ellipse segment (Page 145)
Ellipse arc (Page 144)
ScreenItem Object (Page 123)
EndTime Property
Description
Online Table Control
The "Index" attribute references a pair of columns. "EndTime" defines the end time for
displaying this column pair. Whether the information is evaluated is dependent on the
TimeRange" and "CommonTime" properties. Write/Read access.
Online Trend Control
The "Index" attribute references a trend. "EndTime" defines the end time for displaying this
trend. Whether the information is evaluated is dependent on the "Autorange", "TimeRange"
and "CommonX" properties.
Use the "yyyy-mm-dd hh:mm:ss" format when creating a dynamic time range.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
410 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
EndValue Property
Description
The "Index" property references a trend. "EndValue" defines the upper limit of the value range
to be displayed for the trend. Whether the information is evaluated is dependent on the
"Autorange" and "CommonY" properties.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
EndX Property
Description
Defines the upper limit of the X-axis of a trend referenced with "Index". Whether the information
is evaluated is dependent on the "AutorangeX" and "CommonX" properties.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
EndY Property
Description
Defines the upper limit of the Y-axis of a trend referenced with "Index". Whether the information
is evaluated is dependent on the "AutorangeY" and "CommonY" properties.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
ErrorDescription Property
Function
Error description of the "LastError" property. The error description is provided in English only.
STRING (read only)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 411
VBS for Creating Procedures and Actions
1.14 VBS Reference
The following error messages are defined:
Output Description
"" OK
"Operation Failed" Execution error
"Variable not found" Tag error
"Server down" Server not available.
"An error occured for one or several tags" Multi Tag Error (Error in one or several tags)
In order that ErrorDescription returns a value, a read process must be executed beforehand.
If an error occurs during read or write of several tags using the TagSet object, the error is set
to "Multi Tag Error". In order to determine at which tag the error occurred and what type of
error it was, the ErrorDescription property of each tag must be analyzed.
Example:
The following example displays the error description for "Tag1":
'VBS72
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objtag.Read
MsgBox objTag.ErrorDescription
The following example adds two tags to the TagSet list and outputs the ErrorDescription
property as Trace.
'VBS179
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
HMIRuntime.Trace "ErrorDescription: " & group.ErrorDescription & vbNewLine
The ErrorDescription property of a tag contained in the list may be accessed as follows:
HMIRuntime.Trace "ErrorDescription: " & group("Motor1").ErrorDescription & vbNewLine
See also
LastError Property (Page 459)
QualityCode Property (Page 547)
TagSet Object (List) (Page 139)
Tag Object (Page 135)
WinCC: Scripting (VBS, ANSI-C, VBA)
412 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Exponent Property
Description
TRUE, when the display of numbers should be with exponents (e.g."1.00e+000"). BOOLEAN
write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
ExportDirectoryChangeable property
Directory can be changed - ExportDirectoryChangeable
Enables changing of the directory for data export in Runtime.
Value Explanation
TRUE The data export directory can be changed in Runtime.
FALSE The data export directory cannot be changed in Runtime.
The attribute can be assigned dynamic properties by means of the name
ExportDirectoryChangeable. The data type is BOOLEAN.
ExportDirectoryname property
Directory - ExportDirectoryname
Defines the directory to which the exported Runtime data is written.
You can select or create the directory using the selection button.
The attribute can be assigned dynamic properties by means of the name
ExportDirectoryname. The data type is STRING.
ExportFileExtension property
ExportFileExtension
Defines the extension of the export file.
Only the file name extension "csv" is currently supported.
The attribute can be assigned dynamic properties by means of the name
ExportFileExtension. The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 413
VBS for Creating Procedures and Actions
1.14 VBS Reference
ExportFilename property
File name - ExportFilename
Defines the name of the file which is to receive the exported Runtime data.
The attribute can be assigned dynamic properties by means of the name ExportFilename. The
data type is STRING.
ExportFilenameChangeable property
File can be renamed - ExportFilenameChangeable
Enables renaming of the export file in Runtime.
Value Explanation
TRUE The export file can be renamed in Runtime.
FALSE The export file cannot be renamed in Runtime.
The attribute can be assigned dynamic properties by means of the name
ExportFilenameChangeable. The data type is BOOLEAN.
ExportFormatGuid property
ExportFormatGuid
Default assignment of the ID number and export provider.
The attribute can be assigned dynamic properties by means of the name ExportFormatGuid.
The data type is STRING.
ExportFormatName property
Format - ExportFormatName
Defines the export file format.
Only the "csv" file format is currently available for the export.
The attribute can be assigned dynamic properties by means of the name ExportFormatName.
The data type is STRING.
ExportParameters property
ExportParameters
Specifies the parameters of the selected format by means of the properties dialog.
WinCC: Scripting (VBS, ANSI-C, VBA)
414 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name ExportParameters.
The data type is VARIANT.
ExportSelection property
Scope of data export - ExportSelection
Specifies the control's Runtime data to be exported.
The following settings are available:
Value Description Explanation
0 all All Runtime data of the control is exported.
1 Selection Selected Runtime data of the control is exported.
The attribute can be assigned dynamic properties by means of the name ExportSelection. The
data type is LONG.
ExportShowDialog property
Show dialog - ExportShowDialog
Enables the display of the export dialog during runtime.
Value Explanation
TRUE The dialog is displayed during runtime.
FALSE The dialog is not displayed during runtime.
The attribute can be assigned dynamic properties by means of the name ExportShowDialog.
The data type is BOOLEAN.
ExportXML property
ExportXML
Only used internally.
The attribute can be assigned dynamic properties by means of the name ExportXML.
ExtendedOperation Property
Description
TRUE, when the slider regulator is set at the respective end value (minimum/maximum value).
This is done by clicking the mouse in an area outside the current regulator setting. BOOLEAN
write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 415
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Slider (Page 210)
ScreenItem Object (Page 123)
ExtendedZoomingEnable Property
Description
Activates/deactivates the ExtendedZooming properties of a picture.
Using ExtendedZooming, the view of a process picture in Runtime may be enlarged or reduced
by using the mouse wheel.
BOOLEAN write-read access.
Example:
Activates ExtendedZooming for picture NewPDL1.
'VBS155
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
objScreen.ExtendedZoomingEnable = 1
See also
Screen Object (Page 129)
1.14.4.7 F
Fe - Fl
FeatureFullscreen property
FeatureFullscreen
Specifies if the "Full screen" function is available in the control.
The attribute can be assigned dynamic properties by means of the name FeatureFullscreen.
The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
416 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
FeaturePause property
FeaturePause
Specifies if the "Pause" function is available in the control.
The attribute can be assigned dynamic properties by means of the name FeaturePause. The
data type is BOOLEAN.
FeaturePlay property
FeaturePlay
Specifies if the "Play" function is available in the control.
The attribute can be assigned dynamic properties by means of the name FeaturePlay. The
data type is BOOLEAN.
FeatureStepBackward property
FeatureStepBackward
Specifies if the "Step backward" function is available in the control.
The attribute can be assigned dynamic properties by means of the name
FeatureStepBackward. The data type is BOOLEAN.
FeatureStepForward property
FeatureStepForward
Specifies if the "Step forward" function is available in the control.
The attribute can be assigned dynamic properties by means of the name
FeatureStepForward. The data type is BOOLEAN.
FeatureStop property
FeatureStop
Specifies if the "Stop" function is available in the control.
The attribute can be assigned dynamic properties by means of the name FeatureStop. The
data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 417
VBS for Creating Procedures and Actions
1.14 VBS Reference
FeatureVolume property
FeatureVolume
Specifies if the "Volume" function is available in the control.
The attribute can be assigned dynamic properties by means of the name FeatureVolume. The
data type is BOOLEAN.
FileName property
FileName
Specifies the file whose content you want to display or play.
The attribute can be assigned dynamic properties by means of the name FileName. The data
type is STRING.
FillColor Property
Description
Defines or returns the fill pattern color for the object.
LONG (write-read access)
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Enter the appropriate decimal value
for each of the three RGB values.
Example:
RGB(200, 150, 100)
Example:
The following example defines the fill color for "ScreenWindow1" to blue:
'VBS73
Dim objScreen
Set objScreen = HMIRuntime.Screens("ScreenWindow1")
objScreen.FillStyle = 131075
objScreen.FillColor = RGB(0, 0, 255)
WinCC: Scripting (VBS, ANSI-C, VBA)
418 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
FillStyle Property (Page 420)
BackColor Property (Page 318)
ScreenItem Object (Page 123)
Filling Property
Description
TRUE, when the object can be filled by closed border lines (e.g. representing the fill level of a
tank). BOOLEAN write-read access.
The fill level of the object is set by means of the "FillingIndex" property.
See also
ScreenItem Object (Page 123)
FillingDirection properties
Filling direction (FillingDirection)
The "Filling direction" attribute specifies the filling direction for an object enclosed in a frame
line.
Bottom to top The object is filled from bottom to top.
Top to bottom The object is filled from top to bottom.
Left to right The object is filled from left to right.
Right to left The object is filled from right to left.
The attribute can be assigned dynamic properties by means of the name FillingDirection. The
data type is LONG.
FillingIndex Property
Description
Defines the %age value (related to the height of the object) to which the object with closed
border line is to be filled.
The fill level is represented by the current background color. The unfilled background is
transparent.
See also
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 419
VBS for Creating Procedures and Actions
1.14 VBS Reference
FillStyle Property
Description
Defines or returns the fill pattern for the object.
LONG (write-read access)
Fill pattern Value Fill pattern Value Fill pattern Value
65536
1048576 196611 196627
1048577 196612 196628
1048578 196613 196629
1048579 196614 196630
1048832 196615 196631
1048833 196616 196632
1048834 196617 196633
1048835 196618 196634
131072 196619 196635
131073 196620 196636
131074 196621 196637
131075 196622 196638
131076 196623 196639
196608 196624 196640
WinCC: Scripting (VBS, ANSI-C, VBA)
420 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Fill pattern Value Fill pattern Value Fill pattern Value
196609 196625 196641
196610 196626 196642
Example
The following example sets the fill pattern for "ScreenWindow1" to transparent:
'VBS190
Dim obj
Set obj = ScreenItems("Rectangle1")
obj.FillStyle = 65536
See also
FillColor Property (Page 418)
BackColor Property (Page 318)
Screen Object (Page 129)
FillStyle2 Property
Description
Defines or returns the fill style of the bar.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
FillStyleAlignment property
Description
Defines the alignment of the fill pattern for the process picture.
Normal The fill pattern refers to the process picture. In runtime, no scaling is
performed when opening the picture.
Stretched (window) The fill pattern refers to the window in the Graphics Designer. In runtime,
scaling is performed when opening the picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 421
VBS for Creating Procedures and Actions
1.14 VBS Reference
FilterSQL property
FilterSQL
Defines an SQL statement for a selection of data in the user archive.
The attribute can be assigned dynamic properties by means of the name FilterSQL. The data
type is STRING.
FineGrid Property
Description
TRUE, when the value axis is scaled by short tick marks. The distance between two short tick
marks can be changed using the "FineGridValue" property. BOOLEAN write-read access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
FineGridValue Property
Description
Defines the distance between two short tick marks in the scale. Whether the information is
evaluated is dependent on the value of the "FineGrid" property.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
FineGridValueX Property
Description
Defines the distance between two short tick marks on the X-axes scaling. Whether the
information is evaluated is dependent on the value of the "FineGridX" property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
422 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
FineGridValueY Property
Description
Defines the distance between two short tick marks on the Y-axes scaling. Whether the
information is evaluated is dependent on the value of the "FineGridX" property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
FineGridX Property
Description
TRUE, when the X-axis graduation is scaled by short tick marks. The distance between two
short tick marks can be changed using the "FineGridValueX" property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
FineGridY Property
Description
TRUE, when the Y-axis graduation is scaled by short tick marks. The distance between two
short tick marks can be changed using the "FineGridValueY" property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
FlashBackColor Property
Description
TRUE, when flashing of the background is activated. BOOLEAN write-read access
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 423
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
ScreenItem Object (Page 123)
FlashBorderColor Property
Description
TRUE, when flashing of the object lines is activated. BOOLEAN write-read access.
See also
ScreenItem Object (Page 123)
FlashFlashPicture Property
Description
TRUE, when flashing of the flash picture is activated. BOOLEAN write-read access.
See also
Status display (Page 197)
ScreenItem Object (Page 123)
FlashForeColor Property
Description
TRUE, when flashing of the text is activated. BOOLEAN write-read access.
See also
I/O Field (Page 182)
Static text (Page 163)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
Button (Page 199)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
424 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
FlashPicReferenced Property
Description
TRUE, when the assigned flash picture should be saved. Otherwise, only the associated object
reference is saved. Read only access.
See also
Status display (Page 197)
ScreenItem Object (Page 123)
FlashPicTransColor Property
Description
Defines which color of the bitmap object (.bmp, .dib) assigned to the flash picture should be
set to "transparent". LONG Write/Read Access.
The color is only set to "Transparent" if the value of the "FlashPicUseTransColor" property is
"True".
See also
ScreenItem Object (Page 123)
Status display (Page 197)
FlashPicture Property
Description
Returns the flash picture. Read-only access.
The picture (*.BMP or *.DIB) must be located in the "GraCS" directory of the current project
so that it can be integrated.
In this context, the "FlashPicReferenced" property defines whether the flash picture should be
saved together with the object status display or referenced.
See also
Status display (Page 197)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 425
VBS for Creating Procedures and Actions
1.14 VBS Reference
FlashPicUseTransColor Property
Description
TRUE, when the configured color ("FlashPicTransColor" property) of the bitmap objects
assigned to the flash picture should be set to "transparent". BOOLEAN write-read access.
See also
Status display (Page 197)
ScreenItem Object (Page 123)
FlashRate Property
Description
Defines or returns the flashing frequency for the object. Value range from 0 to 2.
Flash frequency Assigned Value
Slow (approx. 0.25 Hz) 0
Medium (approx. 0.5 Hz) 1
Fast (approx. 1 Hz) 2
Note
Because the flashing is performed by means of software engineering, the flash frequency is
both system-dependent and hardware-bound (number of objects, processor speed, RAM size,
update time, etc.).
The information in the table is therefore only for orientation purposes.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
426 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
FlashRateBackColor Property
Description
Defines or returns the flash frequency for the object background. Value range from 0 to 2.
Flash frequency Assigned Value
Slow (approx. 0.25 Hz) 0
Medium (approx. 0.5 Hz) 1
Fast (approx. 1 Hz) 2
Note
Because the flashing is performed by means of software engineering, the flash frequency is
both system-dependent and hardware-bound (number of objects, processor speed, RAM size,
update time, etc.).
The information in the table is therefore only for orientation purposes.
See also
ScreenItem Object (Page 123)
FlashRateBorderColor Property
Description
Defines or returns the flash frequency for the lines of the object. Value range from 0 to 2.
Flash frequency Assigned Value
Slow (approx. 0.25 Hz) 0
Medium (approx. 0.5 Hz) 1
Fast (approx. 1 Hz) 2
Note
Because the flashing is performed by means of software engineering, the flash frequency is
both system-dependent and hardware-bound (number of objects, processor speed, RAM size,
update time, etc.).
The information in the table is therefore only for orientation purposes.
See also
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 427
VBS for Creating Procedures and Actions
1.14 VBS Reference
FlashRateFlashPic Property
Description
Defines or returns the flash frequency for the status display. Value range from 0 to 2.
Flash frequency Assigned Value
Slow (approx. 0.25 Hz) 0
Medium (approx. 0.5 Hz) 1
Fast (approx. 1 Hz) 2
Note
Because the flashing is performed by means of software engineering, the flash frequency is
both system-dependent and hardware-bound (number of objects, processor speed, RAM size,
update time, etc.).
The information in the table is therefore only for orientation purposes.
See also
Status display (Page 197)
ScreenItem Object (Page 123)
FlashRateForeColor Property
Description
Defines or returns the flash frequency for the object label. Value range from 0 to 2.
Flash frequency Assigned Value
Slow (approx. 0.5 Hz) 0
Medium (approx. 2 Hz) 1
Fast (approx. 8 Hz) 2
Note
Because the flashing is performed by means of software engineering, the flash frequency is
both system-dependent and hardware-bound (number of objects, processor speed, RAM size,
update time, etc.).
The information in the table is therefore only for orientation purposes.
WinCC: Scripting (VBS, ANSI-C, VBA)
428 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Static text (Page 163)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
Button (Page 199)
I/O Field (Page 182)
ScreenItem Object (Page 123)
Flip property
Flip (Flip)
Specifies flipping of the icon at runtime.
The following settings are available:
Value Description Comments
0 None The icon is not flipped.
1 Horizontal The object is flipped along the horizontal center axis.
2 Vertical The object is flipped along the vertical center axis.
3 Both The object is flipped along the horizontal and vertical center axes.
The attribute can be assigned dynamic properties by means of the name Flip. The data type
is LONG.
Flip Property
Description
Mirrors the icon on the vertical and/or horizontal middle axis of the icon.
● Zero - 0: The icon is mot mirrored.
● Horizontal - 1: The icon is mirrored on the vertical center axis.
● Vertical - 2: The icon is mirrored on the horizontal, center axis.
● Both - 3: The icon is mirrored both on the horizontal and vertical center axes.
See also
HMI Symbol Library (Page 237)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 429
VBS for Creating Procedures and Actions
1.14 VBS Reference
Fo - Fr
FocusColor Property
Description
If the focus is positioned on the control in Runtime, the labeling and position text are identified
by a border. FocusColor defines the color of the border.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
FocusRect Property
Description
TRUE, when the button should be provided with a selection border, in Runtime, as soon as it
receives the focus. BOOLEAN write-read access.
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
FocusWidth Property
Description
If the focus is positioned on the control in Runtime, the labeling and position text are identified
by a border. FocusWidth defines the width of the border, value range of 1-10 pixels. LONG
write-read access.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
430 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Font Property
Name - Font
Sets the font.
The attribute cannot be dynamized.
Font property (before WinCC V7)
Description
Defines or returns the font. Write/Read access.
The font object has the following sub-properties
● Size (Font Size)
● Bold (yes/no)
● Name (font name)
● Italic (yes/no)
● Underline (underline yes/no)
● StrikeThrough (yes/no)
If two font properties are directly assigned, only the default property "Name" is assumed.
Example:
'VBS74
Dim objControl1
Dim objControl2
Set objControl1 = ScreenItems("Control1")
Set objControl2 = ScreenItems("Control2")
objControl2.Font = objControl1.Font ' take over only the type of font
See also
WinCC Slider Control (Page 270)
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Function Trend Control (before WinCC V7) (Page 281)
WinCC Digital/Analog Clock (Page 244)
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 431
VBS for Creating Procedures and Actions
1.14 VBS Reference
FontBold Property
Description
TRUE, when the text in the object should be assigned the "bold" attribute. BOOLEAN write-
read access.
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
Group Display (Page 192)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
Button (Page 199)
I/O Field (Page 182)
Bar (Page 172)
ScreenItem Object (Page 123)
FontItalic Property
Description
TRUE, when the text in the object should be assigned the "italic" attribute. BOOLEAN write-
read access.
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
Group Display (Page 192)
Static text (Page 163)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
Button (Page 199)
I/O Field (Page 182)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
432 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
FontName Property
Description
Defines or returns the font name of the text in the object.
All the fonts installed in Windows are available for selection.
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
Group Display (Page 192)
Static text (Page 163)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
Button (Page 199)
I/O Field (Page 182)
Bar (Page 172)
ScreenItem Object (Page 123)
FontPosition Property
Description
Returns the font name for the display of the slider position in the bottom part of the object. All
the fonts installed in Windows are available for selection. Read only access.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
FontSize Property
Description
Defines or returns the font size of the text in the object in points.
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
Group Display (Page 192)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 433
VBS for Creating Procedures and Actions
1.14 VBS Reference
Static text (Page 163)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
Button (Page 199)
I/O Field (Page 182)
Bar (Page 172)
ScreenItem Object (Page 123)
FontStrikeThru Property
Description
TRUE, when the text in the object should be assigned the "strikethrough" attribute. BOOLEAN
write-read access.
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
ScreenItem Object (Page 123)
FontUnderline Property
Description
TRUE, when the text in the object should be assigned the "underline" attribute. BOOLEAN
write-read access.
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
Group Display (Page 192)
Static text (Page 163)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
Button (Page 199)
I/O Field (Page 182)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
434 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ForeColor Property
Description
Defines or returns the color of the font for the text in the object. LONG write-read access.
See also
WinCC Slider Control (Page 270)
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
WinCC Digital/Analog Clock (Page 244)
HMI Symbol Library (Page 237)
Static text (Page 163)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
Button (Page 199)
I/O Field (Page 182)
ScreenItem Object (Page 123)
ForeColor property
Foreground color (ForeColor)
Specifies the foreground color of the icon in the "Color selection" dialog. The icon is displayed
in the foreground color if the "Shadow" and "Solid" foreground mode is set.
The attribute can be assigned dynamic properties by means of the name ForeColor. The data
type is LONG.
ForeFlashColorOff Property
Description
Defines or returns the color of the text for flash status "Off". LONG write-read access.
See also
Text list (Page 194)
Static text (Page 163)
Radio box (Page 205)
Check box (Page 202)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 435
VBS for Creating Procedures and Actions
1.14 VBS Reference
Button (Page 199)
I/O Field (Page 182)
ScreenItem Object (Page 123)
ForeFlashColorOn Property
Description
Defines or returns the color of the text for flash status "On". LONG write-read access.
See also
Static text (Page 163)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
Button (Page 199)
I/O Field (Page 182)
ScreenItem Object (Page 123)
FrameColor Property
Description
Defines or returns the color of the rectangular or square area located on the graduated scale
disk. LONG write-read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
FrameColorDown Property
Description
Defines or returns the color for the right, bottom part of the 3D frame of the button (button
pressed). LONG write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
436 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
ScreenItem Object (Page 123)
FrameColorUp Property
Description
Defines or returns the color for the left, top part of the 3D frame of the button (button not
pressed). LONG write-read access.
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
ScreenItem Object (Page 123)
FramePicture Property
Description
Returns the picture name of the background picture for the graduated scale disk. Read only
access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
FrameScale Property
Description
Defines or returns the diameter of the graduated scale disk in relation to smallest value of the
width and height geometric attributes. Write/Read access.
The value range is (scale distance - scale width) to 1.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 437
VBS for Creating Procedures and Actions
1.14 VBS Reference
FrameWidth Property
Description
Defines or returns the border width of the button in pixels. Write/Read access.
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
ScreenItem Object (Page 123)
FreezeProviderConnections Property
Description
Enables modification of the data connection properties ("ProviderType", "Source"...), without
the change being effective immediately. On changing "SourceTagNameX", for example,
impermissible combinations can created with "SourceTagNameY".
Therefore, FreezeProviderConnections" must be set to TRUE before modifying a data
connection attribute. After modifying all the data connection, "FreezeProviderConnection" is
set to FALSE and the changes take effect.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
1.14.4.8 G
GlobalColorScheme property
Description
Defines whether the colors defined for the current design in the global color scheme will be
used for this object.
TRUE if the object is displayed with the colors from the global color scheme defined for this
object type.
FALSE if the object is displayed with the colors as per the settings in the object.
BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
438 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
GlobalShadow property
Description
Defines whether the object will be displayed with the shadowing defined in the active design.
TRUE if the object is displayed with the global shadow defined for this object type.
FALSE if no shadow is displayed.
BOOLEAN write-read access.
GraphDirection property (before WinCC V7)
Description
Defines which edge of the trend window should display the current values. Write/Read access.
0: Positive values run to the right and upwards.
-1: Positive values run to the left and upwards.
-2: Positive values run to the right and upwards.
-3: Positive values run to the right and downwards.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
GraphDirection Property
Write direction - GraphDirection
Defines the direction of the update of axis values.
Value Description Explanation
0 From the right The updated values are displayed starting at the right in the control.
1 From the left The updated values are displayed starting at the left in the control.
2 From the top The updated values are displayed starting at the top in the control.
3 From the bottom The updated values are displayed starting at the bottom in the control.
If you select the "From the top" or "From the bottom" setting for the write direction, you must
use True-Type fonts within the window. Only this setting ensures legibility of the labeling of
the vertical axis.
The attribute can be assigned dynamic properties by means of the name GraphDirection. The
data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 439
VBS for Creating Procedures and Actions
1.14 VBS Reference
Graphiclist property
Graphic list (Graphiclist)
Enter the name of a graphic list that you created in the WinCC Configuration Studio in the "Text
and Graphics Lists" editor.
The use of configured graphic lists simplifies the configuration of graphics and its flashing
characteristics for the various states.
The "Graphics list" attribute can be made dynamic with the name "Graphiclist".
GridLineColor property
Color of the row divider / content - GridLineColor
Defines the color of row/column dividers in table contents. The button opens the "Color
selection" dialog.
The attribute can be assigned dynamic properties by means of the name GridLineColor. The
data type is LONG.
GridLineHorz Property
Description
TRUE, when the message window columns are separated by horizontal dividing lines.
BOOLEAN write-read access.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
GridLines Property
Description
TRUE, when the trend window is displayed with grid lines parallel to the X-axis. The distance
between two grid lines can be changed using the "GridLineValue" property. BOOLEAN write-
read access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
440 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
GridlinesValueX Property
Description
Defines or returns the distance between two grid lines on the X-axis. Whether the information
is evaluated is dependent on the value of the "GridLinesX" property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
GridlinesValueY Property
Description
Defines or returns the distance between two grid lines on the Y-axis. Whether the information
is evaluated is dependent on the value of the "GridLinesY" property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
GridlinesX Property
Description
TRUE, when the trend window is displayed with grid lines parallel to the X-axis. The distance
between two grid lines can be changed using the "GridLineValueX" property.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
GridlinesY Property
Description
TRUE, when the trend window is displayed with grid lines parallel to the Y-axis. The distance
between two grid lines can be changed using the "GridLineValueX" property.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 441
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
GridLineValue Property
Description
Defines the distance between two grid lines. Whether the information is evaluated is
dependent on the value of the "GridLines" property.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
GridLineVert Property
Description
TRUE, when the message window columns are separated by vertical dividing lines. BOOLEAN
write-read access.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
GridLineWidth property
Width of dividers - GridLineWidth
Defines the line weight of the row/column dividers in pixels.
The attribute can be assigned dynamic properties by means of the name GridLineWidth. The
data type is LONG.
GridVisible property
GridVisible
Specifies whether or not the grid is visible in the table of the WinCC UserAdminControl.
WinCC: Scripting (VBS, ANSI-C, VBA)
442 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties using the name GridVisible. The data type
is BOOLEAN.
GroupEditMode property
Edit mode groups - GroupEditMode
Specifies which editing options the user has in WinCC UserAdminControl regarding group
properties of the User Administrator.
Value Name Explanation
0 Read The user can only read the group properties.
1 Change The user can change the group properties.
2 Full access The user can access the group properties without restrictions.
The attribute can be assigned dynamic properties using the name GroupEditMode. The data
type is LONG.
1.14.4.9 H
Ha - Hi
HandFillColor Property
Description
Defines or returns the fill color of all the hands in the analog clock. In order that the hands are
displayed with the fill color defined, the "Handtype" property must be set to "0" (covering).
LONG write-read access.
See also
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
Handtype Property
Description
Defines the representation of the hands:
● 0: The hands are filled in the hand color defined and the edges in the foreground color.
● 1: The hands fill color is transparent and the edges displayed in the foreground color.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 443
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
HeaderSort Property
Description
Specifies if sorting of messages by message block column header is possible.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
Height Property
Description
Defines or returns the height of the object in pixels.
LONG (write-read access)
Example:
The following example halves the height of all objects in the "NewPDL1" picture whose names
begin with "Circle":
'VBS75
Dim objScreen
Dim objCircle
Dim lngIndex
Dim strName
lngIndex = 1
Set objScreen = HMIRuntime.Screens("NewPDL1")
For lngIndex = 1 To objScreen.ScreenItems.Count
'
'Searching all circles
strName = objScreen.ScreenItems.Item(lngIndex).ObjectName
If "Circle" = Left(strName, 6) Then
'
'to halve the height of the circles
Set objCircle = objScreen.ScreenItems(strName)
objCircle.Height = objCircle.Height / 2
End If
Next
WinCC: Scripting (VBS, ANSI-C, VBA)
444 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Width Property (Page 701)
Object types of the ScreenItem object (Page 141)
ScreenItem Object (Page 123)
HiddenInput Property
Description
TRUE, when the input value should not be displayed when being entered. Each character
entered is substituted by a *. BOOLEAN write-read access.
See also
I/O Field (Page 182)
ScreenItem Object (Page 123)
HideTagNames Property
Description
TRUE if the archive and tag name in the trend should be hidden via the right mouse button,
in the status line and in the table to display the coordinates. BOOLEAN write-read access.
HitlistColumnAdd property
HitlistColumnAdd
Transfers the selected message block from the list of available message blocks to the list of
selected message blocks.
The attribute can be assigned dynamic properties by means of the name HitlistColumnAdd .
The data type is STRING.
HitlistColumnAutoAdjust property
HitlistColumnAutoAdjust
Automatically optimizes the width of the columns in the hit list in Runtime. If the configured
column is not sufficient for the displayed text, the column width is increased.
If the user changes the width of columns in Runtime, the width is only optimized again when
the picture is opened again.
The attribute can be assigned dynamic properties using the name HitlistColumnAutoAdjust.
The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 445
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC AlarmControl (Page 238)
HitlistColumn object (list) (Page 220)
HitlistColumnCount property
HitlistColumnCount
Specifies the number of message blocks displayed in the hitlist in Runtime.
The attribute can be assigned dynamic properties by means of the name
HitlistColumnCount . The data type is LONG.
HitlistColumnIndex property
HitlistColumnIndex
References a message block selected for the hitlist. Using this attribute you can assign the
values of other attributes to a specific message block of the hitlist.
Values between 0 and "HitlistColumnCount" minus 1 are valid for "HitlistColumnIndex".
Attribute "HitlistColumnCount" defines the number of message blocks selected for the hitlist.
The "HitlistColumnIndex" attribute can be assigned dynamic properties by means of attribute
HitlistColumnRepos. The data type is LONG.
HitlistColumnName property
HitlistColumnName
Displays the name of the message block of the hitlist which is referenced with attribute
"HitlistColumnIndex". You cannot edit this name.
The attribute can be assigned dynamic properties by means of the name
HitlistColumnName . The data type is STRING.
HitlistColumnRemove property
HitlistColumnRemove
Cuts the marked message block from the list of selected message blocks and pastes it to the
list of available message blocks.
The attribute can be assigned dynamic properties by means of the name
HitlistColumnRemove. The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
446 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
HitlistColumnRepos
Up/Down - MessageColumnRepos/HitlistColumnRepos
Resorts the message blocks. The "Up" and "Down" commands move the selected message
block accordingly in the list. This moves the message block in Runtime Control towards the
front or towards the back.
The attribute for the hitlist can be assigned dynamic properties by means of the name
HitlistColumnRepos .
The attribute for the message list can be assigned dynamic properties by means of the name
MessageColumnRepos.
The data type is LONG.
HitlistColumnSort property
HitlistColumnSort
Defines the sorting order of the message block referenced in "HitlistColumnIndex" for the hitlist.
The following settings are available:
Value Description Explanation
0 none No sorting
1 Ascending Ascending order, starting at the lowest value.
2 Descending Descending order, starting at the highest value.
The attribute can be assigned dynamic properties by means of the name HitlistColumnSort .
The data type is LONG.
HitlistColumnSortIndex property
HitlistColumnSortIndex
Defines the sorting order of the message block referenced in "HitlistColumnIndex" in the hitlist.
The sorting criterion is removed from "HitlistColumnSort" if you set a "0" value..
The attribute can be assigned dynamic properties by means of the name
HitlistColumnSortIndex. The data type is LONG.
HitlistColumnVisible
Selected message blocks - MessageColumnVisible/HitlistColumnVisible
Selected message blocks of message list or hitlist that are displayed in Runtime. Defines
whether the message block referenced in "MessageColumnIndex" or "HitlistColumnIndex" is
displayed.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 447
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute for the message list can be assigned dynamic properties by means of the name
MessageColumnVisible.
The attribute for the hitlist can be assigned dynamic properties by means of the name
HitlistColumnVisible.
The data type is BOOLEAN.
HitlistDefaultSort property
HitlistDefaultSort
Defines the default sorting order in the table columns of the hitlist.
The following settings are available:
Value Description Explanation
0 Ascending The list is sorted in ascending order based on frequency.
1 Descending The list is sorted in descending order based on frequency.
The attribute can be assigned dynamic properties by means of the name HitlistDefaultSort.
The data type is LONG.
HitListMaxSourceItems property
Maximum number of data records - HitListMaxSourceItems
Defines the maximum number of data records for statistics.
The attribute can be assigned dynamic properties by means of the name
HitListMaxSourceItems . The data type is LONG.
HitListMaxSourceItemsWarn property
Warning when maximum is reached - HitListMaxSourceItemsWarn
Enables the output of a warning notice after the valid number of data records was reached.
Value Explanation
TRUE A warning is output after the valid maximum number of data records was reached.
FALSE A warning is not output after the valid maximum number of data records was reached.
The attribute can be assigned dynamic properties by means of the name
HitListMaxSourceItemsWarn. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
448 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
HitListRelTime property
Time range for statistics - HitListRelTime
Sets a time range for the statistics.
Value Explanation
TRUE The time range set for statistics is used if this range was not defined in the selection.
FALSE The time range is not used.
The attribute can be assigned dynamic properties by means of the name HitListRelTime. The
data type is BOOLEAN.
HitListRelTimeFactor property
Time range - HitListRelTimeFactor
Defines the factor for calculating the time range. Only integer factors are valid.
The attribute can be assigned dynamic properties by means of the name
HitListRelTimeFactor. The data type is LONG.
HitListRelTimeFactorType property
Time range - HitListRelTimeFactorType
Defines the time unit for calculating the time range.
The following time units are available:
Value Description
0 Minute
1 Hour
2 Day
3 Week
4 Month
The attribute can be assigned dynamic properties by means of the name
HitListMaxRelTimeFactorType. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 449
VBS for Creating Procedures and Actions
1.14 VBS Reference
Ho - Hy
HorizontalGridLines property
Horizontal - HorizontalGridLines
Defines whether horizontal separating lines will be displayed.
Value Explanation
TRUE Enables the display of horizontal dividers.
FALSE Disables the display of horizontal dividers.
The attribute can be assigned dynamic properties by means of the name
HorizontalGridLines. The data type is BOOLEAN.
Hotkey Property
Description
Returns the function key related to the mouse operation in respect of a button object.
Read only access.
See also
Button (Page 199)
ScreenItem Object (Page 123)
HourNeedleHeight Property
Description
Defines or returns the length of the hour hand for the analog clock. The specification of the
length is entered as a percentage value in relation to half the length of the short side of the
rectangular background. Write/Read access.
Example:
The shorter side of the rectangular background is 100 pixels long.
The hour hand length is 50.
This results in a length of the hour hand of (100 pixels / 2) * 0.5 = 25 pixels.
See also
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
450 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
HourNeedleWidth Property
Description
Defines or returns the width of the hour hand for the analog clock. The width is specified as a
percentage value related to double the length of the hour hand. Write/Read access.
Example:
The length of the hour hand is 25 pixels.
The hour hand width is 10.
This results in a width of the hour hand of 25 pixels * 2 * 0.1 = 5 pixels.
See also
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
Hysteresis Property
Description
TRUE, when the display should appear with hysteresis. BOOLEAN write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
HysteresisRange Property
Description
Defines the hysteresis in % of the displayed value or returns it.
The Hysteresis property must be set to TRUE for the hysteresis to be calculated.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 451
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.4.10 I
IconSpace property
IconSpace
Defines the spacing between the icons and text in the table cells. The value is active if and
icon and text are displayed.
The attribute can be assigned dynamic properties by means of the name IconSpace. The data
type is LONG.
IndependentWindow property
Description
Defines whether the display of the picture window in Runtime depends on the process picture
in which the picture window was configured.
TRUE if the size and position of the picture window are independent of the process picture
and only defined by the "Window mode" attribute.
FALSE if the size and position of the picture window change with the shift or scaling of the
process picture.
Index Property
Description
Check box, radio box
Defines or returns the number (0 to 31) of the field whose text is to be defined.
Combo box, list box
Defines or returns the number (0 to 31) of the line whose text is to be defined.
Polygon, polyline, tube polygon
Defines or returns the number of the corner point whose position coordinates are to be modified
or displayed.
WinCC online trend control, WinCC online table control, WinCC function trend control
The "Index" property is evaluated by other properties in order to be able to assign the settings
to a specific trend or column pair. The valid values for the index move within the range from 0
to (NumItems - 1). The "NumItems" properties contains the number of the trends/column pairs
to be displayed. The index must always be set before you change the properties of a trend /
column in runtime.
WinCC: Scripting (VBS, ANSI-C, VBA)
452 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Status display
Defines the status (0 to 255) or returns it. A basic picture and flash picture can be defined for
each status value.
See also
Status display (Page 197)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Function Trend Control (before WinCC V7) (Page 281)
Polyline (Page 156)
Polygon (Page 154)
Radio box (Page 205)
Check box (Page 202)
ScreenItem Object (Page 123)
InnerBevelOffset Property
Description
Defines the distance between the inner and outer bevels.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
InnerBevelStyle Property
Description
Defines the 3D effect for the inner bevel of the object.
● 0: No border.
● 1: The border is displayed depressed.
● 2: The border is displayed raised.
● 3: The border is displayed in one color without a 3D effect. The border color is defined by
the "BevelColorDown" property.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 453
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
InnerBevelWidth Property
Description
Defines the width of the inner bevel in pixels.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
InputValue property
Description
Defines the value to be entered by the user in the I/O field. The value is not displayed in the I/
O field when the property is set.
If you want the value to be displayed in the I/O field after confirmation with the <Return> key,
configure a direct connection between the properties "input value" and "output value". The
direct connection is only practical when no tag is connected to the output value, but the user
can nevertheless query the specified value, for example, through a script.
LONG write-read access.
See also
Example: Calling Methods of an ActiveX Control (Page 843)
InsertData Property
Description
Inserts data for the current trend.
TRUE : "DataIndex" is ignored and the data is appended to that in the data buffer.
FALSE : The data is inserted at the "DataIndex" position in the data buffer.
WinCC: Scripting (VBS, ANSI-C, VBA)
454 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The trend window is redrawn following each operation involving "Insert Data".
Note
The property is only supported for the controls prior to WinCC V7.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
Instance property
Description
Returns an instance of the alarm object.
See also
Alarms object (list) (Page 108)
ItemBorderBackColor Property
Description
Defines or returns the background color for dividing lines in the selection list of the text list
object. LONG write-read access. The background color is only visible with the property setting
ItemBorderStyle > 0.
See also
Text list (Page 194)
ScreenItem Object (Page 123)
ItemBorderColor Property
Description
Defines or returns the color for deviding lines in the selection list of the text list object. LONG
write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 455
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Text list (Page 194)
ScreenItem Object (Page 123)
ItemBorderStyle Property
Description
Defines or returns the color for the dividing line style in the selection list of the text list object.
Value range from 0 to 4.
0 = solid line
1 = dashed line
2 = dotted line
3 = dash-dotted line
4 = dash-dot-dot line
See also
Text list (Page 194)
ScreenItem Object (Page 123)
ItemBorderWidth Property
Description
Defines or returns the dividing line weight in pixels in the selection list of the text list object.
See also
Text list (Page 194)
ScreenItem Object (Page 123)
ItemProviderClsid Property
Description
"ItemProviderCIsid" shows, if the trend referenced using Index in Trend Control is connected
with an archive tag or an online tag.
WinCC: Scripting (VBS, ANSI-C, VBA)
456 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Notice: If you assign a value to the "ProviderCIsid" property , you will overwrite the trend-
specific property "ItemProviderCIsid".
● {416A09D2-8B5A-11D2-8B81-006097A45D48}: The trend is connected to an archive tag.
● {A3F69593-8AB0-11D2-A440-00A0C9DBB64E}: The trend is connected to an online tag.
If the trends are being supplied with archive and online tags, the property "ProviderCIsid"
returns the value "{00000000-0000-0000-0000-000000000000}".
ItemVisible Property
Description
TRUE, when a trend or a column pair reference by the "Index" property is visible. BOOLEAN
write-read access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
1.14.4.11 L
Lab - Las
Label Property
Description
The "Index" property references a trend. Label is used to define the name of the time axis or
value axis in accordance with the value of the "TimeAxis" property.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 457
VBS for Creating Procedures and Actions
1.14 VBS Reference
LabelColor Property
Description
Defines the color of the scale label.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
LabelX Property
Description
Defines or returns the label on the X-axis for a trend referenced by "Index" according to the
value of "TimeAxisX". Write/Read access.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
LabelY Property
Description
Defines or returns the label on the Y-axis for a trend referenced by "Index" according to the
value of "TimeAxisY". Write/Read access.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
LanguageSwitch Property
Description
Returns the value which defines where the language dependent assigned texts are stored.
Read only access.
TRUE, when the texts in the Text Library are managed. Translation to other language occurs
in the Text Library.
WinCC: Scripting (VBS, ANSI-C, VBA)
458 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
FALSE, when the texts are managed directly in the object. Translation to other language can
be carried out using Text Distributor.
See also
Text list (Page 194)
ScreenItem Object (Page 123)
Language Property
Description
Defines the current Runtime language or reads it.
You specify the Runtime language in VBS by using a country code, e.g., 1031 for German -
Default, 1033 for English - USA etc. A summary of all country codes may be found in the Basics
of VBScript under the subject header "Regional Scheme ID (LCID) Diagram".
INTEGER (write-read access)
Example:
The following example sets the data language to German:
'VBS76
HMIRuntime.Language = 1031
See also
HMIRuntime Object (Page 116)
LastError Property
Description
Returns an error code regarding the success of the last operation, e.g. information on a tag
write or read process. The "QualityCode" property can provide information on the quality of
the returned value. A description of the error can be called in using the "ErrorDescription"
property.
LONG (read only)
The following error codes are defined:
Code in hexadecimal notation Description
0x00000000 OK
0x80040001 Execution error
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 459
VBS for Creating Procedures and Actions
1.14 VBS Reference
Code in hexadecimal notation Description
0x80040002 Tag error
0x80040003 Server not available.
0x80040004 Multi Tag Error (Error in one or several tags)
In order that LastError returns a value, a read must be executed beforehand.
If an error occurs during read or write of several tags using the TagSet object, the error is set
to "Multi Tag Error". In order to determine at which tag the error occurred and what type of
error it was, the LastError property of each tag must be analyzed.
Example:
The following example displays the error code for "Tag1":
'VBS77
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read
MsgBox objTag.LastError
The following example adds two tags to the TagSet list and outputs the LastError property as
Trace.
'VBS178
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
HMIRuntime.Trace "LastError: " & group.LastError & vbNewLine
The LastError property of a tag contained in the list may be accessed as follows:
HMIRuntime.Trace "LastError: " & group("Motor1").LastError & vbNewLine
See also
TagSet Object (List) (Page 139)
QualityCode Property (Page 547)
ErrorDescription Property (Page 411)
Tag Object (Page 135)
WinCC: Scripting (VBS, ANSI-C, VBA)
460 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer
Layer Property
Description
Returns the layer of the picture in which the object is located. There is a total of 32 layers
available, whereby Layer "0" is the bottom layer and Layer "31" the top layer.
The configured objects are initially in the background of a layer.
LONG (read only)
Note
The layer property specifies the layer in which the object is located. The layer "0" is output as
"Layer0".
When accessed, the layers are counted up from 1 in VBS. Therefore, the layer "1" must be
addressed with "layers(2)".
Example:
The following example displays the name and layer of all the objects in the picture "NewPDL1":
'VBS78
Dim objScreen
Dim objScrItem
Dim lngAnswer
Dim lngIndex
Dim strName
lngIndex = 1
Set objScreen = HMIRuntime.Screens("NewPDL1")
For lngIndex = 1 To objScreen.ScreenItems.Count
strName = objScreen.ScreenItems.Item(lngIndex).ObjectName
Set objScrItem = objScreen.ScreenItems(strName)
lngAnswer = MsgBox(strName & " is in layer " & objScrItem.Layer,vbOKCancel)
If vbCancel = lngAnswer Then Exit For
Next
See also
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 461
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer00Checked Property
Description
TRUE, when limit 0 should be monitored. BOOLEAN write/read access.
Limit value and representation are defined with the Layer00Value and Layer00Color
properties.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer01Checked Property
Description
TRUE, when limit 1 should be monitored. BOOLEAN write/read access.
Limit value and representation are defined with the Layer01Value and Layer01Color
properties.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer02Checked Property
Description
TRUE, when limit 2 should be monitored. BOOLEAN write/read access.
Limit value and representation are defined with the Layer02Value and Layer02Color
properties.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
462 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer03Checked Property
Description
TRUE, when limit 3 should be monitored. BOOLEAN write/read access.
Limit value and representation are defined with the Layer03Value and Layer03Color
properties.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer04Checked Property
Description
TRUE, when limit 4 should be monitored. BOOLEAN write/read access.
Limit value and representation are defined with the Layer04Value and Layer04Color
properties.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer05Checked Property
Description
TRUE, when limit 5 should be monitored. BOOLEAN write/read access.
Limit value and representation are defined with the Layer05Value and Layer05Color
properties.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 463
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer06Checked Property
Description
TRUE, when limit 6 should be monitored. BOOLEAN write/read access.
Limit value and representation are defined with the Layer06Value and Layer06Color
properties.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer07Checked Property
Description
TRUE, when limit 7 should be monitored. BOOLEAN write/read access.
Limit value and representation are defined with the Layer07Value and Layer07Color
properties.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer08Checked Property
Description
TRUE, when limit 8 should be monitored. BOOLEAN write/read access.
Limit value and representation are defined with the Layer08Value and Layer08Color
properties.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
464 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer09Checked Property
Description
TRUE, when limit 9 should be monitored. BOOLEAN write/read access.
Limit value and representation are defined with the Layer09Value and Layer09Color
properties.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer10Checked Property
Description
TRUE, when limit 10 should be monitored. BOOLEAN write/read access.
Limit value and representation are defined with the Layer10Value and Layer10Color
properties.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer00Color Property
Description
Defines or returns the color for limit 0. LONG write/read access.
When monitoring of the limit value is activated (Layer00Checked property), the bar turns to
the color defined by this attribute on reaching the limit value.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 465
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer01Color Property
Description
Defines or returns the color for limit 1. LONG write/read access.
When monitoring of the limit value is activated (Layer01Checked property), the bar turns to
the color defined by this attribute on reaching the limit value.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer02Color Property
Description
Defines or returns the color for limit 2. LONG write/read access.
When monitoring of the limit value is activated (Layer02Checked property), the bar turns to
the color defined by this attribute on reaching the limit value.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer03Color Property
Description
Defines or returns the color for limit 3. LONG write/read access.
When monitoring of the limit value is activated (Layer03Checked property), the bar turns to
the color defined by this attribute on reaching the limit value.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
466 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer04Color Property
Description
Defines or returns the color for limit 4. LONG write/read access.
When monitoring of the limit value is activated (Layer04Checked property), the bar turns to
the color defined by this attribute on reaching the limit value.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer05Color Property
Description
Defines or returns the color for limit 5. LONG write/read access.
When monitoring of the limit value is activated (Layer05Checked property), the bar turns to
the color defined by this attribute on reaching the limit value.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer06Color Property
Description
Defines or returns the color for limit 6. LONG write/read access.
When monitoring of the limit value is activated (Layer06Checked property), the bar turns to
the color defined by this attribute on reaching the limit value.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 467
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer07Color Property
Description
Defines or returns the color for limit 7. LONG write/read access.
When monitoring of the limit value is activated (Layer07Checked property), the bar turns to
the color defined by this attribute on reaching the limit value.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer08Color Property
Description
Defines or returns the color for limit 8. LONG write/read access.
When monitoring of the limit value is activated (Layer08Checked property), the bar turns to
the color defined by this attribute on reaching the limit value.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer09Color Property
Description
Defines or returns the color for limit 9. LONG write/read access.
When monitoring of the limit value is activated (Layer09Checked property), the bar turns to
the color defined by this attribute on reaching the limit value.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
468 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer10Color Property
Description
Defines or returns the color for limit 10. LONG write/read access.
When monitoring of the limit value is activated (Layer10Checked property), the bar turns to
the color defined by this attribute on reaching the limit value.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer00FillColor property
Bar fill color 0 (Layer00FillColor)
The "Layer00FillColor" attribute defines the color with which the bar is filled in relation to "Limit
0".
The "Layer00FillColor" attribute can be made dynamic with the name "Layer00FillColor".
Layer01FillColor property
Layer01FillColor
The "Layer01FillColor" attribute defines the color with which the bar is filled in relation to "Limit
1".
The "Layer01FillColor" attribute can be made dynamic with the name "Layer01FillColor".
Layer02FillColor property
Layer02FillColor
The "Layer02FillColor" attribute defines the color with which the bar is filled in relation to "Limit
2".
The "Layer02FillColor" attribute can be made dynamic with the name "Layer02FillColor".
Layer03FillColor property
Layer03FillColor
The "Layer03FillColor" attribute defines the color with which the bar is filled in relation to "Limit
3".
The "Layer03FillColor" attribute can be made dynamic with the name "Layer03FillColor".
Layer04FillColor property
Layer04FillColor
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 469
VBS for Creating Procedures and Actions
1.14 VBS Reference
The "Layer04FillColor" attribute defines the color with which the bar is filled in relation to "Limit
4".
The "Layer04FillColor" attribute can be made dynamic with the name "Layer04FillColor".
Layer05FillColor property
Layer05FillColor
The "Layer05FillColor" attribute defines the color with which the bar is filled in relation to "Limit
5".
The "Layer05FillColor" attribute can be made dynamic with the name "Layer05FillColor".
Layer06FillColor property
Layer06FillColor
The "Layer06FillColor" attribute defines the color with which the bar is filled in relation to "Limit
6".
The "Layer06FillColor" attribute can be made dynamic with the name "Layer06FillColor".
Layer07FillColor property
Layer07FillColor
The "Layer07FillColor" attribute defines the color with which the bar is filled in relation to "Limit
7".
The "Layer07FillColor" attribute can be made dynamic with the name "Layer07FillColor".
Layer08FillColor property
Layer08FillColor
The "Layer08FillColor" attribute defines the color with which the bar is filled in relation to "Limit
8".
The "Layer08FillColor" attribute can be made dynamic with the name "Layer08FillColor".
Layer09FillColor property
Layer09FillColor
The "Layer09FillColor" attribute defines the color with which the bar is filled in relation to "Limit
9".
The "Layer09FillColor" attribute can be made dynamic with the name "Layer09FillColor".
Layer10FillColor property
Layer10FillColor
WinCC: Scripting (VBS, ANSI-C, VBA)
470 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The "Layer10FillColor" attribute defines the color with which the bar is filled in relation to "Limit
10".
The "Layer10FillColor" attribute can be made dynamic with the name "Layer10FillColor".
Layer00FillStyle property
Layer00FillStyle
The "Layer00FillStyle" attribute defines the style of the bar in relation to "Limit 0". For the fill
pattern to become visible, "bar fill color 0" must differ from "bar color 0".
There is a choice of 50 fill styles. The 0 "Solid" fill style fills the object with the set background
color. The 1 "Transparent" fill style means neither a background nor a fill pattern is displayed.
The "Layer00FillStyle" attribute can be made dynamic with the name "Layer00FillStyle".
Layer01FillStyle property
Layer01FillStyle
The "Layer01FillStyle" attribute defines the style of the bar in relation to "Limit 1". For the fill
pattern to become visible, "bar fill color 1" must differ from "bar color 1".
There is a choice of 50 fill styles. The 0 "Solid" fill style fills the object with the set background
color. The 1 "Transparent" fill style means neither a background nor a fill pattern is displayed.
The "Layer01FillStyle" attribute can be made dynamic with the name "Layer01FillStyle".
Layer02FillStyle property
Layer02FillStyle
The "Layer02FillStyle" attribute defines the style of the bar in relation to "Limit 2". For the fill
pattern to become visible, "bar fill color 2" must differ from "bar color 2".
There is a choice of 50 fill styles. The 0 "Solid" fill style fills the object with the set background
color. The 1 "Transparent" fill style means neither a background nor a fill pattern is displayed.
The "Layer02FillStyle" attribute can be made dynamic with the name "Layer02FillStyle".
Layer03FillStyle property
Layer03FillStyle
The "Layer03FillStyle" attribute defines the style of the bar in relation to "Limit 3". For the fill
pattern to become visible, "bar fill color 3" must differ from "bar color 3".
There is a choice of 50 fill styles. The 0 "Solid" fill style fills the object with the set background
color. The 1 "Transparent" fill style means neither a background nor a fill pattern is displayed.
The "Layer03FillStyle" attribute can be made dynamic with the name "Layer03FillStyle".
Layer04FillStyle property
Layer04FillStyle
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 471
VBS for Creating Procedures and Actions
1.14 VBS Reference
The "Layer04FillStyle" attribute defines the style of the bar in relation to "Limit 4". For the fill
pattern to become visible, "bar fill color 4" must differ from "bar color 4".
There is a choice of 50 fill styles. The 0 "Solid" fill style fills the object with the set background
color. The 1 "Transparent" fill style means neither a background nor a fill pattern is displayed.
The "Layer04FillStyle" attribute can be made dynamic with the name "Layer04FillStyle".
Layer05FillStyle property
Layer05FillStyle
The "Layer05FillStyle" attribute defines the style of the bar in relation to "Limit 5". For the fill
pattern to become visible, "bar fill color 5" must differ from "bar color 5".
There is a choice of 50 fill styles. The 0 "Solid" fill style fills the object with the set background
color. The 1 "Transparent" fill style means neither a background nor a fill pattern is displayed.
The "Layer05FillStyle" attribute can be made dynamic with the name "Layer05FillStyle".
Layer06FillStyle property
Layer06FillStyle
The "Layer06FillStyle" attribute defines the style of the bar in relation to "Limit 6". For the fill
pattern to become visible, "bar fill color 6" must differ from "bar color 6".
There is a choice of 50 fill styles. The 0 "Solid" fill style fills the object with the set background
color. The 1 "Transparent" fill style means neither a background nor a fill pattern is displayed.
The "Layer06FillStyle" attribute can be made dynamic with the name "Layer06FillStyle".
Layer07FillStyle property
Layer07FillStyle
The "Layer07FillStyle" attribute defines the style of the bar in relation to "Limit 7". For the fill
pattern to become visible, "bar fill color 7" must differ from "bar color 7".
There is a choice of 50 fill styles. The 0 "Solid" fill style fills the object with the set background
color. The 1 "Transparent" fill style means neither a background nor a fill pattern is displayed.
The "Layer07FillStyle" attribute can be made dynamic with the name "Layer07FillStyle".
Layer08FillStyle property
Layer08FillStyle
The "Layer08FillStyle" attribute defines the style of the bar in relation to "Limit 8". For the fill
pattern to become visible, "bar fill color 8" must differ from "bar color 8".
There is a choice of 50 fill styles. The 0 "Solid" fill style fills the object with the set background
color. The 1 "Transparent" fill style means neither a background nor a fill pattern is displayed.
The "Layer08FillStyle" attribute can be made dynamic with the name "Layer08FillStyle".
WinCC: Scripting (VBS, ANSI-C, VBA)
472 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer09FillStyle property
Layer09FillStyle
The "Layer09FillStyle" attribute defines the style of the bar in relation to "Limit 9". For the fill
pattern to become visible, "bar fill color 9" must differ from "bar color 9".
There is a choice of 50 fill styles. The 0 "Solid" fill style fills the object with the set background
color. The 1 "Transparent" fill style means neither a background nor a fill pattern is displayed.
The "Layer09FillStyle" attribute can be made dynamic with the name "Layer09FillStyle".
Layer10FillStyle property
Layer10FillStyle
The "Layer10FillStyle" attribute defines the style of the bar in relation to "Limit 10". For the fill
pattern to become visible, "bar fill color 10" must differ from "bar color 10".
There is a choice of 50 fill styles. The 0 "Solid" fill style fills the object with the set background
color. The 1 "Transparent" fill style means neither a background nor a fill pattern is displayed.
The "Layer10FillStyle" attribute can be made dynamic with the name "Layer10FillStyle".
Layer00Value Property
Description
Determines the value for "Limit 0" or returns it.
Monitoring only takes effect when the Layer00Checked property value is set to TRUE.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer01Value Property
Description
Determines the value for "Limit 1" or returns it.
Monitoring only takes effect when the Layer01Checked property value is set to TRUE.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 473
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer02Value Property
Description
Determines the value for "Limit 2" or returns it.
Monitoring only takes effect when the Layer02Checked property value is set to TRUE.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer03Value Property
Description
Determines the value for "Limit 3" or returns it.
Monitoring only takes effect when the Layer03Checked property value is set to TRUE.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer04Value Property
Description
Determines the value for "Limit 4" or returns it.
Monitoring only takes effect when the Layer04Checked property value is set to TRUE.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer05Value Property
Description
Determines the value for "Limit 5" or returns it.
Monitoring only takes effect when the Layer05Checked property value is set to TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
474 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer06Value Property
Description
Determines the value for "Limit 6" or returns it.
Monitoring only takes effect when the Layer06Checked property value is set to TRUE.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer07Value Property
Description
Determines the value for "Limit 7" or returns it.
Monitoring only takes effect when the Layer07Checked property value is set to TRUE.
See also
ScreenItem Object (Page 123)
3D Bar (Page 167)
Layer08Value Property
Description
Determines the value for "Limit 8" or returns it.
Monitoring only takes effect when the Layer08Checked property value is set to TRUE.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 475
VBS for Creating Procedures and Actions
1.14 VBS Reference
Layer09Value Property
Description
Determines the value for "Limit 9" or returns it.
Monitoring only takes effect when the Layer09Checked property value is set to TRUE.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
Layer10Value Property
Description
Determines the value for "Limit 10" or returns it.
Monitoring only takes effect when the Layer10Checked property value is set to TRUE.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
LayerDeclutteringEnable Property
Description
Returns the LayerDecluttering properties of a picture.
LayerDecluttering enables fading in and out of layers depending on the set minimum and
maximum zoom.
BOOLEAN Read-only access.
Example:
The example outputs the LayerDecluttering Property NewPDL1 as a trace.
'VBS156
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine
WinCC: Scripting (VBS, ANSI-C, VBA)
476 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Screen Object (Page 129)
Layers Property
Description
Returns an object of type "Layers".
Layers (read-only)
See also
Layers Object (Listing) (Page 119)
HMIRuntime Object (Page 116)
Le - Li
Left Property
Description
Defines or returns the X-coordinate of an object (measured from the top left edge of the picture)
in pixels. The X-coordinate relates to the top left corner of the rectangle enclosing the object.
LONG (write-read access)
Example:
The following example shifts all objects in the picture "NewPDL1" 5 pixels to the left:
'VBS79
Dim objScreen
Dim objScrItem
Dim lngIndex
Dim strName
lngIndex = 1
Set objScreen = HMIRuntime.Screens("NewPDL1")
For lngIndex = 1 To objScreen.ScreenItems.Count
strName = objScreen.ScreenItems.Item(lngIndex).ObjectName
Set objScrItem = objScreen.ScreenItems(strName)
objScrItem.Left = objScrItem.Left - 5
Next
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 477
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Top Property (Page 644)
ScreenItem Object (Page 123)
LeftComma Property
Description
Defines or returns the number of digits to the left of the decimal point (0 to 20).
See also
Bar (Page 172)
ScreenItem Object (Page 123)
LightEffect Property
Description
TRUE, when the light effect should be activated. BOOLEAN write-read access.
See also
3D Bar (Page 167)
ScreenItem Object (Page 123)
LimitHigh4 Property
Description
Determines the upper limit value for "Reserve 4" or returns it.
The CheckLimitHigh4 property must be set to TRUE in order that the "Reserve 4" limit value
can be monitored.
The type of the evaluation (in percent or absolute) is defined in the TypeLimitHigh4 property.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
478 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
LimitHigh5 Property
Description
Determines the upper limit value for "Reserve 5" or returns it.
The CheckLimitHigh5 property must be set to TRUE in order that the "Reserve 5" limit value
can be monitored.
The type of the evaluation (in percent or absolute) is defined in the TypeLimitHigh5 property.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
LimitLow4 Property
Description
Determines the lower limit value for "Reserve 4" or returns it.
The CheckLimitLow4 property must be set to TRUE in order that the "Reserve 4" limit value
can be monitored.
The type of the evaluation (in percent or absolute) is defined in the TypeLimitLow4 property.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
LimitLow5 Property
Description
Determines the lower limit value for "Reserve 5" or returns it.
The CheckLimitLow5 property must be set to TRUE in order that the "Reserve 5" limit value
can be monitored.
The type of the evaluation (in percent or absolute) is defined in the TypeLimitLow5 property.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 479
VBS for Creating Procedures and Actions
1.14 VBS Reference
LimitMax Property
Description
Determines the upper limit value as an absolute value depending on the data format or returns
it.
If the displayed value exceeds the upper limit value, it is displayed by a sequence of *** (not
displayable).
See also
I/O Field (Page 182)
ScreenItem Object (Page 123)
LimitMin Property
Description
Determines the lower limit value as an absolute value depending on the data format or returns it.
If the displayed value exceeds the upper limit value, it is displayed by a sequence of *** (not
displayable).
See also
I/O Field (Page 182)
ScreenItem Object (Page 123)
LineColor property
Color of window dividers - LineColor
Specifies the color of the window dividers. The button opens the "Color selection" dialog.
The attribute can be assigned dynamic properties by means of the name LineColor. The data
type is LONG.
LineFont Property
Description
TRUE, when the font size should be automatically adapted to the line height. BOOLEAN write-
read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
480 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
LineHeight Property
Description
TRUE, when the line height can be modified. BOOLEAN write-read access.
The "LineHeight" property is only deactivated if both properties "LineHeight" and "LineFont"
are set to "FALSE".
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
LineJoinStyle property
Description
Defines the way that corners are displayed in a tube polygon.
Angle The tubes are joined at corner points without rounding
Round The tubes are rounded at the outside corner points.
LineTitle Property
Description
TRUE, when the message window a column with consecutive number contains queued
messages. BOOLEAN write-read access.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 481
VBS for Creating Procedures and Actions
1.14 VBS Reference
LineWidth property (before WinCC V7)
Description
Specifies the line width of the trend referenced by "Index". Value range from 0 to 10.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
LineWidth property
Line weight of window dividers - LineWidth
Defines the line weight of the window dividers in pixels.
The attribute can be assigned dynamic properties by means of the name LineWidth. The data
type is LONG.
ListType property
List - ListType
Specifies which of the following lists is displayed in WinCC UserAdminControl.
Value Name Explanation
0 Users The user list is displayed.
1 Groups The group list is displayed.
The attribute can be assigned dynamic properties using the name ListType. The data type is
LONG.
ListType Property
Description
Returns the data type displayed in the case of a text list object. Read only access.
Value range from 0 to 2.
0 = decimal
1 = binary
2 = bit
WinCC: Scripting (VBS, ANSI-C, VBA)
482 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Text list (Page 194)
ScreenItem Object (Page 123)
Lo
LoadDataImmediately property
Load archive data - LoadDataImmediately
Defines whether the tag values for the time range to be displayed are loaded from the archives
when the picture is called.
Value Explanation
TRUE Loads archived values on picture calls.
FALSE Loads only current values on picture calls.
The attribute can be assigned dynamic properties by means of the name
LoadDataImmediately. The data type is BOOLEAN.
LoadDataImmediately property (before WinCC V7)
Description
TRUE, when the tag values for the time range to be displayed are loaded from the archives
on opening a picture. BOOLEAN write-read access.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
LocaleID Property
Description
Defines the language to be displayed in the control, e.g. 1031 for German. Write/Read access.
The list of language codes is available in the WinCC documentation (Index > Language Code).
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 483
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Slider Control (Page 270)
WinCC Gauge Control (Page 251)
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
LocaleSpecificSettings Property
Description
TRUE if a font can be assigned and formatted for each Runtime language. BOOLEAN write-
read access.
LockBackColor Property
Description
Defines or returns the background color of the button for a locked measuring point. LONG
write/read access.
The LockStatus property must be set to TRUE for the background color to be displayed.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
LockStatus Property
Description
TRUE, when a locked measuring point should be displayed. BOOLEAN write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
484 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
LockText Property
Description
Defines the label of a button for a locked measuring point.
The LockStatus property must be set to TRUE for the label to be displayed.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
LockTextColor Property
Description
Defines or returns the color of the button label for a locked measuring point. LONG write/read
access.
The LockStatus property must be set to TRUE for the background color to be displayed.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
Logging Property
Description
Returns an object of type "Logging".
Logging (read-only)
See also
HMIRuntime Object (Page 116)
Logging Object (Page 120)
LongStrokesBold Property
Description
TRUE, when the long sections of a scale should be displayed in bold face. BOOLEAN write-
read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 485
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Bar (Page 172)
ScreenItem Object (Page 123)
LongStrokesOnly Property
Description
TRUE, when only the long sections of a scale should be displayed . BOOLEAN write-read
access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
LongStrokesSize Property
Description
Defines or returns the length of the axis section in pixels.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
LongStrokesTextEach Property
Description
Returns the value which defines which sections of the scale displayed should be labeled (1 =
every section, 2 = every second section, etc.). Read only access
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
486 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
LongTimeArchiveConsistency Property
LongTimeArchiveConsistency
If "LongTimeArchiveConsistency" is set to "No", 1000 messages are displayed in the long-term
archive list on the single-user system, server or client for each server, or for each redundant
server pair.
If the "LongTimeArchiveConsistency" is set to "yes", the most recent 1000 messages are
displayed on the client of all servers or redundant server pair in the long-term archive list.
The attribute can be assigned dynamic properties by means of the name
LongTimeArchiveConsistency . The data type is BOOLEAN.
LongTimeArchiveConsistency property (before WinCC V7)
Description
If "LongTimeArchiveConsistency" is set to "No", 1000 messages are displayed in the long-term
archive list in the single-user system, server or client for each server or for each redundant
server pair.
If the "LongTimeArchiveConsistency" is set to "yes", the most recent 1000 messages are
displayed on the client of all servers or redundant server pair in the long-term archive list.
Write/Read access.
LowerLimit Property
Description
WinCC Online Trend Control/WinCC Function Trend Control
TRUE, when the "LowerLimitColor" specification is to be used in order to identify the tag values
(from a trend referenced via "Index") which lie below the value defined in "LowerLimitValue".
BOOLEAN write-read access.
WinCC Online Trend Control
The value of this attribute cannot be changed. Read only access.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 487
VBS for Creating Procedures and Actions
1.14 VBS Reference
LowerLimitColor Property
Description
WinCC Online Trend Control/WinCC Function Trend Control
Defines the color to be used in order to identify the tag values (from trend referenced via
"Index") which lie below the value defined in "LowerLimitValue". Whether the information is
evaluated is dependent on the value of the "LowerLimit" property. The color is defined as an
RGB value. LONG write-read access.
Online Table Control
The value of this attribute cannot be changed. Read only access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
LowerLimitTagName Property
Description
This defines the lower limit of the trend range, which is automatically taken from the variable
properties configured in PCS 7. Write/Read access.
LowerLimitValue Property
Description
WinCC Online Trend Control/WinCC Function Trend Control
Tag values (from a trend referenced via "Index") which lie below the value defined by
"LowerLimitValue" are identified by the color specified in "LowerLimitColor". Whether the
information is evaluated is dependent on the value of the "LowerLimit" attribute.
Online Table Control
The value of this attribute cannot be changed. Read only access.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC: Scripting (VBS, ANSI-C, VBA)
488 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
1.14.4.12 M
Ma - Mc
Marker Property
Description
TRUE, when the limit values should be displayed as scale values. BOOLEAN write-read
access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
Max Property
Description
Defines or returns the absolute value in the case of a full value display. This value is displayed
if the scale display is active.
See also
Bar (Page 172)
Slider (Page 210)
3D Bar (Page 167)
ScreenItem Object (Page 123)
MaximizeButton Property
Description
TRUE, when the object can be maximized in Runtime. Read only access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 489
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Picture Window (Page 177)
Application Window (Page 171)
ScreenItem Object (Page 123)
MCGUBackColorOff-Eigenschaft
Description
Defines or returns the background color for flash status "Off" in the case of the "Departed
Unacknowledged" status. LONG write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCGUBackColorOn Property
Description
Defines or returns the background color for flash status "On" in the case of the "Departed
Unacknowledged" status. LONG write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCGUBackFlash Property
Description
TRUE, when the background should flash when a message departs unacknowledged.
BOOLEAN write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
490 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
MCGUTextColorOff Property
Description
Defines or returns the color of the text for flash status "Off" in the case of the "Departed
Unacknowledged" status. LONG write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCGUTextColorOn Property
Description
Defines or returns the background color of the text for flash status "Off" in the case of the
"Departed Unacknowledged" status. LONG write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCGUTextFlash Property
Description
TRUE, when the font should flash when a message departs unacknowledged. BOOLEAN write-
read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCKOBackColorOff Property
Description
Defines or returns the background color for flash status "Off" in the case of the "Arrived" status.
LONG write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 491
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCKOBackColorOn Property
Description
Defines or returns the background color for flash status "On" in the case of the "Arrived" status.
LONG write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCKOBackFlash Property
Description
TRUE, when the background should flash when a message arrives. BOOLEAN write-read
access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCKOTextColorOff Property
Description
Defines or returns the color of the text for flash status "Off" in the case of the "Arrived" status.
LONG write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
492 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
MCKOTextColorOn Property
Description
Defines or returns the background color of the text for flash status "On" in the case of the
"Arrived" status. LONG write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCKOTextFlash Property
Description
TRUE, when the font should flash when a message arrives. BOOLEAN write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCKQBackColorOff Property
Description
Defines or returns the background color for flash status "Off" in the case of the "Departed
Acknowledged" status. LONG write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCKQBackColorOn Property
Description
Defines or returns the background color for flash status "On" in the case of the "Departed
Acknowledged" status. LONG write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 493
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCKQBackFlash Property
Description
TRUE, when the background should flash when a message departs acknowledged. BOOLEAN
write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCKQTextColorOff Property
Description
Defines or returns the color of the text for flash status "Off" in the case of the "Departed
Acknowledged" status. LONG write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCKQTextColorOn Property
Description
Defines or returns the background color of the text for flash status "On" in the case of the
"Departed Acknowledged" status. LONG write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
494 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
MCKQTextFlash Property
Description
TRUE, when the font should flash when a message departs acknowledged. BOOLEAN write-
read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MCText Property
Description
Defines or returns the label for the respective message class.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
Me
MeasurePoints Property
Description
The "Index" property references a trend. "MeasurePoints" defines the number of measuring
points to be displayed. The information is only evaluated when the "TimeAxis" property is set
to the value "-1".
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 495
VBS for Creating Procedures and Actions
1.14 VBS Reference
MenuToolBarConfig Property
Description
Loads the given configuration file with configured menu and toolbars or returns the name of
the configuration file. STRING (write-read access)
See also
Picture Window (Page 177)
HMIRuntime Object (Page 116)
MessageBlockAlign property
Alignment - MessageBlockAlign
Aligns the contents of a selected message block in the table.
To change the alignment, the option "Apply project settings" must be deactivated or
"ApplyProjectSettings" must be set to "FALSE".
The following settings are available:
Value Description Explanation
0 Left Aligns the contents of a selected message block to the left.
1 Centered Aligns the contents of a selected message block to the center.
2 Right Aligns the contents of a selected message block to the right.
The attribute can be assigned dynamic properties by means of the name MessageBlockAlign.
The data type is LONG.
MessageBlockAutoPrecisions property
Automatic decimal places - MessageBlockAutoPrecisions
Enables automatic setting of the number of decimal places.
Value Explanation
TRUE The number of decimal places is set automatically. The value in the "Decimal places" field is disabled.
FALSE The value in the "Decimal places" field is enabled.
The attribute can be assigned dynamic properties by means of the name
MessageBlockAutoPrecisions. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
496 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
MessageBlockCaption property
Label - MessageBlockCaption
Defines the label of the column title in the message window for the selected message block.
The label specified is active in all Runtime languages.
To change the label, the option "Apply project settings" must be deactivated or
"ApplyProjectSettings" must be set to "FALSE".
The attribute can be assigned dynamic properties by means of the name
MessageBlockCaption. The data type is STRING.
MessageBlockCount property
MessageBlockCount
Defines the number of message blocks which are available for the message list and the hitlist.
The attribute can be assigned dynamic properties by means of the name
MessageBlockCount . The data type is LONG.
MessageBlockDateFormat property
Date format - MessageBlockDateFormat
Defines the date format for displaying messages.
To change the date format, the option "Apply project settings" must be deactivated or
"ApplyProjectSettings" must be set to "FALSE".
The following date formats are available:
Value Explanation
Automatic The date format is set automatically.
dd.MM.yy Day.Month.Year, e.g. 24.12.07.
dd.MM.yyyy Day.Month.Year, e.g. 24.12.2007.
dd/MM/yy Day/Month/Year, e.g. 24/12/07.
dd/MM/yyyy Day/Month/Year, e.g. 24/12/2007.
The attribute can be assigned dynamic properties by means of the name
MessageBlockDateFormat. The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 497
VBS for Creating Procedures and Actions
1.14 VBS Reference
MessageBlockExponentialFormat property
Exponential notation - MessageBlockExponentialFormat
Specifies the exponential notation for visualization of the values of a selected message block.
Value Explanation
TRUE The values are displayed with exponential notation.
FALSE The values are displayed with decimal notation.
The attribute can be assigned dynamic properties by means of the name
MessageBlockExponentialFormat. The data type is BOOLEAN.
MessageBlockFlashMode property
Flash mode - MessageBlockFlashMode
Specifies how the content of the selected message block flashes in Runtime when a message
appears. The "Flashing on" option must be selected.
To change the setting, the option "Apply project settings" must be deactivated or
"ApplyProjectSettings" must be set to "FALSE".
Val‐ Description Explanation
ue
0 Standard The text color switches between the standard color and the flash color when flashing
1 Switch back‐ The color of the background and the text color switch during flashing. You configure the message
ground color/text colors for the type of message in the alarm logging editor.
color
2 Switch message The message colors and the configured table colors switch during flashing. You configure the
color/table color message colors for the type of message in the alarm logging editor. Set the table colors in the
"Layout" tab in the AlarmControl.
The attribute can be assigned dynamic properties by means of the name
MessageBlockFlashMode. The data type is LONG.
MessageBlockFlashOn property
Flashing on - MessageBlockFlashOn
Enables flashing of the selected message block in Runtime after a message was activated.
To change the setting, the option "Apply project settings" must be deactivated or
"ApplyProjectSettings" must be set to "FALSE".
Value Explanation
TRUE Flashing message block content.
FALSE No flashing message block content.
WinCC: Scripting (VBS, ANSI-C, VBA)
498 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name
MessageBlockFlashOn. The data type is BOOLEAN.
MessageBlockHideText property
Content as text - MessageBlockHideText
Enables the textual display of the content of a selected message block.
Value Explanation
TRUE The content is not displayed in text format. The option is disabled.
FALSE The content is displayed in text format. The option is enabled.
The attribute can be assigned dynamic properties by means of the name
MessageBlockHideText. The data type is BOOLEAN.
MessageBlockHideTitleText property
Title as text - MessageBlockHideTitleText
Enables the display of the header of a selected message block in text format.
Value Explanation
TRUE The header is not displayed in text format. The option is disabled.
FALSE The header is displayed in text format. The option is enabled.
The attribute can be assigned dynamic properties by means of the name
MessageBlockHideTitleText. The data type is BOOLEAN.
MessageBlockId property
MessageBlockId
Default assignment of the ID number and message block in WinCC AlarmControl.
The attribute can be assigned dynamic properties by means of the name MessageBlockID.
The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 499
VBS for Creating Procedures and Actions
1.14 VBS Reference
MessageBlockInvertUseMessageColor property
MessageBlockInvertUseMessageColor
Specifies for the message block whether or not the message colors are displayed, contrary to
the central setting for the AlarmControl . For example, the "UseMessageColor" property is set
to "FALSE" for the AlarmControl. You have set the "MessageBlockInvertUseMessageColor"
property to "TRUE" for a message block. This causes the message colors to be displayed for
this message block in Runtime.
Value Explanation
TRUE Contrary to the central setting in "UseMessageColor", the message colors are displayed or not displayed
for the message block.
FALSE Just like the central setting in "UseMessageColor", the message colors are displayed or not displayed
for the message block.
The attribute can be assigned dynamic properties by means of the name
MessageBlockInvertUseMessageColor. The data type is BOOLEAN.
MessageBlockIndex property
MessageBlockIndex
References an existing message block. Using this attribute, you can assign a specific message
block values for other attributes.
Values between 0 and "MessageBlockCount" minus 1 are valid for "MessageBlockIndex".
Attribute "MessageBlockCount" defines the number of available message blocks.
The attribute can be assigned dynamic properties by means of the name
MessageBlockIndex. The data type is LONG.
MessageBlockLeadingZeros property
Number of digits - MessageBlockLeadingZeros
Defines the number of leading zeros for the message block content. The maximum number is
"11". A "0" value deactivates the "With leading zeros" option.
To change the setting, the option "Apply project settings" must be deactivated or
"ApplyProjectSettings" must be set to "FALSE".
The attribute can be assigned dynamic properties by means of the name
MessageBlockLeadingZeros. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
500 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
MessageBlockLength property
Length in characters - MessageBlockLength
Defines the length of the message block selected based on the number of characters.
To change the length, the option "Apply project settings" must be deactivated or
"ApplyProjectSettings" must be set to "FALSE".
The attribute can be assigned dynamic properties by means of the name
MessageBlockLength. The data type is LONG.
MessageBlockName property
Object name - MessageBlockName
Displays the object name of the message block selected. You cannot edit this name.
The data type is STRING.
MessageBlockPrecisions property
Decimal places - MessageBlockPrecisions
Specifies the decimal precision of the values of a selected message block. You can only enter
the value if the "Automatic" option is disabled.
The attribute can be assigned dynamic properties by means of the name
MessageBlockPrecisions. The data type is SHORT.
MessageBlockSelected property
Available message blocks - MessageBlockSelected
The available message blocks are blocks that can be used in Runtime for the message list or
hitlist.
Select the "Message blocks" tab to activate existing message blocks as required in the Control.
Select the "Hitlist" and "Message list" tabs to configure the hitlist and message list based on
the available blocks.
To change the setting, the option "Apply project settings" must be deactivated or
"ApplyProjectSettings" must be set to "FALSE".
The attribute can be assigned dynamic properties by means of the name
MessageBlockSelected. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 501
VBS for Creating Procedures and Actions
1.14 VBS Reference
MessageBlockShowDate property
Show date - MessageBlockShowDate
Enables the display of a date in the "Time" message block in addition to the time.
Value Explanation
TRUE Date and time are displayed.
FALSE The time is displayed.
The attribute can be assigned dynamic properties by means of the name
MessageBlockShowDate. The data type is BOOLEAN.
MessageBlockShowIcon property
Content as icon - MessageBlockShowIcon
Enables the display of the content of a selected message block as icon.
Value Explanation
TRUE The content is visualized as icon.
FALSE The content is not visualized as icon.
The attribute can be assigned dynamic properties by means of the name
MessageBlockShowIcon. The data type is BOOLEAN.
MessageBlockShowTitleIcon property
Title as icon - MessageBlockShowTitleIcon
Enables the display of the title of a selected message block as icon.
Value Explanation
TRUE The header is displayed as icon.
FALSE The header is not displayed as icon.
The attribute can be assigned dynamic properties by means of the name
MessageBlockShowTitleIcon. The data type is BOOLEAN.
MessageBlockTextId property
Text ID - MessageBlockTextId
Specifies the caption of the selected message block using a Text ID which was derived from
the text library. The caption is adapted automatically if a user changes the Runtime language.
WinCC: Scripting (VBS, ANSI-C, VBA)
502 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
To change the setting, the option "Apply project settings" must be deactivated or
"ApplyProjectSettings" must be set to "FALSE".
The attribute can be assigned dynamic properties by means of the name
MessageBlockTextId. The data type is LONG.
MessageBlockTimeFormat property
MessageBlockTimeFormat
Defines which time format or duration format is used for displaying the messages.
To change the setting, the option "Apply project settings" must be deactivated or
"ApplyProjectSettings" must be set to "FALSE".
The following time formats are available:
Value Explanation
Automatic The time format is set automatically.
HH:mm:ss Hours:Minutes:Seconds, e.g. 15:35:44
HH:mm:ss.ms Hours:Minutes:Seconds.Milliseconds, e.g. 15:35:44.240.
hh:mm:ss tt Hours:Minutes:Seconds AM/PM, e.g. 03:35:44 PM.
hh:mm:ss.ms tt Hours:Minutes:Seconds.Milliseconds AM/PM, e.g. 03:35:44.240 PM.
The following time duration formats are available:
Value Explanation
Automatic The time duration format is determined automatically.
d H:mm:ss Day Hours:Minutes:Seconds, e.g. 1 2:03:55.
H:mm:ss. Hours:Minutes:Seconds, e.g. 26:03:55.
m:ss Minutes:Seconds, Example: 1563:55.
s Seconds, e.g. 93835.
The attribute can be made dynamic by means of the name MessageBlockTimeFormat. The
data type is STRING.
MessageBlockType property
MessageBlockType
Displays the association of the message block.
The following settings are available:
Value Description Explanation
0 System block The message block belongs to the system block category.
1 Text block The message block belongs to the user text block category.
2 Process value block The message block belongs to the process value block category.
3 Hitlist block The message block belongs to the message blocks of the hitlist.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 503
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name
MessageBlockType . The data type is LONG.
MessageClass Property
Description
Defines the respective message type (Alarm High, Alarm Low, Warning High, Warning Low, ...)
for which the "Display Text", "Arrived-", "Arrived Acknowledged -" and "Departed
Unacknowledged -" settings have been configured.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
MessageColumnAdd property
MessageColumnAdd
Adds the selected message block from the list of existing message blocks to the list of selected
message blocks.
The attribute can be assigned dynamic properties by means of the name
MessageColumnAdd . The data type is STRING.
MessageColumnAutoAdjust property
MessageColumnAutoAdjust
Automatically optimizes the width of the columns in the WinCC AlarmControl in Runtime. If the
configured column is not sufficient for the displayed text, the column width is increased.
If the user changes the width of columns in Runtime, the width is only optimized again when
the picture is opened again.
The attribute can be assigned dynamic properties using the name
MessageColumnAutoAdjust . The data type is BOOLEAN.
See also
MessageColumn object (list) (Page 221)
WinCC AlarmControl (Page 238)
WinCC: Scripting (VBS, ANSI-C, VBA)
504 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
MessageColumnCount property
MessageColumnCount
Specifies the number of message blocks to be displayed in the message list in Runtime.
The attribute can be assigned dynamic properties by means of the name
MessageColumnCount . The data type is LONG.
MessageColumnIndex property
MessageColumnIndex
References a message block selected for the message list. Using this attribute you can assign
the values of other attributes to a specific message block of the message list.
Values between 0 and "MessageColumnCount" minus 1 are valid for "MessageColumnIndex".
Attribute "MessageColumnCount" defines the number of message blocks selected for the
message list.
The "MessageColumnIndex" attribute can be assigned dynamic properties by means of
attribute MessageColumnRepos. The data type is LONG.
MessageColumnName property
MessageColumnName
Displays the name of the message block of the message list which is referenced with attribute
"MessageColumnIndex". You cannot edit this name.
The attribute can be assigned dynamic properties with the name MessageColumnName. The
data type is STRING.
MessageColumnRemove property
MessageColumnRemove
Cuts the marked message block from the list of selected message blocks and pastes it to the
list of available message blocks.
The attribute can be assigned dynamic properties by means of the name
MessageColumnRemove . The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 505
VBS for Creating Procedures and Actions
1.14 VBS Reference
MessageColumnRepos property
Up/Down - MessageColumnRepos/HitlistColumnRepos
Resorts the message blocks. The "Up" and "Down" commands move the selected message
block accordingly in the list. This moves the message block in Runtime Control towards the
front or towards the back.
The attribute for the hitlist can be assigned dynamic properties by means of the name
HitlistColumnRepos .
The attribute for the message list can be assigned dynamic properties by means of the name
MessageColumnRepos.
The data type is LONG.
MessageColumnSort property
MessageColumnSort
Defines the sorting order of the message block referenced in "MessageColumnIndex" .
The following settings are available:
Value Description Explanation
0 no No sorting
1 Ascending Ascending order, starting at the lowest value.
2 Descending Descending order, starting at the highest value.
The attribute can be assigned dynamic properties by means of the name
MessageColumnSort . The data type is LONG.
MessageColumnSortIndex property
MessageColumnSortIndex
Defines the sorting order of the message block referenced in "MessageColumnIndex". The
sorting criterion is removed from "MessageColumnSort" if you set a "0" value.
The attribute can be assigned dynamic properties by means of the name
MessageColumnSortIndex. The data type is LONG.
MessageColumnVisible property
Selected message blocks - MessageColumnVisible/HitlistColumnVisible
Selected message blocks of message list or hitlist that are displayed in Runtime. Defines
whether the message block referenced in "MessageColumnIndex" or "HitlistColumnIndex" is
displayed.
WinCC: Scripting (VBS, ANSI-C, VBA)
506 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute for the message list can be assigned dynamic properties by means of the name
MessageColumnVisible.
The attribute for the hitlist can be assigned dynamic properties by means of the name
HitlistColumnVisible.
The data type is BOOLEAN.
MessageListType property
Active list on picture call - MessageListType
Selection field for defining the active list for picture calls.
Value Description Explanation
0 Message list The currently active messages are displayed after a picture was
called.
1 Short-term archive list A short-term archive list displays the logged messages after the
picture was called. The display is updated immediately on activation
of new messages.
2 Long-term archive list A long-term archive list displays the logged messages after a picture
was called.
3 Lock list Only the currently locked messages are displayed after a picture
was called.
4 Hitlist The configured statistics data is displayed after a picture was called.
5 List of messages to be The messages to be hidden are displayed at the call of a picture.
hidden
The attribute can be assigned dynamic properties by means of the name MessageListType.
The data type is LONG.
Mi - Ms
Min Property
Description
Defines or returns the absolute value in the case of the smallest value display. This value is
displayed if the scale display is active.
See also
Slider (Page 210)
Bar (Page 172)
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 507
VBS for Creating Procedures and Actions
1.14 VBS Reference
MinuteNeedleHeight Property
Description
Defines or returns the length of the minute hand for the analog clock. The specification of the
length is entered as a percentage value in relation to half the length of the short side of the
rectangular background. Write/Read access.
Example:
The shorter side of the rectangular background is 100 pixels long.
The minute hand length is 80.
This results in a length of the minute hand of (100 pixels / 2) * 0.8 = 40 pixels.
See also
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
MinuteNeedleWidth Property
Description
Defines or returns the width of the minute hand for the analog clock. The width is specified as
a percentage value related to double the length of the minute hand.
Example:
The length of the minute hand is 40 pixels.
The minute hand width is 8.
This results in a width of the minute hand of 40 pixels * 2 * 0.08 = 6 pixels.
See also
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
Moveable Property
Description
TRUE, when the object can be moved in Runtime. Read only access.
See also
Picture Window (Page 177)
Application Window (Page 171)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
508 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Moveable Property
Movable
Defines whether the control can be moved in Runtime.
Value Explanation
TRUE The control can be moved in Runtime.
FALSE The control cannot be moved in Runtime.
The attribute can be assigned dynamic properties by means of the name Moveable. The data
type is BOOLEAN.
MsgCtrlFlags property (before WinCC V7)
Description
Defines the sorting sequence in Alarm Control. Write/Read access.
● 0: The entries are sorted by the value in the time column and in ascending order, i.e. the
oldest messages are displayed at the top of the message window.
● 1: The entries are sorted by the value in the time column in descending order, i.e. the oldest
messages are displayed at the bottom of the message window. In the case of this value,
the "AutoScroll" property is automatically deactivated, otherwise the current message could
be moved out of the display area of the message window.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
MsgFilterSQL property (before WinCC V7)
Description
Defines an SQL Statement to the selected messages displayed in the message window. Write/
Read access.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 509
VBS for Creating Procedures and Actions
1.14 VBS Reference
MsgFilterSQL property
MsgFilterSQL
Defines one or several SQL statements for the custom selection of messages. Multiple user-
defined selections are logically linked by "OR" operation. The SQL statements of
"DefaultMsgFilterSQL" and "MsgFilterSQL" are linked logically by "AND" operation if you
define a default selection by means of "DefaultMsgFilterSQL".
The attribute can be assigned dynamic properties by means of the name MsgFilterSQL. The
data type is STRING.
1.14.4.13 N
Name Property
Description of layer and tag object
Returns the object name. STRING (read only)
● In the case of tags, the name of the tag without server and tag prefix
● In the case of layers, the layer name
Tags
The tag "Name" property is used to address the tag via the tag list. The name of a tag can
contain a server prefix. In WinCC, tag names are structured according to the following scheme:
<Serverprefix>::<Variablenprefix><Name der Variable>
If the tag name alone is specified, the server prefix and tag prefix are removed from the context
of the picture.
If the tag is specified with a server prefix in the tag name, the tags and server prefix of the
context are ignored and the server prefix included is used.
WinCC Function Trend Control Description
The "Index" property references a trend. "Name" defines the name of the trend.
Description Project Object
Returns the name of the current Runtime project. STRING (read only)
Example:
The following example returns the name of the current Runtime project as Trace:
'VBS160
HMIRuntime.Trace "Name: " & HMIRuntime.ActiveProject.Name & vbNewLine
WinCC: Scripting (VBS, ANSI-C, VBA)
510 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Description of DataItem Object
Returns the name of the DataItem object.
See also
ActiveProject Property (Page 299)
WinCC Function Trend Control (before WinCC V7) (Page 281)
Tag Object (Page 135)
Ellipse segment (Page 145)
Layer Object (Page 118)
DataItem Object (Page 111)
NeedleColor Property
Description
Defines or returns the color of the pointer. LONG write-read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
NormalColor Property
Description
Defines the color of the normal area of the scale. LONG write-read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
NumberLines Property
Description
Text list
Defines the number of lines the text list object should contain or returns the value. If the amount
of configured text is larger than this value, the selection list receives a vertical scroll bar.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 511
VBS for Creating Procedures and Actions
1.14 VBS Reference
Combo box and list box
Defines the number of lines the combo box and list field object should contain or returns the
value. You can set a maximum of 32 000 lines.
At the same time, the value of the "Number of rows" attribute specifies the high limit for the
"Index" attribute in the "Font" property group. Changing the value can have the following
effects:
● Increasing the number: New lines are added at the bottom. The standard labeling of the
new field can be changed using the "Text" attribute in the "Font" property group.
● Reducing the number: All lines are removed for which the value of the "Index" attribute is
higher than the new number.
See also
Text list (Page 194)
ScreenItem Object (Page 123)
NumItems Property
Description
Returns the number of trends or column pairs (visible and invisible) in the window which have
been configured. Write/Read access.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
1.14.4.14 O
Ob - On
Object Property
Description
If a non-WinCC control is used, it is possible that the properties provided by the control have
the same names as the general ScreenItem properties. In such cases, the ScreenItem
properties have priority. The "hidden" properties of an external control supplier can be
accessed using the additional "object" property.
WinCC: Scripting (VBS, ANSI-C, VBA)
512 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
Address the properties of an external control supplier as follows:
Control.object.type
If the following form alone is used
Control.type
the properties of the ScreenItem object are used in the case of identical names.
See also
Controls (Page 216)
ScreenItem Object (Page 123)
ObjectName Property
Description
Returns the object name.
● In the case of graphic objects, the object name
● In the case of pictures, the picture name
STRING (read only)
Example:
The following example issues the names of all the objects contained in the picture "NewPDL1":
'VBS80
Dim objScreen
Dim lngIndex
Dim lngAnswer
Dim strName
lngIndex = 1
Set objScreen = HMIRuntime.Screens("NewPDL1")
For lngIndex = 1 To objScreen.ScreenItems.Count
strName = objScreen.ScreenItems.Item(lngIndex).ObjectName
lngAnswer = MsgBox("Name of object " & lngIndex & ": " & strName, vbOKCancel)
If vbCancel = lngAnswer Then Exit For
Next
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 513
VBS for Creating Procedures and Actions
1.14 VBS Reference
Pictures
Establish the picture name directly from the "ObjectName" property:
'VBS81
MsgBox "Screenname: " & HMIRuntime.ActiveScreen.ObjectName
See also
Screen Object (Page 129)
ScreenItem Object (Page 123)
ObjectSizeDeclutteringEnable Property
Description
Returns the ObjectSizeDecluttering properties of a picture.
Upon activated ObjectSizeDecluttering, only objects within a set size range are displayed.
You specify the upper and lower limits for the display range in Graphics Designer under "Tools>
Settings > Show/Hide".
BOOLEAN Read-only access.
Example:
The example outputs the Decluttering Properties of the picture NewPDL1 as a trace.
'VBS157
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
HMIRuntime.Trace "Min: " & objScreen.ObjectSizeDeclutteringMin & vbNewLine
HMIRuntime.Trace "Max: " & objScreen.ObjectSizeDeclutteringMax & vbNewLine
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine
See also
Screen Object (Page 129)
ObjectSizeDeclutteringMax Property
Description
Using the ObjectSizeDeclutteringMax property, the upper size range of a picture may be read.
Objects which are larger than the stated pixel size are no longer displayed when
ObjectSizeDecluttering is activated.
WinCC: Scripting (VBS, ANSI-C, VBA)
514 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
LONG read-only access.
Example:
The example outputs the Decluttering Properties of the picture NewPDL1 as a trace.
'VBS157
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
HMIRuntime.Trace "Min: " & objScreen.ObjectSizeDeclutteringMin & vbNewLine
HMIRuntime.Trace "Max: " & objScreen.ObjectSizeDeclutteringMax & vbNewLine
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine
See also
Screen Object (Page 129)
ObjectSizeDeclutteringMin Property
Description
Using the ObjectSizeDeclutteringMin property, the lower size range of a picture may be read.
Objects which are smaller than the stated pixel size are no longer displayed when
ObjectSizeDecluttering is activated.
LONG read-only access.
Example:
The example outputs the Decluttering Properties of the picture NewPDL1 as a trace.
'VBS157
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
HMIRuntime.Trace "Min: " & objScreen.ObjectSizeDeclutteringMin & vbNewLine
HMIRuntime.Trace "Max: " & objScreen.ObjectSizeDeclutteringMax & vbNewLine
HMIRuntime.Trace "Enable: " & objScreen.LayerDeclutteringEnable & vbNewLine
See also
Screen Object (Page 129)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 515
VBS for Creating Procedures and Actions
1.14 VBS Reference
OffsetLeft Property
Description
Defines or returns the distance of the picture from the left edge of the picture window.
The picture is displayed as a cutout of the picture window. The picture scroll bars are located
at the left and upper edge of the picture. If you wish to display the picture in the picture window
by using the horizontal and vertical positioning of the picture scroll bars, use the properties
"ScrollPositionX" and "ScrollPositionY" for such positioning.
See also
ScrollPositionY Property (Page 563)
ScrollPositionX Property (Page 562)
Picture Window (Page 177)
ScreenItem Object (Page 123)
OffsetTop Property
Description
Defines or returns the distance of the picture from the top edge of the picture window.
The picture is displayed as a cutout of the picture window. The picture scroll bars are located
at the left and upper edge of the picture. If you wish to display the picture in the picture window
by using the horizontal and vertical positioning of the picture scroll bars, use the properties
"ScrollPositionX" and "ScrollPositionY" for such positioning.
See also
ScrollPositionY Property (Page 563)
ScrollPositionX Property (Page 562)
Picture Window (Page 177)
ScreenItem Object (Page 123)
OneY Property
Description
TRUE if only the Y-axis of the trend is displayed in the foreground instead of all Y-axes of the
displayed trends. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
516 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Online property (before WinCC V7)
Description
Serves to start or stop updating.
● 0: The updated display is stopped. The values are buffered and updated when the button
is clicked again.
● -1: The updated display is resumed.
See also
ScreenItem Object (Page 123)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
Online property
Starting refresh - Online
Enables a refresh of displayed values when calling a picture in Runtime.
Value Description
TRUE Enables the refresh of values on picture calls.
FALSE Disables the refresh of values on picture calls.
The attribute can be assigned dynamic properties by means of the name Online. The data
type is BOOLEAN.
OnTop Property
Description
TRUE, when the object should remain in the foreground in Runtime. Read only access.
See also
Picture Window (Page 177)
Application Window (Page 171)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 517
VBS for Creating Procedures and Actions
1.14 VBS Reference
Op
OperationMessage Property
Description
TRUE, if a message should be output upon successful operation. BOOLEAN Schreib-Lese-
Zugriff.
The operation is sent to the message system, and is archived. Using the message system, a
message may be output in a message line, for example.
Special features of I/O field, text list and slider
The reason for the operation may only be entered if the "OperationReport" property has been
set to TRUE.
See also
Slider (Page 210)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
I/O Field (Page 182)
ScreenItem Object (Page 123)
OperatorMessageID property
OperatorMessageID
Default assignment of the ID number and trigger event in WinCC OnlineTableControl:
Value Description Explanation
5 EditValue Trigger event "Change archive value"
6 InsertValue Trigger event "Generate archive value"
The attribute can be assigned dynamic properties by means of the name
OperatorMessageID. The data type is LONG.
OperatorMessageIndex property
OperatorMessageIndex
References the event of an archive value change for an operator message. Using this attribute
you can assign the values of other attributes to a specific operator message.
WinCC: Scripting (VBS, ANSI-C, VBA)
518 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The following values are available:
Value Explanation
0 Trigger event "Change archive value"
1 Trigger event "Generate archive value"
The attribute can be assigned dynamic properties by means of the name
OperatorMessageIndex. The data type is LONG.
OperatorMessageName property
Object name - OperatorMessageName
Displays the name that is referenced with the attribute "OperatorMessageIndex" for message
events for operator messages. You cannot edit this name.
The following names are available for message events:
Value Explanation
Lock Message event "Lock"
Unlock Message event "Enable"
Hide Message event "Hide"
Unhide Message event "Unhide"
Quit Message event "Ackn."
The attribute can be assigned dynamic properties by means of the name
OperatorMessageName . The data type is STRING.
OperatorMessageNumber property
Message number - OperatorMessageNumber
Define a message number for the selected operator message event if you do not want to use
the operator message of WinCC.
The attribute can be assigned dynamic properties by means of the name
OperatorMessageNumber. The data type is LONG.
OperatorMessageSelected property
Operator messages for - OperatorMessageSelected
Activate the message events which trigger operator messages in the list.
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSelected. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 519
VBS for Creating Procedures and Actions
1.14 VBS Reference
OperatorMessageSource1 property
Source - OperatorMessageSource1
Define the message block of an operated message to be added to "Process value block 1" of
the operator message configured in Source.
An operator message is to be generated to indicate that a message was locked. The contents
of "User text block 1" of the locked message, e.g. "Motor faulty", is to be displayed in "Process
value block 1" of the operator message. Select "1" at process value as the message lock of
the operated message "User text block 1".
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSource1. The data type is STRING.
OperatorMessageSource2 property
Source - OperatorMessageSource2
Define the message block of an operated message to be added to "Process value block 2" of
the operator message configured in Source.
An operator message is to be generated to indicate that a message was locked. The contents
of "User text block 1" of the locked message, e.g. "Motor faulty", is to be displayed in "Process
value block 2" of the operator message. Select "2" at process value as the message lock of
the operated message "User text block 1".
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSource2. The data type is STRING.
OperatorMessageSource3 property
Source - OperatorMessageSource3
Define the message block of an operated message to be added to "Process value block 3" of
the operator message configured in Source.
An operator message is to be generated to indicate that a message was locked. The contents
of "User text block 1" of the locked message, e.g. "Motor faulty", is to be displayed in "Process
value block 3" of the operator message. Select "3" at process value as the message lock of
the operated message "User text block 1".
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSource3. The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
520 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
OperatorMessageSource4 property
Source - OperatorMessageSource4
Define the message block of an operated message to be added to "Process value block 4" of
the operator message configured in Source.
An operator message is to be generated to indicate that a message was locked. The contents
of "User text block 1" of the locked message, e.g. "Motor faulty", is to be displayed in "Process
value block 4" of the operator message. Select "4" at process value as the message lock of
the operated message "User text block 1".
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSource4. The data type is STRING.
OperatorMessageSource5 property
Source - OperatorMessageSource5
Define the message block of an operated message to be added to "Process value block 5" of
the operator message configured in Source.
An operator message is to be generated to indicate that a message was locked. The contents
of "User text block 1" of the locked message, e.g. "Motor faulty", is to be displayed in "Process
value block 5" of the operator message. Select "5" at process value as the message lock of
the operated message "User text block 1".
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSource5. The data type is STRING.
OperatorMessageSource6 property
Source - OperatorMessageSource6
Define the message block of an operated message to be added to "Process value block 6" of
the operator message configured in Source.
An operator message is to be generated to indicate that a message was locked. The contents
of "User text block 1" of the locked message, e.g. "Motor faulty", is to be displayed in "Process
value block 6" of the operator message. Select "6" at process value as the message lock of
the operated message "User text block 1".
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSource6. The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 521
VBS for Creating Procedures and Actions
1.14 VBS Reference
OperatorMessageSource7 property
Source - OperatorMessageSource7
Define the message block of an operated message to be added to "Process value block 7" of
the operator message configured in Source.
An operator message is to be generated to indicate that a message was locked. The contents
of "User text block 1" of the locked message, e.g. "Motor faulty", is to be displayed in "Process
value block 7" of the operator message. Select "7" at process value as the message lock of
the operated message "User text block 1".
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSource7. The data type is STRING.
OperatorMessageSource8 property
Source - OperatorMessageSource8
Define the message block of an operated message to be added to "Process value block 8" of
the operator message configured in Source.
An operator message is to be generated to indicate that a message was locked. The contents
of "User text block 1" of the locked message, e.g. "Motor faulty", is to be displayed in "Process
value block 8" of the operator message. Select "8" at process value as the message lock of
the operated message "User text block 1".
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSource8. The data type is STRING.
OperatorMessageSource9 property
Source - OperatorMessageSource9
Define the message block of an operated message to be added to "Process value block 9" of
the operator message configured in Source.
An operator message is to be generated to indicate that a message was locked. The contents
of "User text block 1" of the locked message, e.g. "Motor faulty", is to be displayed in "Process
value block 9" of the operator message. Select "9" at process value as the message lock of
the operated message "User text block 1".
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSource9. The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
522 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
OperatorMessageSource10 property
Source - OperatorMessageSource10
Define the message block of an operated message to be added to "Process value block 10"
of the operator message configured in Source.
An operator message is to be generated to indicate that a message was locked. The contents
of "User text block 1" of the locked message, e.g. "Motor faulty", is to be displayed in "Process
value block 10" of the operator message. Select "10" at process value as the message lock of
the operated message "User text block 1".
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSource10. The data type is STRING.
OperatorMessageSourceType1 property
Transfer as - OperatorMessageSourceType1
Specifies the format of the source content for the transfer.
The following formats are available:
Value Description Explanation
0 Text Transfer the source content in text format.
1 Value Transfer the source content as value.
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSourceType1. The data type is LONG.
OperatorMessageSourceType2 property
Transfer as - OperatorMessageSourceType2
Specifies the format of the source content for the transfer.
The following formats are available:
Value Description Explanation
0 Text Transfer the source content in text format.
1 Value Transfer the source content as value.
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSourceType2. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 523
VBS for Creating Procedures and Actions
1.14 VBS Reference
OperatorMessageSourceType3 property
Transfer as - OperatorMessageSourceType3
Specifies the format of the source content for the transfer.
The following formats are available:
Value Description Explanation
0 Text Transfer the source content in text format.
1 Value Transfer the source content as value.
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSourceType3. The data type is LONG.
OperatorMessageSourceType4 property
Transfer as - OperatorMessageSourceType4
Specifies the format of the source content for the transfer.
The following formats are available:
Value Description Explanation
0 Text Transfer the source content in text format.
1 Value Transfer the source content as value.
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSourceType4. The data type is LONG.
OperatorMessageSourceType5 property
Transfer as - OperatorMessageSourceType5
Specifies the format of the source content for the transfer.
The following formats are available:
Value Description Explanation
0 Text Transfer the source content in text format.
1 Value Transfer the source content as value.
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSourceType5. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
524 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
OperatorMessageSourceType6 property
Transfer as - OperatorMessageSourceType6
Specifies the format of the source content for the transfer.
The following formats are available:
Value Description Explanation
0 Text Transfer the source content in text format.
1 Value Transfer the source content as value.
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSourceType6. The data type is LONG.
OperatorMessageSourceType7 property
Transfer as - OperatorMessageSourceType7
Specifies the format of the source content for the transfer.
The following formats are available:
Value Description Explanation
0 Text Transfer the source content in text format.
1 Value Transfer the source content as value.
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSourceType7. The data type is LONG.
OperatorMessageSourceType8 property
Transfer as - OperatorMessageSourceType8
Specifies the format of the source content for the transfer.
The following formats are available:
Value Description Explanation
0 Text Transfer the source content in text format.
1 Value Transfer the source content as value.
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSourceType8. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 525
VBS for Creating Procedures and Actions
1.14 VBS Reference
OperatorMessageSourceType9 property
Transfer as - OperatorMessageSourceType9
Defines the format for transferring the source.
The following formats are available:
Value Description Explanation
0 Text Transfer the source as text.
1 Value Transfer the source as value.
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSourceType9. The data type is LONG.
OperatorMessageSourceType10 property
Transfer as - OperatorMessageSourceType10
Specifies the format of the source content for the transfer.
The following formats are available:
Value Description Explanation
0 Text Transfer the source content in text format.
1 Value Transfer the source content as value.
The attribute can be assigned dynamic properties by means of the name
OperatorMessageSourceType10. The data type is LONG.
OperationReport Property
Description
TRUE, if the reason for an operation should be recorded. BOOLEAN write/read access.
When the object is used or operated in Runtime, a dialog opens in which the operator can
input the reason for the operation in the form of text. The operation is sent to the message
system, and is archived.
See also
Slider (Page 210)
Text list (Page 194)
I/O Field (Page 182)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
526 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Or - Ou
Orientation Property
Description
TRUE, when the text in the object should be displayed horizontally. BOOLEAN write-read
access.
Description of the "Connector" object type
Modifies the orientation of the connector. BOOLEAN write-read access.
See also
Connector (Page 165)
Static text (Page 163)
Text list (Page 194)
Radio box (Page 205)
Check box (Page 202)
Button (Page 199)
I/O Field (Page 182)
ScreenItem Object (Page 123)
OuterBevelStyle Property
Description
Defines the 3D effect for the outer bevel of the object.
● 0: No border.
● 1: The border is displayed depressed.
● 2: The border is displayed raised.
● 3: The border is displayed in one color without a 3D effect. The border color is defined by
the "BevelColorUp" property.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 527
VBS for Creating Procedures and Actions
1.14 VBS Reference
OuterBevelWidth Property
Description
Defines the width of the outer bevel in pixels.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
Outline Property
Description
TRUE, when the button should be given a black border in addition to the 3D border. BOOLEAN
write-read access.
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
ScreenItem Object (Page 123)
OutputFormat Property
Description
Returns the value for the representation of the output value and sets it. The representation
depends on the data format.
See also
I/O Field (Page 182)
ScreenItem Object (Page 123)
OutputValue Property
Description
Determines the default setting for the value to be displayed or returns it.
This value is used in Runtime when the associated tag cannot be connected or updated when
a picture is started.
WinCC: Scripting (VBS, ANSI-C, VBA)
528 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Text list (Page 194)
I/O Field (Page 182)
ScreenItem Object (Page 123)
1.14.4.15 P
Pa - Pe
PageMode property
Enable paging - PageMode
Enables paging is in the long-term archive list. Allows you to display all messages of the short-
term archive in the long-term archive list. Use the "Messages per page" or
"PageModeMessageNumber" property to determine the number of messages displayed per
page.
The page up/down buttons of the toolbar can be used if paging is enabled.
Value Explanation
TRUE Paging is enabled for the long-term archive list.
FALSE Paging is disabled for the long-term archive list.
The attribute can be assigned dynamic properties by means of the name PageMode. The data
type is BOOLEAN.
PageModeMessageNumber property
Messages per page - PageModeMessageNumber
Defines the number of messages shown per page when paging the long-term archive list.
The attribute can be assigned dynamic properties by means of the name
PageModeMessageNumber. The data type is LONG.
Parent Property
Description
Returns a reference to the superordinate object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 529
VBS for Creating Procedures and Actions
1.14 VBS Reference
Objects within the VBS object model are accessed by hierarchy. You may descend in the
picture hierarchy using Screen and Screenitems. You may ascend in the picture hierarchy by
using the Parent property.
Usage
The Parent property can be used as often as required within an object hierarchy. The following
section provides a systematic description of how to access all the elements in a hierarchy:
The Command
MsgBox MyCircle.Parent.Objectname
returns the name of "Picture2" located one layer higher in the object hierarchy than the original
ScreenItem object "Circle1".
For example, if you wish to use "Parent" three times, ascend in the object hierarchy by three
layers:
MsgBox MyCircle.Parent.Parent.Parent.Objectname
returns the name of Picture1.
WinCC: Scripting (VBS, ANSI-C, VBA)
530 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Reasoning:
● Original reference is to ScreenItem "Circle1"
● "Circle1" is within "Picture2" (Layer 1)
● "Picture2" is within Picture Window2 "BF2" (Layer 2)
● "BF2" is within "Picture 1"(Layer 3)
Example
In the following examples, the object name of the parent object is displayed:
'VBS120
Dim objCircle
Set objCircle = HMIRuntime.Screens("ScreenWindow1").ScreenItems("Circle1")
MsgBox objCircle.Parent.ObjectName
'VBS82
Dim objScrItem
Set objScrItem = HMIRuntime.Screens(1).ScreenItems(1)
MsgBox "Name of BaseScreen: " & objScrItem.Parent.ObjectName
See also
Picture Window (Page 177)
Screen Object (Page 129)
Objects and Lists (Page 105)
PasswordLevel Property
Description
Defines the authorization for operation (e.g. no input or no triggering actions) of the object.
See also
ScreenItem Object (Page 123)
Path Property
Description
Returns the path of the current project (without file name). For a WinCC client without its own
path, the path is returned in UNC format, otherwise the local path is returned.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 531
VBS for Creating Procedures and Actions
1.14 VBS Reference
STRING (read access only)
Example:
The following example returns the project path as Trace:
'VBS161
HMIRuntime.Trace "Path: " & HMIRuntime.ActiveProject.Path & vbNewLine
See also
Project Object (Page 122)
PercentageAxis property
PercentageAxis
Specifies whether an axis with percentage scaling will be displayed in addition to the value
axes in the trend window or diagram window.
Value Explanation
TRUE The display of an axis with percentage scaling is enabled.
FALSE The display of an axis with percentage scaling is disabled.
The attribute can be assigned dynamic properties by means of the name PercentageAxis. The
data type is BOOLEAN.
PercentageAxisAlign property
PercentageAxisAlign
Specifies the alignment of the axis with percentage scaling in the trend window or diagram
window.
The following settings are available:
Value Description Explanation
0 left The axis with percentage scaling is aligned left.
1 right The axis with percentage scaling is aligned right.
The attribute can be assigned dynamic properties by means of the name
PercentageAxisAlign. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
532 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
PercentageAxisColor property
PercentageAxisColor
Specifies the color of an axis with percentage scaling. The button opens the "Color selection"
dialog to select the color.
The attribute can be assigned dynamic properties by means of the name
PercentageAxisColor. The data type is LONG.
PersistentRT Property
Description
TRUE, when modified window settings should be retained following a change of picture.
Whether the information is evaluated is dependent on the value of the "AllowPersistance"
property.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
PersistentRTCS Property
Description
TRUE, when modified settings should be retained following a change of picture and applied
in the configuration system. Whether the information is evaluated is dependent on the value
of the "AllowPersistance" property. BOOLEAN write-read access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 533
VBS for Creating Procedures and Actions
1.14 VBS Reference
PersistentRTCSPermission Property
Description
Defines the operator permission which is necessary in order to modify settings related to
persistence. The value to be entered must correspond to the number of the requested
authorization level in the user administrator. Whether or not the information is to be analyzed
depends on the value of the "AllowPersistence" property (does not apply to WinCC Alarm
Control).
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
PersistentRTPermission Property
Description
Defines the operator permission which is necessary in order to modify settings related to the
persistency in Runtime. The value to be entered must correspond to the number of the
requested authorization level in the user administrator. Whether or not the information is to be
analyzed depends on the value of the "AllowPersistence" property (does not apply to WinCC
Alarm Control).
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
534 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Pi
PicDeactReferenced-Eigenschaft
Description
TRUE, when the picture assigned for the "Disable" status should be saved in the RoundButton
object. Otherwise, only the associated object reference is saved. Read only access.
See also
Round Button (Page 207)
ScreenItem Object (Page 123)
PicDeactTransparent Property
Description
Defines or returns which color of the bitmap object (.bmp, .dib) assigned to the "Disabled"
status should be set to "transparent". LONG Write/Read Access.
The color is only set to "Transparent" if the value of the "PicDeactUseTransColor" property is
"True".
See also
Round Button (Page 207)
ScreenItem Object (Page 123)
PicDeactUseTransColor Property
Description
TRUE, when the transparent color defined by the "PicDeactTransparent" property for the
"Disable" status should be used. BOOLEAN write-read access.
See also
Round Button (Page 207)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 535
VBS for Creating Procedures and Actions
1.14 VBS Reference
PicDownReferenced Property
Description
TRUE, when the picture assigned for the "On" status is to be saved. Otherwise, only the
associated object reference is saved. Read only access.
See also
Round Button (Page 207)
ScreenItem Object (Page 123)
PicDownTransparent Property
Description
Defines or returns which color of the bitmap object (.bmp, .dib) assigned to the "On" status
should be set to "transparent". LONG Write/Read Access.
The color is only set to "Transparent" if the value of the "PicDownUseTransColor" property is
"True".
See also
Round Button (Page 207)
ScreenItem Object (Page 123)
PicDownUseTransColor Property
Description
TRUE, when the transparent color defined by the "PicDownTransparent" property for the "On"
status should be used. BOOLEAN write-read access.
See also
Round Button (Page 207)
ScreenItem Object (Page 123)
PicReferenced Property
Description
TRUE, when the assigned picture is references the object and is not saved in it. Read only
access.
WinCC: Scripting (VBS, ANSI-C, VBA)
536 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Graphic Object (Page 185)
ScreenItem Object (Page 123)
PictAlignment property
Description
Defines or returns the picture alignment of the picture on the button or round button.
LONG write-read access.
PicTransColor Property
Description
Defines or returns which color of the assigned bitmap object (.bmp, .dib) should be set to
"transparent". LONG Write/Read Access.
The color is only set to "Transparent" if the value of the "PicUseTransColor" property is "True".
See also
Graphic Object (Page 185)
ScreenItem Object (Page 123)
Picture Property
Description
Returns the picture name of the background picture for the rectangular background for both
the analog and digital clocks. Read only access
See also
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
PictureBack Property
Description
Returns the picture name of the picture for the object background. Read only access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 537
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
PictureDeactivated Property
Description
Defines the picture to be displayed in the "Disable" status or returns the picture name.
The picture (*.BMP or *.DIB) must be located in the "GraCS" directory of the current project
so that it can be integrated.
See also
Round Button (Page 207)
ScreenItem Object (Page 123)
PictureDirectory property
Directory for pictures (PictureDirectory)
Specifies the name of the subdirectory that is created in the "GraCS" directory of the WinCC
project. If pictures are stored in the subdirectory, they are available for the extended status
display. If no subdirectory is specified or the subdirectory does not contain any pictures, the
pictures in the "GraCS" directory are taken into consideration.
The "Directory for pictures" attribute can be dynamized with the name "PictureDirectory".
PictureDown Property
Description
Defines the picture to be displayed in the "On" status or returns the picture name.
The picture (*.BMP or *.DIB) must be located in the "GraCS" directory of the current project
so that it can be integrated.
See also
Button (Page 199)
Round Button (Page 207)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
538 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
PictureName Property
Description
Defines the picture to be displayed in the graphic object in Runtime or returns the picture name.
The picture (*.BMP or *.DIB) must be located in the "GraCS" directory of the current project
so that it can be integrated.
See also
Graphic Object (Page 185)
ScreenItem Object (Page 123)
PictureSelected Property
Description
Returns the picture name of the picture displayed in the "On" status. "AutoSize" controls the
adaptation of the size of picture and buttons. Read only access.
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
ScreenItem Object (Page 123)
PictureSizeMode property
PictureSizeMode
Specifies the size adjustment between picture and control.
Value Designation Explanation
0 Fit size to content The control is adapted to the picture size.
1 Fit content to size The picture is adapted or scaled to the control.
The attribute can be assigned dynamic properties by means of the name PictureSizeMode.
The data type is LONG.
PictureThumb Property
Description
Returns the picture name of the background picture for the slider. Read only access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 539
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
PictureUnselected Property
Description
Returns the picture name of the picture displayed in the "Off" status. "AutoSize" controls the
adaptation of the size of picture and buttons. Read only access.
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
ScreenItem Object (Page 123)
PictureUp Property
Description
Defines the picture to be displayed in the "Off" status or returns the picture name.
The picture (*.BMP or *.DIB) must be located in the "GraCS" directory of the current project
so that it can be integrated.
See also
Round Button (Page 207)
Button (Page 199)
ScreenItem Object (Page 123)
PicUpReferenced Property
Description
TRUE, when the picture assigned for the "Off" status should be saved in the object. Otherwise,
only the associated object reference is saved. Read only access.
See also
Round Button (Page 207)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
540 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
PicUpTransparent Property
Description
Defines or returns which color of the bitmap object (.bmp, .dib) assigned to the "Off" status
should be set to "transparent". LONG Write/Read Access.
The color is only set to "Transparent" if the value of the "PicUpUseTransColor" property is
"True".
See also
Round Button (Page 207)
ScreenItem Object (Page 123)
PicUpUseTransColor Property
Description
TRUE, when the transparent color defined by the "PicUpTransparent" property for "Off" status
should be used. BOOLEAN write-read access.
See also
Round Button (Page 207)
ScreenItem Object (Page 123)
PicUseTransColor Property
Description
TRUE, when the transparent color defined by the "PicDeactTransparent" property for the
"Disable" status should be used. BOOLEAN write-read access.
See also
Graphic Object (Page 185)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 541
VBS for Creating Procedures and Actions
1.14 VBS Reference
Pl - Pr
PlayEndless property
PlayEndless
Specifies if movies are played endlessly in the control.
The attribute can be assigned dynamic properties by means of the name PlayEndless. The
data type is BOOLEAN.
PointCount Property
Description
Defines or returns the number of corner points. Each corner point has position coordinates
and is identified via an index.
See also
Polyline (Page 156)
Polygon (Page 154)
ScreenItem Object (Page 123)
Position Property
Description
Defines the presetting for the position of the slider.
This value is used as the start value in Runtime.
To operate the process value linked to this attribute, it is necessary that the process value is
also linked to the "Position" event. You will find the event "Position" in the "Event" tab, in the
topic tree under SliderCtrl\Property Topics\Control Properties\Value.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
542 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Precisions Property
Description
WinCC Online Trend Control
The "Index" property references a pair of columns. "Precision" defines the number of decimal
places which should be shown in this value column. A maximum of 16 decimal places can be
displayed.
WinCC Online Trend Control
Defines the number of decimal places with which the scale value is specified.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
PrecisionX Property
Description
Defines or returns the number of decimal places with which the scale value for the X-axis
should be specified. Write/Read access.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
PrecisionY Property
Description
Defines or returns the number of decimal places with which the scale value for the Y-axis
should be specified. Write/Read access.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 543
VBS for Creating Procedures and Actions
1.14 VBS Reference
PredefinedAngles Property
Description
Defines or returns the depth of the display of the 3DBarGraph object. Value range from 0 to 3.
0 = cavalier
1 = isometric
2 = axionometric
3 = freely defined
See also
ScreenItem Object (Page 123)
3D Bar (Page 167)
PreferredTarget property
Preferred picture target (PreferredTarget)
The "Preferred picture target" attribute specifies where the picture change is carried out by the
Favorites browser.
Yes The picture change is carried out in this picture screen. In the case of nested picture screens the picture change
is carried out at the innermost picture screen with the "Yes" setting.
No The picture change is carried out in the main screen.
The "Preferred picture target" attribute can be made dynamic with the name "PreferredTarget".
Pressed Property
Description
TRUE, when the Button or RoundButton object is pressed. BOOLEAN write-read access.
See also
Round Button (Page 207)
ScreenItem Object (Page 123)
PrintBackgroundColor Property
Description
TRUE, if the defined background color is also printed while printing the controls. BOOLEAN
write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
544 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
PrintJob Property
Description
Defines or reads out which print layout should be used for the printed output.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
PrintJobName property
Current print job view - PrintJobName
Defines the print job triggered by the print function of the "Print" toolbar button. The
recommended print job is set for the control by default.
Open the "Select Print Job" dialog using the selection button.
The attribute can be assigned dynamic properties by means of the name PrintJobName. The
data type is STRING.
Process Property
Description
Defines or returns presetting for the value to be displayed.
This value is used in Runtime when the associated tag cannot be connected or updated when
a picture is started.
See also
Slider (Page 210)
Radio box (Page 205)
Check box (Page 202)
Bar (Page 172)
3D Bar (Page 167)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 545
VBS for Creating Procedures and Actions
1.14 VBS Reference
ProcessValue property
Description
Returns an object of type "ProcessValue".
See also
Alarms object (list) (Page 108)
ProjectPath Property
Description
Contains the path and name of the associated project.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
ProviderClsid Property
Description
The "Index" property references a trend. "ProviderClsid" defines whether an archive tag or an
internal or external tag should be displayed in this trend.
● {416A09D2-8B5A-11D2-8B81-006097A45D48}: The trend is connected to an archive tag.
● {A3F69593-8AB0-11D2-A440-00A0C9DBB64E}: The trend is connected to an internal or
external tag.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
ProviderType Property
Description
Defines the type of values to be displayed in a trend referenced by "Index". In the case of
modification of "ProviderType", impermissible combinations with other attributes for data
connection could be created. Therefore, before modifying "ProviderType", the immediate
acceptance of the changes must be prevented using "FreezeProviderConnections".
WinCC: Scripting (VBS, ANSI-C, VBA)
546 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
0: Values are supplied via the API interface.
-1: Display of online or archive tags
-2: Displaying values from a user archive
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
1.14.4.16 Q
QualityCode Property
Description
Defines a standard for the quality of a tag value after being read. The quality code is provided
as a 16-bit value for automatic evaluation. After a tag has been written, the value is invalid.
SHORT (read only)
Note
A summary of possible Quality Codes is provided in the WinCC Information System under the
heading "Communication" > "Diagnostics" or "Communication" > "Quality Codes".
Example:
The following example indicates the quality of the read value when no errors have occurred
during the reading process:
'VBS83
Dim objTag
Dim lngLastErr
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read
lngLastErr = objTag.LastError
If 0 = lngLastErr Then
MsgBox objTag.QualityCode
End If
See also
LastError Property (Page 459)
ErrorDescription Property (Page 411)
Tag Object (Page 135)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 547
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.4.17 R
Ra - Ri
Radius Property
Description
Defines or returns the radius in pixels.
See also
Pie segment (Page 150)
Circular arc (Page 149)
Circle (Page 147)
Round Button (Page 207)
ScreenItem Object (Page 123)
RadiusHeight Property
Description
Defines or returns the vertical radius in pixels (0 to 5000).
See also
Ellipse segment (Page 145)
Ellipse arc (Page 144)
Ellipse (Page 142)
ScreenItem Object (Page 123)
RadiusWidth Property
Description
Defines or returns the horizontal radius in pixels (0 to 5000).
See also
Ellipse segment (Page 145)
Ellipse arc (Page 144)
WinCC: Scripting (VBS, ANSI-C, VBA)
548 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Ellipse (Page 142)
ScreenItem Object (Page 123)
RangeMax Property
Description
Defines the maximum absolute value for the value display.
If the "WithLabels" property has the value -1 (yes), this value is displayed on the scale.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
RangeMin Property
Description
Defines the minimum absolute value for the value display.
If the "WithLabels" property has the value -1 (yes), this value is displayed on the scale.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
Rectangular Property
Description
Defines or returns the side ratio of the rectangular background of the gauge. BOOLEAN write-
read access.
FALSE : The size of the gauge can be adjusted to any side ratio by dragging the marking points
with the mouse.
TRUE : The size of the gauge can only be adjusted by dragging the marking points with the
mouse. The side ratio of the background always remains 1:1.
See also
ScreenItem Object (Page 123)
WinCC Gauge Control (Page 251)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 549
VBS for Creating Procedures and Actions
1.14 VBS Reference
ReferenceRotationLeft Property
Description
Defines or returns the X-coordinate of the reference point about which the object should be
rotated in Runtime.
The value of the x coordinate is relative to the object width. Enter the value in percent starting
from the left edge of the rectangle enclosing the object.
See also
Line (Page 152)
Polyline (Page 156)
Polygon (Page 154)
ScreenItem Object (Page 123)
ReferenceRotationTop Property
Description
Defines or returns the Y-coordinate of the reference point about which the object should be
rotated in Runtime.
The value of the Y-coordinate is relative to the object height. Enter the value in percent starting
from the top edge of the rectangle enclosing the object.
See also
ScreenItem Object (Page 123)
Line (Page 152)
Polyline (Page 156)
Polygon (Page 154)
RelayCurves Property
Description
TRUE, when the trends should be displayed staggered. BOOLEAN write-read access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
550 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Relevant Property
Description
TRUE, when the object will be taken into account when forming the group display. BOOLEAN
write-read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
Replacement Property
Description
The "Index" property references a trend. Values, whose start value is unknown on activating
Runtime or for which a substitute value is used, have an unstable status. "Replacement"
defines whether such values should be identified by the color defined in "ReplacementColor".
BOOLEAN write-read access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
ReplacementColor Property
Description
The "Index" property references a trend. Values, whose start value is unknown on activating
Runtime or for which a substitute value is used, have an unstable status. "ReplacementColor"
defines the color used to identify this value. The color is defined as an RGB value. Whether
the information is evaluated is dependent on the value of the "Replacement" property.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 551
VBS for Creating Procedures and Actions
1.14 VBS Reference
RestrictedCursorMovement property
Limited cursor movement (RestrictedCursorMovement)
The "Limited cursor movement" attribute specifies whether the cursor is fixed on the left-hand
side in the I/O field. This corresponds to the default setting when opening the I/O field. As a
result, negative values are always displayed correctly You enter the values with decimal places
regardless of the cursor position. You no longer have any possibility to change the position
during the entry. The decimal place shown in the I/O field is hidden during the entry of a decimal
place.
Yes The cursor movement is restricted in the I/O field. The cursor is fixed on the left-hand side.
No The cursor movement is not restricted in the I/O field.
The "Limited cursor movement" attribute can be made dynamic with the
"RestrictedCursorMovement" name.
RightComma Property
Description
Defines or returns the number of decimal places (0 to 20).
See also
Bar (Page 172)
ScreenItem Object (Page 123)
Ro - Ru
Rotation property
Rotation (Rotation)
Specifies anticlockwise rotation around the icon center.
The following settings are available:
Value Comments
0 The icon is not rotated.
90 The icon is rotated by 90 degrees.
180 The icon is rotated by 180 degrees.
270 The icon is rotated by 270 degrees.
The attribute can be assigned dynamic properties by means of the name Rotation. The data
type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
552 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
RotationAngle Property
Description
Standard objects
Defines or returns the rotation angle in degrees.
In Runtime, the object (starting from the configured starting position) is displayed rotated
clockwise around the reference point by the specified value. The changed orientation of the
object is only visible in Runtime.
The coordinates of the reference point are defined with the "Rotation Reference X" and
"Rotation Reference Y" attributes.
T-piece
Defines or returns the orientation of a T-piece in degrees.
The attribute can assume one of four values. If you enter another value, it is automatically
converted to modulus 360 and rounded up or down to the closest permissible value.
The orientation is produced by rotating the T-piece clockwise around the center point by the
specified number of degrees.
0 The standard position of the T-piece is the shape of the letter "T"
90 The "leg" of the "T" points towards the left
180 The "leg" of the "T" points upwards
270 The "leg" of the "T" points to the right
See also
Line (Page 152)
Polyline (Page 156)
Polygon (Page 154)
ScreenItem Object (Page 123)
RoundCornerHeight Property
Description
Defines or returns the corner radius.
Enter the value as a percentage of half the height of the object.
See also
Rounded rectangle (Page 160)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 553
VBS for Creating Procedures and Actions
1.14 VBS Reference
RoundCornerWidth Property
Description
Defines or returns the corner radius.
Enter the value as a percentage of half the width of the object.
See also
ScreenItem Object (Page 123)
RowNumber property
RowNumber
Specifies the row number of the Row object of a Table Control.
RowScrollbar property
Row scroll bars - RowScrollbar
Enables the display of row scroll bars.
The following settings are available:
Value Description Explanation
0 No No row scroll bars.
1 as required Row scroll bars are displayed if horizontal space requirements of the control are greater
than the actually available display area.
2 always Row scroll bars are always displayed.
The attribute can be assigned dynamic properties by means of the name RowScrollbar. The
data type is LONG.
RowTitleAlign property
Row label alignment - RowTitleAlign
Specifies the type of row label alignment.
The following settings are available:
Value Description Explanation
0 left The row headers are aligned left.
1 centered The row headers are aligned to center.
2 right The row headers are aligned right.
WinCC: Scripting (VBS, ANSI-C, VBA)
554 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name RowTitleAlign. The
data type is LONG.
RowTitles property
Show row labels - RowTitles
Enables the display of row labels.
Value Explanation
TRUE The row labels are displayed.
FALSE The row labels are not displayed.
The attribute can be assigned dynamic properties by means of the name RowTitles. The data
type is BOOLEAN.
RTPersistence property
Online configuration at the next picture change - RTPersistence
Enables retention of the online configurations of the control after a picture change.
The following settings are available:
Value Description Explanation
0 Discard The current online configurations are discarded at the next picture change.
1 Retain The current online configurations are retained at the next picture change.
2 Reset All online configurations made are lost. The picture is set to the contents
found in the configuration system.
The attribute can be assigned dynamic properties by means of the name RTPersistence. The
data type is LONG.
RTPersistencePasswordLevel property
Operator authorization for online configuration - RTPersistencePasswordLevel
Displays the authorization for online configuration. You can edit the authorization using the
selection button. Authorizations are configured in the "User Administrator" editor.
The attribute can be assigned dynamic properties by means of the name
RTPersistencePasswordLevel . The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 555
VBS for Creating Procedures and Actions
1.14 VBS Reference
RTPersistenceType property
Online configuration - RTPersistenceType
Defines how to retain online configurations of WinCC.
The following settings are available:
Value Description Explanation
0 Do not retain Online configurations are not retained. These are lost at
the next picture change.
1 Retain during runtime Online configurations are retained during runtime. These
are lost on exiting.
2 Retain permanently Online configurations are retained permanently. These
are also available after restart.
The attribute cannot be dynamized.
RulerFont Property
Description
This attribute defines the font of the table of the tag values, which is displayed by the key
function "Display value at this position" / "Ruler". Write/Read access.
RulerPrecisions Property
Description
Defines the number of decimal places to which a measured value should be displayed when
it is determined using the "Display value at this position" function.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
RulerPrecisionX Property
Description
Defines the number of decimal places used by the "Display value at this position" to display
the X-coordinate of a measured value. Whether the information is evaluated is dependent on
the value of the "TimeAxisX" attribute.
WinCC: Scripting (VBS, ANSI-C, VBA)
556 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
RulerPrecisionY Property
Description
Defines the number of decimal places used by the "Display value at this position" to display
the Y-coordinate of a measured value.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
RulerType property
Window - RulerType
Specifies window to be displayed during runtime. Depending on the window type, only certain
blocks can be used as columns of the WinCC RulerControl.
The following window types can be selected:
Value Description Explanation
0 "Ruler" window The ruler window shows the coordinate values of the trends on a
ruler or values of a selected row in the table.
1 "Statistics area" window The statistics area window shows the values of the low and high
limit of trends between two rulers, or displays the selected range
in the table.
2 "Statistics" window The statistics window shows the statistic evaluation of trends be‐
tween two rulers, or it displays the selected values in the table.
The attribute can be assigned dynamic properties by means of the name RulerType. The data
type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 557
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.4.18 S
Sa - Sc
SameSize Property
Description
TRUE, when all four buttons of a Group Display object have the same size. BOOLEAN write-
read access.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
SavedTrend Property
Description
Displays the name of the last saved trend that was exported in WinCC Online Trend Control
using the Save Report button. Read only access.
ScaleColor Property
Description
Defines or returns the color of the scale. LONG write-read access.
The "Scaling" property must be set to TRUE for the color to be displayed.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
ScaleTicks Property
Description
Defines the number of segments into which the bar will be subdivided by large tick marks of
the scale:
0-100: Object can be divided into a maximum of 100 segments
= 0: The optimum number of segments is set automatically.
WinCC: Scripting (VBS, ANSI-C, VBA)
558 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Bar (Page 172)
ScreenItem Object (Page 123)
Scaling Property
Description
TRUE, when a scale should also be used to represent a value. BOOLEAN write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
ScalingType Property
Description of Bar Scaling
Defines or returns the type of bar scaling. Value range from 0 to 6.
0 = linear
1 = logarithmic
2 = negative logarithmic
3 = automatic (linear)
4 = tangent
5 = square
6 = cubic
The "Scaling" property must be set to TRUE for the color to be displayed.
Description of Online Trend Control
Specifies or returns the type of scaling for a trend referenced by "Index". Value range from 0
to 2.
0 = linear
1 = logarithmic
2 = negative logarithmic
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 559
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
Bar (Page 172)
ScreenItem Object (Page 123)
ScalingTypeX Property
Description
Defines the type of scaling of the X-axis of a trend referenced with "Index". Whether the
information is evaluated is dependent on the value of the "TimeAxisX" attribute.
0: Linear
-1: Logarithmically. This setting prevents the display of negative values.
-2: Logarithmically negated. This setting prevents the display of positive values.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
ScalingTypeY Property
Description
Defines the type of scaling of the Y-axis of a trend referenced with "Index".
0: Linear
-1: Logarithmically. This setting prevents the display of negative values.
-2: Logarithmically negated. This setting prevents the display of positive values.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
560 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ScreenName Property
Description
Defines the picture to be displayed in the picture window in Runtime or returns the picture
name.
Note
Always enter picture names without the extension "PDL" for reasons of compatibility with future
versions.
See also
Picture Window (Page 177)
ScreenItem Object (Page 123)
Screens Property
Description
Returns an object of type "Screens".
Screens (read only)
Example:
The following example accesses the picture "NewPDL1":
'VBS84
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
See also
Screens Object (List) (Page 132)
Screen Object (Page 129)
HMIRuntime Object (Page 116)
ScreenItems Property
Description
Returns an object of type "ScreenItems".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 561
VBS for Creating Procedures and Actions
1.14 VBS Reference
ScreenItems (read only)
Example:
The following example issues the number of all the objects contained in the picture "NewPDL1":
'VBS85
Dim objScreen
Set objScreen = HMIRuntime.Screens("NewPDL1")
Msgbox objScreen.ScreenItems.Count
See also
ScreenItems Object (List) (Page 127)
HMIRuntime Object (Page 116)
ScrollBars Property
Description
TRUE, when the object is equipped with a scroll bar in Runtime. Read only access.
See also
Picture Window (Page 177)
ScreenItem Object (Page 123)
ScrollPositionX Property
Description
Specifies the horizontal positioning of the scroll bar in a picture window with slider, or returns
its value.
The picture is displayed in the picture window by positioning the horizontal and vertical scroll
bars. If you wish to display the picture as a cutout where the scroll bars are located at the left
and upper edge of the picture, use the properties "OffsetLeft" and "OffsetTop" as the origin of
this cutout.
See also
ScreenItem Object (Page 123)
OffsetTop Property (Page 516)
WinCC: Scripting (VBS, ANSI-C, VBA)
562 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
OffsetLeft Property (Page 516)
Picture Window (Page 177)
ScrollPositionY Property
Description
Specifies the vertical positioning of the scroll bar in a picture window with slider, or returns its
value.
The picture is displayed in the picture window by positioning the horizontal and vertical scroll
bars. If you wish to display the picture as a cutout where the scroll bars are located at the left
and upper edge of the picture, use the properties "OffsetLeft" and "OffsetTop" as the origin of
this cutout.
See also
OffsetTop Property (Page 516)
OffsetLeft Property (Page 516)
Picture Window (Page 177)
ScreenItem Object (Page 123)
Se
SecondNeedleHeight Property
Description
Defines or returns the length of the second hand for the analog clock. The specification of the
length is entered as a percentage value in relation to half the length of the short side of the
rectangular background. Write/Read access.
Example:
The shorter side of the rectangular background is 100 pixels long.
The second hand length is 80.
This results in a length of the second hand of (100 pixels / 2) * 0.8 = 40 pixels.
See also
ScreenItem Object (Page 123)
WinCC Digital/Analog Clock (Page 244)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 563
VBS for Creating Procedures and Actions
1.14 VBS Reference
SecondNeedleWidth Property
Description
Defines or returns the width of the second hand for the analog clock. The width is specified as
a percentage value related to double the length of the second hand. Write/Read access.
Example:
The length of the second hand is 40 pixels.
The second hand width is 2.
This results in a width of the second hand of 40 pixels * 2 * 0.02 = 2 pixels.
See also
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
SelBGColor Property
Description
Defines or returns the background color of the selected entry in a text list object. LONG write-
read access.
See also
Text list (Page 194)
ScreenItem Object (Page 123)
SelectArchiveName property
SelectArchiveName
Opens the dialog for selecting the user archive.
Programmers can set this attribute to allow users to select a user archive by means of a button,
for example.
The attribute can be assigned dynamic properties by means of the name
SelectArchiveName. The data type is BOOLEAN.
SelectedCellColor property
Background color of selected cell - SelectedCellColor
Specifies the background color of a selected cell. The button opens the "Color selection" dialog.
WinCC: Scripting (VBS, ANSI-C, VBA)
564 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name SelectedCellColor.
The data type is LONG.
SelectedCellForeColor property
Font color of the selected cell - SelectedCellForeColor
Specifies the font color of the selected cell. The button opens the "Color selection" dialog.
The attribute can be assigned dynamic properties by means of the name
SelectedCellForeColor. The data type is LONG.
SelectedRowColor property
Background color of the selected row - SelectedRowColor
Specifies the background color of the selected line. The button opens the "Color selection"
dialog.
The attribute can be assigned dynamic properties by means of the name SelectedRowColor.
The data type is LONG.
SelectedRowForeColor property
Font color of the selected row - SelectedRowForeColor
Specifies the font color of the selected row. The button opens the "Color selection" dialog.
The attribute can be assigned dynamic properties by means of the name
SelectedRowForeColor. The data type is LONG.
SelectedTitleColor property
Background selection color - SelectedTitleColor
Specifies the background color of a selected table header. The button opens the "Color
selection" dialog.
The setting is only active in Runtime if the "Selection color" or "UseSelectedTitleColor" option
is activated.
The attribute can be assigned dynamic properties by means of the name SelectedTitleColor.
The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 565
VBS for Creating Procedures and Actions
1.14 VBS Reference
SelectedTitleForeColor property
Font selection color - SelectedTitleForeColor
Specifies the font color of the table header selected. The button opens the "Color selection"
dialog.
The setting is only active in Runtime if the "Selection color" or "UseSelectedTitleColor" option
is activated.
The attribute can be assigned dynamic properties by means of the name
SelectedTitleForeColor. The data type is LONG.
SelectedTrend Property
Description
This property brings a trend to the foreground via its name. Write/Read access.
SelectionColoring property
Selection colors for - SelectionColoring
Enables the use of selection colors for cells or rows.
The following settings are available:
Value Description Explanation
0 None No selection colors for cells and rows.
1 Cell Selection color for cell.
2 Row Selection color for row.
3 Cell and row Selection colors for cell and row.
The attribute can be assigned dynamic properties by means of the name SelectionColoring.
The data type is LONG.
SelectionMode Property
Description
Defines whether and how a message line can be selected.
● 0 - NoSelection: Prevents the selection of a message. Acknowledgement affects the oldest
pending message.
● 1 - Cell: Enables the selection of fields in the message line. Acknowledgement affects the
selected message.
● 2 - Line: Enables the selection of a message line. Acknowledgement affects the selected
message.
WinCC: Scripting (VBS, ANSI-C, VBA)
566 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
SelectionRect property
Selection border- SelectionRect
Enables the use of a selection border for selected cells or rows.
The following settings are available:
Value Description Explanation
0 None No selection border is drawn for selected cells or rows.
1 Cell A selection border is drawn for the selected cell.
2 Row A selection border is drawn for the selected row.
The attribute can be assigned dynamic properties by means of the name SelectionRect. The
data type is LONG.
SelectionRectColor property (before WinCC V7)
Description
Specifies the color of the rectangle in the message window if SelectionType equals "1".
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
SelectionRectColor property
Color of the selection border - SelectionRectColor
Specifies the color of the selection border. The button opens the "Color selection" dialog.
The attribute can be assigned dynamic properties by means of the name SelectionRectColor.
The data type is LONG.
SelectionRectWidth property (before WinCC V7)
Description
Specifies the line weight of the rectangle in the message window if SelectionType equals "1".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 567
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
SelectionRectWidth property
Line weight of the selection border - SelectionRectWidth
Defines the line weight of the selection border in pixels.
The attribute can be assigned dynamic properties by means of the name SelectionRectWidth.
The data type is LONG.
SelectionType property (before WinCC V7)
Description
Specifies if the selected message in the message window should be optically emphasized by
color change or rectangle.
● 0 - Color Change: selected message is optically emphasized by color change
● 1 - Rectangle: selected message is optically emphasized by a rectangle
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
SelectionType property
Selectable rows - SelectionType
Defines the number of lines you can select. The following settings are available:
Value Description Explanation
0 None No row selection.
1 Single selection One row can be selected.
2 Multiple selection Multiple rows can be selected.
The attribute can be assigned dynamic properties by means of the name SelectionType. The
data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
568 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
SelIndex property
Description
Defines and returns the index of which the associated text is highlighted in the combobox or
list box.
The maximum value is the number of lines (NumberLines) of the object.
SelText property
Description
Shows the text defined with the "Selected field" (SelIndex) attribute which is highlighted in the
combobox or list box.
SelTextColor Property
Description
Defines or returns the color of the text of the selected entry in the text list object. LONG write-
read access.
See also
Text list (Page 194)
ScreenItem Object (Page 123)
ServerData Property
Description
The attribute can only be modified using the "Properties of WinCC Online Trend Control" dialog.
Read only access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 569
VBS for Creating Procedures and Actions
1.14 VBS Reference
ServerDataX
ServerDataX
Accesses the configured data connection for the X axis with WinCC FunctionTrendControl.
The attribute can be assigned dynamic properties by means of the name ServerDataX. The
data type is LONG.
Example: Editing the start ID
You may use the ServerDataX attribute to edit the start ID of the X axis.
Prerequisite is that you have an existing trend and trend view, configured X and Y axes, as
well as a data connection to the user archive.
In the following example you employ the GetTrend method to set a reference to the object in
step one, and then to the trend used in step two. Determine the data connection settings in
the third step. Set the start ID to 4 in step 4. The number (3) represents the listing type "user
archive" for data transfer. Change the modified data connection settings in step five:
Sub OnCklick(ByVal Item)
1. Step:
Dim fx_ctrl
Set fx_ctrl ScreenItems.Item("Control1")
2. Step:
Dim fx_trend
Set fx_trend = fx_ctrl.Getrend("myTrend1")
3. Step:
Dim vServerDataX, vServerDataY
vServerDataX = fx_trend.ServerDataX
vServerDataY = fx_trend.ServerDataY
4. Step:
Dim startId
startId = CLng(4)
vServerDataX(3) = startId
vServerDataY(3) = startId
5. Step:
fx_trend.ServerDataX = ServerDataX
fx_trend.ServerDataY = ServerDataY
End Sub
ServerDataY
ServerDataY
Accesses the configured data connection for the Y axis with WinCC FunctionTrendControl.
WinCC: Scripting (VBS, ANSI-C, VBA)
570 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name ServerDataY. The
data type is LONG.
Example: Editing the start ID
You may use the ServerDataY attribute to edit the start ID of the Y axis.
Prerequisite is that you have an existing trend and trend view, configured X and Y axes, as
well as a data connection to the user archive.
In the following example you employ the GetTrend method to set a reference to the object and
then to the trend used. Determine the data connection settings in the third step. Set the start
ID to 4 in step 4. The number (3) represents the listing type "user archive" for data transfer.
Change the modified data connection settings in step five:
Sub OnCklick(ByVal Item)
1. Step:
Dim fx_ctrlSet fx_ctrl ScreenItems.Item("Control1")
2. Step:
Dim fx_trendSet fx_trend = fx_ctrl.Getrend("myTrend1")
3. Step:
Dim vServerDataX, vServerDataYvServerDataX =
fx_trend.ServerDataXvServerDataY = fx_trend.ServerDataY
4. Step:
Dim startIdstartId = CLng(4)vServerDataX(3) =
startIdvServerDataY(3) = startId
5. Step:
fx_trend.ServerDataX = ServerDataXfx_trend.ServerDataY =
ServerDataY
End Sub
ServerNames property
Server selection - ServerNames
Defines from which servers within a distributed system the message window obtains the
display data.
The attribute can be assigned dynamic properties by means of the name ServerNames. The
data type is STRING.
ServerNames property (before WinCC V7)
Description
Defines the server in a distributed system to which the data in the message window should
relate. Servers are specified as follows: NameServer1;NameServer2;NameServer3. Write/
Read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 571
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
ServerPrefix Property
Description
Defines the server containing the picture to be displayed in the picture window in Runtime or
returns the server name.
Enter the server name followed by two colons: "<Servername>::". No check is made as to
whether the server actually exists.
See also
Picture Window (Page 177)
ScreenItem Object (Page 123)
Sh - Sk
ShareSpaceWithSourceControl property
ShareSpaceWithSourceControl
Defines whether the size of the source control in the picture window is adapted so that the
WinCC RulerControl is also displayed in a small picture window.
Value Explanation
TRUE The source control in the picture window is adapted.
FALSE The source control in the picture window is not adapted.
The attribute can be assigned dynamic properties by means of the name
ShareSpaceWithSourceControl. The data type is BOOLEAN.
ShowBar Property
Description
TRUE, when the bar should be displayed. BOOLEAN write-read access.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
572 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ShowBarIcon property
ShowBarIcon
Enables the display of an icon below the value axes. The symbol indicates the diagram
currently displayed in the foreground.
The attribute can be assigned dynamic properties using the name ShowBarIcon. The data
type is BOOLEAN.
ShowDanger Property
Description
Controls the display of the "danger zone" on the instrument scale. BOOLEAN write-read
access.
TRUE : The area is identified by the color defined in "DangerColor".
FALSE : The color identification of the area is switched off.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
ShowDecimalPoint Property
Description
TRUE, when the labeling of the scale section should be with decimal numbers (decimal point
and one decimal place).
FALSE, when the labeling of the scale section should be with whole numbers.
BOOLEAN write-read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
ShowMilliseconds property
ShowMilliseconds
Specifies whether milliseconds are displayed in the diagnostic buffer view.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 573
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties using the name ShowMilliseconds. The data
type is BOOLEAN.
ShowNormal Property
Description
Controls the display of the "normal zone" on the instrument scale. BOOLEAN write-read
access.
TRUE : The area is identified by the color defined for normal color.
FALSE : The color identification of the area is switched off.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
ShowPeak Property
Description
Defines the display of a slave pointer to display the maximum value. BOOLEAN write-read
access.
TRUE : The slave pointer is displayed.
FALSE : The slave pointer is hidden.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
ShowPosition Property
Description
TRUE, when the slider position is to be displayed. BOOLEAN write-read access.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
574 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ShowRuler property
Show ruler - ShowRuler
Enables the display of a ruler for scanning the coordinate points on picture calls.
Value Explanation
TRUE Enables the display of a ruler for scanning the coordinate points.
FALSE Disables the display of a ruler for scanning the coordinate points.
The attribute can be assigned dynamic properties by means of the name ShowRuler. The data
type is BOOLEAN.
ShowRulerImmediately Property
Description
TRUE, when the ruler for determining the coordinate values should be displayed when opening
a picture. BOOLEAN write-read access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
ShowRulerInAxis property
ShowRulerInAxis
Enables the display of rulers in the time axis.
Value Explanation
TRUE Enables the display of rulers in the time axes.
FALSE Disables the display of rulers in the time axes.
The attribute can be assigned dynamic properties by means of the name ShowRulerInAxis.
The data type is BOOLEAN.
ShowScrollbars property
Scroll bars - ShowScrollbars
Enables the display of scroll bars.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 575
VBS for Creating Procedures and Actions
1.14 VBS Reference
The following settings are available:
Value Description Explanation
0 No The display of scroll bars is disabled.
1 as required Scroll bars are displayed if space requirements of the control are greater than the actual
display area.
2 always The scroll bars are always displayed.
The attribute can be assigned dynamic properties by means of the name ShowScrollbars. The
data type is LONG.
ShowSlider property
ShowSlider
Specifies if a time slider is displayed in the control.
The attribute can be assigned dynamic properties by means of the name ShowSlider. The data
type is BOOLEAN.
ShowSortButton property
Use sorting button - ShowSortButton
Enables the display of a sorting button above the vertical scroll bar. Click this sorting button
to sort the selected column based on the configured sorting criteria. The sorting button is not
displayed if the table does not contain a vertical scroll bar.
Value Explanation
TRUE Enables sorting of a selected column by means of sorting button.
FALSE The sorting button is not displayed.
The attribute can be assigned dynamic properties by means of the name ShowSortButton .
The data type is BOOLEAN.
ShowSortIcon property
Show sorting icon - ShowSortIcon
Enables the display of the sorting icon.
Value Explanation
TRUE Enables the display of the sorting icon.
FALSE Disables the display of the sorting icon.
The attribute can be assigned dynamic properties by means of the name ShowSortIcon. The
data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
576 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ShowSortIndex property
Show sorting index - ShowSortIndex
Enables the display of a sorting icon.
Value Explanation
TRUE Enables the display of a sorting index.
FALSE Disables the display of a sorting index.
The attribute can be assigned dynamic properties by means of the name ShowSortIndex. The
data type is BOOLEAN.
ShowSpanNames Property
Description
TRUE, if a section name is also to be displayed in the Value column of Trend Control apart
from the measured value and the status display "i" and "u". BOOLEAN write-read access.
ShowStatisticRuler property
ShowStatisticRuler
Enables the display of rulers in the statistics field on picture calls.
Value Explanation
TRUE Enables the display of rulers in the statistics field.
FALSE Disables the display of rulers in the statistics field.
The attribute can be assigned dynamic properties by means of the name ShowStatisticRuler.
The data type is BOOLEAN.
ShowThumb Property
Description
TRUE, when the slider is to be displayed. BOOLEAN write-read access.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 577
VBS for Creating Procedures and Actions
1.14 VBS Reference
ShowTitle property
Window title - ShowTitle
Defines representation the Control window header.
Value Designation Explanation
0 No No window title.
1 Normal The window title consists of a WinCC icon and text. The text is entered in the "Text" field.
2 Narrow The window title consists only of text. The text is entered in the "Text" field.
The attribute can be assigned dynamic properties by means of the name ShowTitle. The data
type is LONG.
ShowToolbar property
ShowToolbar
Specifies if a toolbar is displayed in the control.
The attribute can be assigned dynamic properties by means of the name ShowToolbar. The
data type is BOOLEAN.
ShowTrendIcon property
ShowTrendIcon
Enables the display of an icon below the value axes. The icon indicates the trend currently
displayed in the foreground.
The attribute can be assigned dynamic properties by means of the name ShowTrendIcon. The
data type is BOOLEAN.
ShowValuesExponentialX Property
Description
TRUE, when the X-coordinate of a measured value determined via the "Display value at this
position" function is displayed in exponential notation by a trend referenced via "Index".
Whether the information is evaluated is dependent on the value of the "TimeAxisX" property.
BOOLEAN write-read access.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
578 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ShowValuesExponentialY Property
Description
TRUE, when the Y-coordinate of a measured value determined via the "Display value at this
position" function is displayed in exponential notation by a trend referenced via "Index".
BOOLEAN write-read access.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
ShowWarning Property
Description
Controls the display of the "warning zone" on the instrument scale. BOOLEAN write-read
access.
TRUE : The area is identified by the color defined by the warning color attribute.
FALSE : The color identification of the area is switched off.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
SignificantMask Property
Description
Is required in Runtime to display the active message class with the highest priority.
The value of the SignificantMask property represents an internal system output value does not
require any specific configuration by the user. Updating is initiated in Runtime by clicking on
the object.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 579
VBS for Creating Procedures and Actions
1.14 VBS Reference
Sizeable property
Sizeable
Enables resizing of the control during runtime.
Value Explanation
TRUE The control can be resized during runtime.
FALSE The control cannot be resized during runtime.
The attribute can be assigned dynamic properties by means of the name Sizeable. The data
type is BOOLEAN.
SkinName property
Style - SkinName
The control style can be defined in this selection field.
The following settings are available:
Value Designation Explanation
Project setting The style corresponds to the project settings in WinCC Explorer.
0 Simple "Classic" WinCC style up to WinCC V6.2
1 Standard Standard style as of WinCC V7
Basic Process Control The style is reserved for internal use with Basic Process Control.
If you have saved new designs for the controls in the following folders, you can select these
designs in the selection field:
● Below the folder "C:\Programme(x86)\Common Files\Siemens\bin\CCAxControlSkins"
● Project-specific, for example in "C:\WINCCProjects\TestProject\GraCS
\CCAxControlSkins"
The attribute can be assigned dynamic properties by means of the name SkinName. The data
type is STRING.
Sm - Sq
SmallChange Property
Description
Defines how many steps the controller can be moved with one mouse click or returns the value.
WinCC: Scripting (VBS, ANSI-C, VBA)
580 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Slider (Page 210)
ScreenItem Object (Page 123)
SmartTag property
Description
Returns an object of type "SmartTag".
See also
SmartTags Object (Page 134)
SortOrder Property
Description
Defines the sort sequence of the message blocks in the message window.
SortSequence property
Sorting order by mouse click - SortSequence
Specifies how to change the sorting order by mouse click.
The following sorting orders are available:
Value Description Explanation
0 Up/down/none You can toggle between ascending, descending and no sorting by means of mouse click.
1 Up/down You can toggle between ascending and descending sorting order by means of mouse click.
The attribute can be assigned dynamic properties by means of the name SortSequence. The
data type is LONG.
SourceBeginTime Property
Description
In the case of online tags and archive tags ("ProviderType" = -1), it defines the starting time
of the time range of a trend referenced via "Index" and to be displayed in the trend window. In
the case of modification of "SourceBeginTime", impermissible combinations with other
attributes for data connection could be created. Therefore, before modifying
"SourceBeginTime", the immediate acceptance of the changes must be prevented using
"FreezeProviderConnections".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 581
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
SourceControl property
Source - SourceControl
Defines the control to be interconnected with WinCC RulerControl.
The attribute can be assigned dynamic properties by means of the name SourceControl. The
data type is STRING.
SouceControlType property
Type - SourceControlType
Defines the type of control that is interconnected with the WinCC RulerControl in the "Source"
field.
Value Designation Explanation
0 None The RulerControl is not connected to any source.
1 OnlineTrend The RulerControl is connected with an OnlineTrendControl.
Control
2 OnlineTable The RulerControl is connected with an OnlineTableControl.
Control
3 FunctionTrend The RulerControl is connected with a FunctionTrendControl.
Control
The attribute can be assigned dynamic properties by means of the name SourceControlType.
The data type is LONG.
SourceEndTime Property
Description
In the case of online tags and archive tags ("ProviderType" = -1), it defines the stopping time
of the time range of a trend referenced via "Index" and to be displayed in the trend window. In
the case of modification of "SourceEndTime", impermissible combinations with other attributes
for data connection could be created. Therefore, before modifying "SourceEndTime", the
immediate acceptance of the changes must be prevented using "FreezeProviderConnections".
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
582 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
SourceNumberOfUAValues Property
Description
For values from the user archives ("ProviderType" = -2) it defines the number of values which
should be loaded from the user archive for a trend referenced via "Index". In the case of
modification of "SourceNumberOfUAValues", impermissible combinations with other attributes
for data connection could be created. Therefore, before modifying
"SourceNumberOfUAValues", the immediate acceptance of the changes must be prevented
using "FreezeProviderConnections".
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
SourceNumberOfValues Property
Description
The "Index" property references a trend. In the case of online tags and archive tags
("ProviderType" = -1), "SourceNumberOfValues" defines the number of values which should
be displayed in the trend window. Whether the information is evaluated is dependent on the
value of the "SourceTimeRange" property.
In the case of modification of "SourceNumberOfValues", impermissible combinations with
other attributes for data connection could be created. Therefore, before modifying
"SourceNumberOfValues", the immediate acceptance of the changes must be prevented using
"FreezeProviderConnections".
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
SourceTagNameX Property
Description
The "Index" property references a trend. In the case of online tags and archive tags
("ProviderType" = -1) "SourceTagNameX" defines the tag which should be displayed along
the X-axis. In the case of modification of "SourceTagNameX", impermissible combinations with
other attributes for data connection could be created. Therefore, before modifying
"SourceTagNameX", the immediate acceptance of the changes must be prevented using
"FreezeProviderConnections".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 583
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
SourceTagNameY Property
Description
The "Index" property references a trend. In the case of online tags and archive tags
("ProviderType" = -1) "SourceTagNameY" defines the tag which should be displayed along
the X-axis. In the case of modification of "SourceTagNameY", impermissible combinations with
other attributes for data connection could be created. Therefore, before modifying
"SourceTagNameY", the immediate acceptance of the changes must be prevented using
"FreezeProviderConnections".
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
SourceTagProviderDataX Property
Description
The attribute can only be modified using the "Properties of WinCC Function Trend Control"
dialog.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
SourceTagProviderDataY Property
Description
The attribute can only be modified using the "Properties of WinCC Function Trend Control"
dialog.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
584 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
SourceTimeRange Property
Description
The "Index" property references a trend. In the case of online tags and archive tags
("ProviderType" = -1) "SourceTimeRange" defines how the time range to be displayed in the
trend window is defined. In the case of modification of "SourceTimeRange", impermissible
combinations with other attributes for data connection could be created. Therefore, before
modifying "SourceTimeRange", the immediate acceptance of the changes must be prevented
using "FreezeProviderConnections".
0: The time range to be displayed is defined by the starting time (SourceBeginTime) and the
number of value pairs (SourceNumberOfValues).
-1: The time range to be displayed is defined by the starting time (SourceBeginTime) and
stopping time (SourceEndTime).
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
SourceUAArchive Property
Description
The "Index" property references a trend. In the case of values from the user archives
("ProviderType" = -2), "SourceUAArchive" defines the user archive from which the values
should be loaded. In the case of modification of "SourceUAArchive", impermissible
combinations with other attributes for data connection could be created. Therefore, before
modifying "SourceUAArchive" the immediate acceptance of the changes must be prevented
using "FreezeProviderConnections".
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
SourceUAArchiveStartID Property
Description
The "Index" property references a trend. In the case of values from the user archives
("ProviderType" = -2), "SourceUAArchiveStartID" defines the data record from which the
values should be loaded from the user archive. In the case of modification of
"SourceUAArchiveStartID", impermissible combinations with other attributes for data
connection could be created. Therefore, before modifying "SourceUAArchiveStartID", the
immediate acceptance of the changes must be prevented using "FreezeProviderConnections".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 585
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
SourceUAColumnX Property
Description
The "Index" property references a trend. In the case of values from the user archives
("ProviderType" = -2), "SourceUAColumnX" defines the column in the user archive from which
the values for the X-axis should be loaded. In the case of modification of "SourceUAColumnX",
impermissible combinations with other attributes for data connection could be created.
Therefore, before modifying "SourceUAColumnX", the immediate acceptance of the changes
must be prevented using "FreezeProviderConnections".
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
SourceUAColumnY Property
Description
The "Index" property references a trend. In the case of values from the user archives
("ProviderType" = -2), "SourceUAColumnY" defines the column in the user archive from which
the values for the Y-axis should be loaded. In the case of modification of "SourceUAColumnY",
impermissible combinations with other attributes for data connection could be created.
Therefore, before modifying "SourceUAColumnY", the immediate acceptance of the changes
must be prevented using "FreezeProviderConnections".
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
SplittedViewRatio property
SplittedViewRatio
With a split display, this specifies the portion of the "Diagnostic overview" area is shown
compared to the "Detail view" area.
The attribute can be assigned dynamic properties using the name SplittedViewRatio. The data
type is DOUBLE.
WinCC: Scripting (VBS, ANSI-C, VBA)
586 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
SquareExtent Property
Description
TRUE, when the size of the clock should be adjustable to any side ratio by dragging the marking
points with the mouse. BOOLEAN write-read access.
See also
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
St - Sy
StartAngle Property
Description
Defines or returns the start of the object. The information is in counterclockwise direction in
degrees, beginning at the 12:00 clock position.
See also
Pie segment (Page 150)
Circular arc (Page 149)
Ellipse segment (Page 145)
Ellipse arc (Page 144)
ScreenItem Object (Page 123)
State property
Description
Returns the status of a message.
The following table shows the possible states of a message:
State Alarm Log Status
1 Came In
2 Went Out
5 Came in and comment
6 Gone and comment
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 587
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Alarms object (list) (Page 108)
Statusbar Property
Description
TRUE, when the status line is to be displayed. BOOLEAN write-read access.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
StatusbarAlignment property
Alignment - StatusbarAlignment
Specifies the alignment of the status bar in the control.
The following settings are available:
Value Description Explanation
0 Top The status bar is aligned to the top edge.
1 Below The status bar is aligned to the bottom edge.
2 Left The status bar is aligned to the left edge.
3 Right The status bar is aligned to the right edge.
The attribute can be assigned dynamic properties using the name StatusbarAlignment. The
data type is LONG.
StatusbarBackColor property
Background color - StatusbarBackColor
Defines the background color of the status bar. The button opens the "Color selection" dialog
to select the color.
For the setting to become active, the "Display" or "StatusbarUseBackColor" option must be
activated.
The attribute can be assigned dynamic properties by means of the name
StatusbarBackColor. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
588 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
StatusbarElementAdd property
New - StatusbarElementAdd
Defines a new, user-defined status bar element. The name set by WinCC can be edited in the
"Object name" field.
The attribute can be assigned dynamic properties by means of the name
StatusbarElementAdd . The data type is STRING.
StatusbarElementAutoSize property
Automatic - StatusbarElementAutoSize
Enables autosizing of the width of a status bar element selected.
Value Explanation
TRUE The width of the selected element is set automatically.
FALSE The width of the selected element is not set automatically.
The attribute can be assigned dynamic properties by means of the name
StatusbarElementAutoSize. The data type is BOOLEAN.
StatusbarElementCount property
StatusbarElementCount
Defines the number of configurable status bar elements.
The attribute can be assigned dynamic properties by means of the name
StatusbarElementCount. The data type is LONG.
StatusbarElementIconId property
StatusbarElementIconId
Default assignment of the ID number and icon of a status bar element.
The attribute for custom status bar elements can be made assigned dynamic properties by
measn of the name StatusbarElementIconId. The data type is LONG.
StatusbarElementID property
Object ID - StatusbarElementID
Unique ID of the status bar element selected. WinCC assigns this read only ID number.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 589
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name
StatusbarElementID. The data type is LONG.
StatusbarElementIndex property
StatusbarElementIndex
References a status bar element. Using this attribute you can assign the values of other
attributes to a specific status bar element.
Values between 0 and "StatusbarElementCount" minus 1 are valid for
"StatusbarElementIndex". Attribute "StatusbarElementCount" defines the number of
configurable status bar elements.
The "StatusbarElementIndex" attribute can be assigned dynamic properties by means of
attribute StatusbarElementIndex. The data type is LONG.
StatusbarElementName property
Object name - StatusbarElementName
Displays the object name of the status bar element selected. You can rename the objects of
custom status bar elements.
The "StatusbarElementName" attribute can be assigned dynamic properties by means of
attribute StatusbarElementRename. The data type is STRING.
StatusbarElementRemove property
Remove - StatusbarElementRemove
Removes the selected status bar element. You can only remove user-defined status bar
element from the list.
The attribute can be assigned dynamic properties by means of the name
StatusbarElementRemove. The data type is STRING.
StatusbarElementRename property
StatusbarElementRename
Renames a custom status bar element which is referenced by means of
"StatusbarElementIndex" attribute.
The attribute for custom elements can be assigned dynamic properties by means of the name
StatusbarElementRename. "StatusbarElementRename" also sets a dynamic attribute
"StatusbarElementName". The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
590 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
StatusbarElementRepos property
Up/Down - StatusbarElementRepos
Changes the sorting order of button functions. "Up" and "Down" moves the selected status bar
element up or down in the list. This moves the status bar element of the Control towards the
front or towards the back in Runtime.
The attribute can be assigned dynamic properties by means of the name
StatusbarElementRepos . The data type is LONG.
StatusbarElementText property
StatusbarElementText
Defines the text to be displayed for the status bar element. You can edit the
"StatusbarElementText" attribute for custom elements.
The attribute for custom elements can be assigned dynamic properties by means of the name
StatusbarElementText. The data type is STRING.
StatusbarElementTooltipText property
StatusbarElementTooltipText
Defines the tooltip text for the custom status bar element.
The attribute can be assigned dynamic properties by means of the name
StatusbarElementTooltipText. The data type is STRING.
StatusbarElementVisible property
Status bar elements - StatusbarElementVisible
Activate the elements in the list of status bar elements for their display in Runtime.
Click a list entry to adapt the properties, or to change its position in the status bar of the Control
by means of the "Up" and "Down" buttons.
Value Explanation
TRUE The status bar element is displayed.
FALSE The status bar element is not displayed.
The attribute can be assigned dynamic properties by means of the name
StatusbarElementVisible. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 591
VBS for Creating Procedures and Actions
1.14 VBS Reference
StatusbarElementUserDefined property
StatusbarElementUserDefined
Indicates whether the project engineer has added the status bar element as a new custom
element.
Value Explanation
TRUE The status bar element is user-defined.
FALSE The status bar element is defined by the system.
The attribute can be assigned dynamic properties by means of the name
StatusbarElementUserDefined. The data type is BOOLEAN.
StatusbarElementWidth property
Width in pixels - StatusbarElementWidth
Shows the width of the status bar element selected in pixels. You can define the width if the
"Automatic" option is not activated.
The attribute can be assigned dynamic properties by means of the name
StatusbarElementWidth. The data type is LONG.
StatusbarFontColor property
Font color - StatusbarFontColor
Defines the color of the text in the status bar.
The attribute can be assigned dynamic properties by means of the name StatusbarFontColor.
The data type is LONG.
StatusbarPanes Property
Description
Defines the elements to be displayed in the status bar. Write/Read access.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
592 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
StatusbarShowTooltips property
Tooltips - StatusbarShowTooltips
Enables the display of tooltips for the status bar elements in Runtime.
Value Explanation
TRUE Enables the display of tooltips.
FALSE Disables the display of tooltips.
The attribute can be assigned dynamic properties by means of the name
StatusbarShowTooltips. The data type is BOOLEAN.
Attribute "StatusbarElementTooltipText" defines the tooltip text.
StatusbarText property
StatusbarText
Default text in the status bar.
The attribute can be assigned dynamic properties by means of the name StatusbarText. The
data type is STRING.
StatusbarUseBackColor property
Display background color - StatusbarUseBackColor
Sets a background color for the status bar.
Value Explanation
TRUE Enables the display of the background color of the status bar.
FALSE Disables the display of a background color for the status bar.
The attribute can be assigned dynamic properties by means of the name
StatusbarUseBackColor. The data type is BOOLEAN.
StatusbarVisible property
Show status bar - StatusbarVisible
Enables the display of the status bar of a control.
Value Explanation
TRUE Enables the display of a status bar.
FALSE Disables the display of a status bar.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 593
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name StatusbarVisible .
The data type is BOOLEAN.
StepSeconds property
StepSeconds
Specifies the interval for step forward or step backward in movies.
The attribute can be assigned dynamic properties by means of the name StepSeconds. The
data type is LONG.
Stretch Property
Description
Defines whether the side ratio is retained or adjustable on changing the icon size. BOOLEAN
write-read access.
● FALSE : The side ratio is retained on changing the icon size.
● TRUE : The side ratio of the icon can be adjusted parallel to changing the icon size.
See also
HMI Symbol Library (Page 237)
ScreenItem Object (Page 123)
SymbolAppearance property
Foreground mode (SymbolAppearance)
Specifies the appearance of the icon.
The following settings are available:
Value Description Comments
0 Original The appearance of the icon corresponds to the multi-color representation in the
selection of the "Icons" tab.
1 Shadow "Black" lines are maintained as contour lines. Elements of the symbols in other
colors are displayed as brightness grades of the current foreground color.
2 Solid "Black" lines are maintained as contour lines. All icon elements of other colors are
assigned the color value of the current foreground color.
3 Outline Lines of the color "Black" are maintained as contour lines. All the elements of the
symbol in other colors are assigned the color value of the current background color.
The attribute can be assigned dynamic properties by means of the name SymbolAppearance.
The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
594 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.4.19 T
Ta -Tic
TableColor property
Row background color 1 - TableColor
Defines the background color of the rows. The button opens the "Color selection" dialog.
The attribute can be assigned dynamic properties by means of the name TableColor. The data
type is LONG.
TableColor2 property
Row background color 2 - TableColor2
Specifies the background color of "Row color 2". The button opens the "Color selection" dialog.
The setting is only active in Runtime if the "Row color 2" or "UseTableColor2" option is
activated. The background colors of "Row color 2" and "Row color 1" are used alternately in
this case.
The attribute can be assigned dynamic properties by means of the name TableColor2. The
data type is LONG.
TableFocusOnButtonCommand Property
Description
Defines whether the focus is set to the table of the control when a button in a script is clicked.
TableForeColor property
Row font color 1 - TableForeColor
Specifies the font color of the rows. The button opens the "Color selection" dialog.
The attribute can be assigned dynamic properties by means of the name TableForeColor. The
data type is LONG.
TableForeColor2 property
Row font color 2 - TableForeColor2
Specifies the font color of "Row color 2". The button opens the "Color selection" dialog.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 595
VBS for Creating Procedures and Actions
1.14 VBS Reference
The setting is only active in Runtime if the "Row color 2" or "UseTableColor2" option is
activated. The font colors of "Row color 2" and "Row color 1" are used alternately in this case.
The attribute can be assigned dynamic properties by means of the name TableForeColor2.
The data type is LONG.
TableStyle property
TableStyle
Specifies the appearance of the fields in the table in WinCC UserAdminControl.
Value Description Explanation
0 Flat The fields of the table are displayed normally.
1 Button The fields of the table are displayed in button style.
The attribute can be assigned dynamic properties using the name TableStyle. The data type
is LONG.
TagName Property
Description
The "Index" property references a trend. "TagName" defines the tag linked to this trend. It is
specified in the form "Archivname\Variablenname" to display tags in a process value archive
or "TasgName" to display an internal or external tag which is not stored in an archive.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
TagPrefix Property
Description
Defines or returns the tag prefix which is prefixed to all tags contained in the picture window
object. In this way, a picture that is embedded in a picture window retains access to its own
tags while another accesses other tags.
Modification of the TagPrefix takes effect when a picture is reloaded. When a picture is
changed, this occurs automatically; otherwise, the picture name must be reassigned.
WinCC: Scripting (VBS, ANSI-C, VBA)
596 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The tag prefix can be freely defined, but must match the name of the structure tags.
Note
Do not specify an additional tag prefix in the child picture window
If a picture window is configured in a referenced picture of a picture window, the tag prefix of
the parent picture window is applied to the child picture window of the tag prefix. You should
not specify an additional tag prefix in the child picture window, because WinCC does not
support bundled structure tags. The interpretation "Tag_prefix1.Tag_prefix2.Tag_name"
cannot be used for dynamization.
Note
The TagPrefix property is not available for the controls.
See also
Picture Window (Page 177)
ScreenItem Object (Page 123)
Tags Property
Description
Returns an object of type "Tags".
Tags (read only)
Example:
The following example accesses the tag "Tag1":
'VBS86
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
See also
Tags Object (List) (Page 137)
HMIRuntime Object (Page 116)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 597
VBS for Creating Procedures and Actions
1.14 VBS Reference
TagProviderClsid Property
Description
The "Index" property references a trend. "TagProviderClsid" defines whether this trend should
display an online tag or archived value. The data is only evaluated for online tags and archive
tags ("ProviderType" = -1).
{A3F69593-8AB0-11D2-A440-00A0C9DBB64E}: Online tag.
{416A09D2-8B5A-11D2-8B81-006097A45D48}: Values are read from a process value archive
or a user archive.
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
Template Property
Description
Returns the template for displaying the window content of the "Application Window" object.
Read only access.
The following templates are possible depending on the property value:
Window Contents = Global Script
"GSC diagnostics"
The application window is supplied by applications of the Global Script. The results of the
diagnosis system are displayed.
"GSC Runtime"
The application window is supplied by applications of the Global Script. The analysis results
regarding characteristics in Runtime are displayed.
Window Contents = Print Jobs
"All Jobs":
The application window is supplied by the logging system. The available reports are displayed
as a list.
"All Jobs - Context Menu":
The application window is supplied by the logging system. The available reports are displayed
as a list. The shortcut menu enables the selection of print options, display of a print preview
as well as a printout of the log.
"Job Detail View":
The application window is supplied by the logging system. The available reports are displayed
in a selection menu. Detailed information is displayed for the selected report.
"Selected Jobs - Context Menu":
The application window is supplied by the logging system. The available reports are displayed
WinCC: Scripting (VBS, ANSI-C, VBA)
598 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
as a list. This list only contains reports which you have activated the option "Mark for print job
list" in the "Print Job Properties" dialog. The shortcut menu enables the selection of print
options, display of a print preview as well as a printout of the log.
See also
ScreenItem Object (Page 123)
Application Window (Page 171)
Text Property
Description
Defines or returns the labeling for an object.
See also
Radio box (Page 205)
Check box (Page 202)
Button (Page 199)
Static text (Page 163)
ScreenItem Object (Page 123)
Text list property
Text list (Textlist)
You use the text list for the assignment of texts to specific values when configuring the following
objects:
● Smart objects: Combo box, list box, text list
● Windows objects: Check box, radio box
Double-click the attribute and select the name of a text list that you have created in the "Text
and Graphics Lists" editor.
To remove the link to the text list, double-click in the "Static" column and delete the name of
the text list.
The display texts of the configured text list are then displayed in runtime in an input list and/or
output list.
The “Text list” attribute can be made dynamic with the name "Textlist".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 599
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Radio box (Page 205)
Check box (Page 202)
Combobox (Page 187)
List Box (Page 187)
Text list (Page 194)
TextListSort property
Sorting of the text list
When you use a text list from the "Text and Graphic List" editor, you can specify the sorting of
texts for the WinCC object.
Value Sort Description
0 None Original sorting of the text list in the "Text and Graphic List" editor
1 Value Increasing in number according to configured value/range
2 Text Alphabetically from A to Z according to configured text
The setting depends on the language.
The attribute is only available for the "Text list" smart object. When no configured text list is
linked in the object, the object property is grayed out.
The "Sorting of the text list" attribute can be made dynamic with the name "TextListSort".
See also
Text list (Page 194)
ThumbBackColor Property
Description
Defines the color of the slider.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
600 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TicColor Property
Description
Defines the color of the scale tick marks. LONG write-read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
TicFont Property
Description
Controls the display of the scale division labeling. Read only access.
The following properties can be set:
- Font
- Font Style
- Font Size
- "Strikethrough" effect
- "Underline" effect
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
TicOffset Property
Description
Defines the diameter of the imaginary circle on which the scale graduation is set. The value is
related to the smaller value of the geometric properties Width and Height.
The ends of the main tick marks of the scale graduation point outwards onto this circle.
Value range from 0 to 1.
0: The scale division is in the middle of the graduated scale disk.
1: The diameter of the imaginary circle for the scale tick marks is the smaller value of the
geometric properties Width and Height.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 601
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
TicTextColor Property
Description
Defines the color of the labeling of the scale tick marks.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
TicTextOffset Property
Description
Defines the diameter of the imaginary circle on which the labeling of the scale tick marks is
set. The value is related to the smaller value of the geometric properties Width and Height.
Value range from 0 to 1.
0: The label is in the middle of the graduated scale disk.
1: The diameter of the imaginary circle for the label is the smaller value of the geometric
properties Width and Height. As a result, part of the label can lie outside the object limits and
is, thus, invisible.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
TicWidth Property
Description
Defines the length of the long tick marks for the scaling. The value is related to the half the
smaller value of the geometric properties Width and Height.
The length of the tick marks for fine scaling is 0.5*scale width.
Value range from 0 to end of scale.
0: No scale graduation is available. The division of the scale into ranges is not visible.
WinCC: Scripting (VBS, ANSI-C, VBA)
602 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Scaling distance: The scaling division ranges from the middle point of the graduated scale disk
to the value defined by the scaling distance.
See also
ScreenItem Object (Page 123)
WinCC Gauge Control (Page 251)
Ticks Property
Description
TRUE, when the numbered face is displayed. BOOLEAN write-read access.
See also
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
TicksColor Property
Description
Defines or returns the color of the hour markings on the face of the analog clock. LONG write-
read access.
See also
WinCC Digital/Analog Clock (Page 244)
ScreenItem Object (Page 123)
TickStyle Property
Description
This attribute defines the appearance of the scale. Value Range: 0 to 3.
As a result of the automatic scaling, it is possible that, occasionally, two scale tick marks lie
directly beside each other (apparently wide tick mark). This effect can be corrected by minimally
lengthening or shortening the slider object.
It is also possible to completely suppress display of the scaling ("WithAxes").
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 603
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
TimeAxis - TimeBase
TimeAxis Property
Description
Defines whether a common time axis should be used for all trends in the trend window.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
TimeAxisActualize property
Refresh - TimeAxisActualize
Enables refreshing of the time axis selected.
Value Explanation
TRUE Enables updates of the trend window which is assigned to the time axis.
FALSE Disables updates of the trend window which is assigned to the time axis. This setting can
be useful when comparing a logged trend with a current trend.
The attribute can be assigned dynamic properties by means of the name TimeAxisActualize.
The data type is BOOLEAN.
TimeAxisAdd property
New - TimeAxisAdd
Creates a new time axis.
The attribute can be assigned dynamic properties by means of the name TimeAxisAdd. The
data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
604 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeAxisAlign property
Alignment - TimeAxisAlign
Specifies the mode of alignment of a selected time axis.
The following settings are available:
Value Description Explanation
0 Bottom The selected time axis is displayed below the trend or diagram.
1 Top The selected time axis is displayed above the trend or diagram.
The attribute can be assigned dynamic properties by means of the name TimeAxisAlign. The
data type is LONG.
TimeAxisBarWindow property
Diagram window - TimeAxisBarWindow
Specifies the diagram window in which the selected time axis will be used. You can specify
the available diagram window in the "Diagram window" tab or using "BarWindowAdd".
The attribute can be assigned dynamic properties using the name TimeAxisBarWindow. The
data type is STRING.
TimeAxisBeginTime property
Start time - TimeAxisBeginTime
Defines the start of the time range for a selected time axis.
The attribute can be assigned dynamic properties by means of the name
TimeAxisBeginTime. The data type is Date.
Use the "yyyy-mm-dd hh:mm:ss" format when setting a dynamic time range.
TimeAxisColor property
Time axis color - TimeAxisColor
Specifies the color of the time axis. The button opens the "Color selection" dialog to select the
color.
The setting is only active if the "Use trend color" or "Use diagram color" option is disabled or
if "ValueAxisInTrendColor" is "FALSE".
The attribute can be assigned dynamic properties by means of the name TimeAxisColor. The
data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 605
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeAxisCount property
TimeAxisCount
Defines the number of time axes configured.
The attribute can be assigned dynamic properties by means of the name TimeAxisCount. The
data type is LONG.
TimeAxisDateFormat property
Date format - TimeAxisDateFormat
Defines the date format for visualizing a selected time axis.
The following date formats are available:
Value Explanation
Automatic The date format is set automatically.
dd.MM.yy Day.Month.Year, e.g. 24.12.07.
dd.MM.yyyy Day.Month.Year, e.g. 24.12.2007.
dd/MM/yy Day/Month/Year, e.g. 24/12/07.
dd/MM/yyyy Day/Month/Year, e.g. 24/12/2007.
The attribute can be assigned dynamic properties by means of the name
TimeAxisDateFormat. The data type is STRING.
TimeAxisEndTime property
End time - TimeAxisEndTime
Defines the end of the time range of a selected time axis.
The attribute can be assigned dynamic properties by means of the name TimeAxisEndTime.
The data type is Date.
Use the "yyyy-mm-dd hh:mm:ss" format when setting a dynamic time range.
TimeAxisFormat Property
Description
Defines the format of the information along the time axis.
● 0: The information is provided in hh:mm
● -1: The information is provided in hh:mm:ss
● -2: The information is provided in hh:mm:ss.ms
● -3: The information is provided in hh:mm (full hours)
WinCC: Scripting (VBS, ANSI-C, VBA)
606 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
● -4: The information is provided in hh:mm:ss (full minutes)
● -5: The information is provided in hh:mm:ss.ms (full seconds)
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
TimeAxisInBarColor property
In diagram color - TimeAxisInBarColor
Specifies whether the selected time axis will be displayed in the diagram color. If there is more
than one diagram in the diagram window, the color of the first diagram will be used. You specify
the order of the diagrams on the "Diagrams" tab.
Value Explanation
TRUE The selected time axis is displayed in the diagram color. The setting in the "Color" or "TimeAxisColor" field is
disabled.
FALSE The selected time axis is displayed in the color set in the "Color" or "TimeAxisColor" field.
The attribute can be assigned dynamic properties using the name TimeAxisInBarColor. The
data type is BOOLEAN.
TimeAxisIndex property
TimeAxisIndex
References a configured time axis. Using this attribute you can assign the values of other
attributes to a specific time axis.
Values between 0 and "TimeAxisCount" minus 1 are valid for "TimeAxisIndex". The
"TimeAxisCount" attribute defines the number of configured time axes.
The "TimeAxisIndex" attribute can be assigned dynamic properties by means of attribute
TimeAxisRepos. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 607
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeAxisInTrendColor property
Use trend color - TrendAxisInTrendColor
Sets a trend color for displaying the time axis selected. The color of the first trend is activated
if several trends are displayed in the trend window. Define the order of trends on the "Trends"
tab.
Value Explanation
TRUE The trend color is used to display the time axis selected. The setting in the "Color" or "Time‐
AxisColor" field is disabled.
FALSE The time axis selected is displayed in the color set in the "Color" or "TimeAxisColor" field.
The attribute can be assigned dynamic properties by means of the name
TimeAxisInTrendColor. The data type is BOOLEAN.
TimeAxisLabel property
Label - TimeAxisLabel
Defines the label text for a time axis.
The attribute can be assigned dynamic properties by means of the name TimeAxisLabel. The
data type is STRING.
TimeAxisMeasurePoints property
Number of measurement points - TimeAxisMeasurePoints
Defines the number of measurement points to be displayed at the time axis selected.
The attribute can be assigned dynamic properties by means of the name
TimeAxisMeasurePoints. The data type is LONG.
TimeAxisName property
Object name - TimeAxisName
Specifies the name of a selected time axis.
The "TimeAxisName" attribute can be assigned dynamic properties by means of attribute
TimeAxisRename. The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
608 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeAxisRangeType property
Time range setting - TimeAxisRangeType
Specifies the time range for the time axis selected.
Value Description Explanation
0 Time range Defines the start time and the time range for the time axis.
1 Start to end time Defines the start and end time for the time axis.
2 Number of measurement Defines the start time and the number of measurement points
points for the time axis.
The attribute can be assigned dynamic properties by means of the name
TimeAxisRangeType. The data type is LONG.
TimeAxisRemove property
Remove - TimeAxisRemove
Removes the selected time axis from the list.
The attribute can be assigned dynamic properties by means of the name TimeAxisRemove.
The data type is STRING.
TimeAxisRename property
TimeAxisRename
Renames a time axis which is referenced by means of "TimeAxisIndex" attribute.
The attribute can be assigned dynamic properties by means of the name TimeAxisRename.
"TimeAxisRename" also sets a dynamic attribute "TimeAxisName". The data type is STRING.
TimeAxisRepos property
Up/Down - TimeAxisRepos
Changes the order of the time axes. "Up" and "Down" move the selected time axis up or down
in the list.
The list order determines the time axis position in the trend window or diagram window in
runtime. If the orientation is the same and the time axis is further above, the time axis is shown
at a more remote position of the curve or diagram.
The attribute can be assigned dynamic properties by means of the name TimeAxisRepos. The
data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 609
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeAxisShowDate property
Show date - TimeAxisShowDate
Enables the display of the date and time at the time axis selected.
Value Explanation
TRUE Date and time are displayed. The date format is defined in the "Date format" field.
FALSE The date is not displayed. Only the time is displayed.
The attribute can be assigned dynamic properties by means of the name TimeAxisShowDate.
The data type is BOOLEAN.
TimeAxisTimeFormat property
Time format - TimeAxisTimeFormat
Defines the time format for visualizing a selected time axis.
The following time formats are available:
Value Explanation
Automatic The time format is set automatically.
hh:mm:ss.ms Hours:Minutes:Seconds, e.g. 15:35:44.240.
hh:mm:ss tt Hours:Minutes:Seconds AM/PM, e.g. 03:35:44 PM.
hh:mm:ss.ms tt Hours:Minutes:Seconds.Milliseconds AM/PM, e.g. 03:35:44.240 PM.
The attribute can be assigned dynamic properties by means of the name
TimeAxisTimeFormat. The data type is STRING.
TimeAxisTimeRangeBase property
Time range - TimeAxisTimeRangeBase
Defines the time unit for calculating the time range.
The following time units are available:
Value Description
500 500 ms
1000 1 second
60000 1 minute
3600000 1 hour
86400000 1 day
The attribute can be assigned dynamic properties by means of the name
TimeAxisTimeRangeBase. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
610 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeAxisTimeRangeFactor property
Time range - TimeAxisTimeRangeFactor
Defines the factor for calculating the time range. Only integer factors are valid.
The attribute can be assigned dynamic properties by means of the name
TimeAxisTimeRangeFactor. The data type is SHORT.
TimeAxisTrendWindow property
Trend window - TimeAxisTrendWindow
Specifies the trend window for displaying the time axis selected. Define the available trend
windows in the "Trend window" or "TrendWindowAdd" tab.
The attribute can be assigned dynamic properties by means of the name
TimeAxisTrendWindow. The data type is STRING.
TImeAxisVisible property
Time axis - TimeAxisVisible
The list shows all time axes you created. Click a time axis entry in the list to adapt the properties
and to assign a trend window or diagram window to the time axis.
Select the time axes in the list that you want to display in the trend windows or diagram
windows.
Defines whether the selected time axis is displayed.
Value Explanation
TRUE The time axis is displayed.
FALSE The time axis is not displayed.
The attribute can be assigned dynamic properties by means of the name TimeAxisVisible. The
data type is BOOLEAN.
TimeAxisX Property
Description
TRUE, when a common axis should be used for all trends in the trend window. BOOLEAN
write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 611
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
TimeBase property
Time base - TimeBase
This selection field is used to define the time base for the time stamp in the control.
Value Designation
0 Local time zone
1 Coordinated Universal Time (UTC)
2 Project setting
The attribute can be assigned dynamic properties by means of the name TimeBase. The data
type is LONG.
TimeColumn
TimeColumnActualize property
TimeColumnActualize
Enables the update of values in the selected column.
Value Explanation
TRUE The time column is updated.
FALSE The time column is not updated. This setting can be useful when comparing tables.
The attribute can be assigned dynamic properties by means of the name
TimeColumnActualize. The data type is BOOLEAN.
TimeColumnAdd property
New - TimeColumnAdd
Creates a new time column.
The attribute can be assigned dynamic properties by means of the name TimeColumnAdd.
The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
612 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeColumnAlign property
Alignment - TimeColumnAlign
Defines the mode of alignment of the time column selected.
The following settings are available:
Value Description Explanation
0 left The time column selected is displayed on the left.
1 Centered The time column selected is aligned to center.
2 right The time column selected is displayed on the right.
The attribute can be assigned dynamic properties by means of the name TimeColumnAlign.
The data type is LONG.
TimeColumnAlignment Property
Description
The "Index" property references a pair of columns. "TimeColumnAlignment" defines the
alignment of the time column for this column pair.
● 0: Time values are entered aligned left.
● 1: Time values are entered centered.
● 2: Time values are entered aligned right.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
TimeColumnBackColor property
Background color - TimeColumnBackColor
Specifies the background color of the time column selected. Use the button to open the "Color
selection" dialog.
The setting is useful if:
● The "Use value column colors" option is not activated or
"TimeColumnUseValueColumnColors" is "FALSE".
● The "Background color" option is activated or "UseColumnBackColor" is "TRUE in the "Use
column color" field of the "General" tab".
The attribute can be assigned dynamic properties by means of the name
TimeColumnBackColor. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 613
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeColumnBeginTime property
Start time - TimeColumnBeginTime
Defines the start of the time range for a selected time column.
The attribute can be assigned dynamic properties by means of the name
TimeColumnBeginTime. The data type is Date.
Use the "yyyy-mm-dd hh:mm:ss" format when setting a dynamic time range.
TimeColumnCaption property
Caption - TimeColumnCaption
Defines the caption of the time column.
The attribute can be assigned dynamic properties by means of the name
TimeColumnCaption. The data type is STRING.
TimeColumnCount property
TimeColumnCount
Defines the number of time columns configured.
The attribute can be assigned dynamic properties by means of the name TimeColumnCount.
The data type is LONG.
TimeColumnDateFormat property
Date format - TimeColumnDateFormat
Defines the date format for visualizing a selected time column.
The following date formats are available:
Value Explanation
Automatic The date format is set automatically.
dd.MM.yy Day.Month.Year, e.g. 24.12.07.
dd.MM.yyyy Day.Month.Year, e.g. 24.12.2007.
dd/MM/yy Day/Month/Year, e.g. 24/12/07.
dd/MM/yyyy Day/Month/Year, e.g. 24/12/2007.
The attribute can be assigned dynamic properties by means of the name
TimeColumnDateFormat. The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
614 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeColumnEndTime property
End time - TimeColumnEndTime
Defines the end of the time range of a selected time column.
The attribute can be assigned dynamic properties by means of the name
TimeColumnEndTime. The data type is Date.
Use the "yyyy-mm-dd hh:mm:ss" format when setting a dynamic time range.
TimeColumnForeColor property
Font color - TimeColumnForeColor
Specifies the font color of the time column selected. Use the button to open the "Color selection"
dialog.
The setting is useful if:
● The "Use value column colors" option is not activated or
"TimeColumnUseValueColumnColors" is "FALSE".
● The "Font color" option is activated or "UseColumnForeColor" is "TRUE" in the "Use column
color" field of the "General" tab.
The attribute can be assigned dynamic properties by means of the name
TimeColumnForeColor. The data type is LONG.
TimeColumnHideText property
TimeColumnHideText
Sets text format for displaying the content of a time column.
Value Explanation
TRUE The content is not displayed in text format.
FALSE The content is displayed in text format.
The attribute can be assigned dynamic properties by means of the name
TimeColumnHideText. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 615
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeColumnHideTitleText property
TimeColumnHideTitleText
Sets text format for displaying the time column header.
Value Explanation
TRUE The header is not displayed in text format.
FALSE The header is displayed in text format.
The attribute can be assigned dynamic properties by means of the name
TimeColumnHideTitleText. The data type is BOOLEAN.
TimeColumnIndex property
TimeColumnIndex
References a configured time column. Using this attribute you can assign the values of other
attributes to a specific time column.
Values between 0 and "TimeColumnCount" minus 1 are valid for "TimeColumnIndex". Attribute
"TimeColumnCount" defines the number of time columns configured.
The "TimeColumnIndex" attribute can be assigned dynamic properties by means of attribute
TimeColumnRepos. The data type is LONG.
TimeColumnLength property
Length in characters - TimeColumnLength
Specifies the width of a selected time column.
The attribute can be assigned dynamic properties by means of the name TimeColumnLength.
The data type is LONG.
TimeColumnMeasurePoints property
Number of measurement points - TimeColumnMeasurePoints
Defines the number of measurement points to be displayed in the time column selected.
The attribute can be assigned dynamic properties by means of the name
TimeColumnMeasurePoints. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
616 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeColumnName property
Object name - TimeColumnName
Specifies the name of a selected time column.
The "TimeColumnName" attribute can be assigned dynamic properties by means of attribute
TimeColumnRename. The data type is STRING.
TimeColumnRangeType property
Time range setting - TimeColumnRangeType
Defines the time range setting for the time column selected.
Value Description Explanation
0 Time range Defines the start time and time range of the time column.
1 Start to end time Defines the start and end time for the time column.
2 Number of measurement points Defines the start time and the number of measurement points for the time
column.
The attribute can be assigned dynamic properties by means of the name
TimeColumnRangeType. The data type is LONG.
TimeColumnRemove property
Remove - TimeColumnRemove
Removes the selected time column from the list.
The attribute can be assigned dynamic properties by means of the name
TimeColumnRemove. The data type is STRING.
TimeColumnRename property
TimeColumnRename
Renames a time column which is referenced by means of "TimeColumnIndex" attribute.
The attribute can be assigned dynamic properties by means of the name
TimeColumnRename. "TimeColumnRename" also sets a dynamic attribute
"TimeColumnName". The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 617
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeColumnRepos property
Up/Down - TimeColumnRepos
Repositions the order of time columns and of corresponding value columns. "Up" and "Down"
move the time column selected up or down in the list. This moves the time column and
corresponding value columns in the table towards the front or towards the back.
The attribute can be assigned dynamic properties by means of the name TimeColumnRepos.
The data type is LONG.
TimeColumnShowDate property
Show date - TimeColumnShowDate
Enables the display of the date and time in the time column selected.
Value Explanation
TRUE Date and time are displayed. The date format is defined in the "Date format" field or by using "TimeCo‐
lumnDateFormat".
FALSE The date is not displayed. Only the time is displayed.
The attribute can be assigned dynamic properties by means of the name
TimeColumnShowDate. The data type is BOOLEAN.
TimeColumnShowIcon property
TimeColumnShowIcon
Enables the display of time column contents as icon. This function is only available in WinCC
Alarm Control.
Value Explanation
TRUE The content is visualized as icon.
FALSE The content is not visualized as icon.
The attribute can be assigned dynamic properties by means of the name
TimeColumnShowIcon. The data type is BOOLEAN.
TimeColumnShowTitleIcon property
TimeColumnShowTitleIcon
Enables display of the time column header as icon. This function is only available in WinCC
Alarm Control.
Value Explanation
TRUE The header is displayed as icon.
FALSE The header is not displayed as icon.
WinCC: Scripting (VBS, ANSI-C, VBA)
618 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name
TimeColumnShowTitleIcon. The data type is BOOLEAN.
TimeColumnSort property
TimeColumnSort
Defines the sorting order of the time column referenced in "TimeColumnIndex" .
The following settings are available:
Value Description Explanation
0 No No sorting
1 Ascending Ascending order, starting at the lowest value.
2 Descending Descending order, starting at the highest value.
The attribute can be assigned dynamic properties by means of the name TimeColumnSort .
The data type is LONG.
TimeColumnSortIndex property
TimeColumnSortIndex
Defines the sorting order of the time column referenced in "TimeColumnIndex". The sorting
criterion is removed from "TimeColumnSort" if you set a "0" value..
The attribute can be assigned dynamic properties by means of the name
TimeColumnSortIndex. The data type is LONG.
TimeColumnTimeFormat property
Time format - TimeColumnTimeFormat
Defines the time format for visualizing a selected time column.
The following time formats are available:
Value Explanation
Automatic The time format is set automatically.
HH:mm:ss.ms Hours:Minutes:Seconds, e.g. 15:35:44.240.
hh:mm:ss tt Hours:Minutes:Seconds AM/PM, e.g. 03:35:44 PM.
hh:mm:ss.ms tt Hours:Minutes:Seconds.Milliseconds AM/PM, e.g. 03:35:44.240 PM.
The attribute can be assigned dynamic properties by means of the name
TimeColumnTimeFormat. The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 619
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeColumnTimeRangeBase property
Time range - TimeColumnTimeRangeBase
Defines the time unit for calculating the time range.
The following time units are available:
Value Description
500 500 ms
1000 1 second
60000 1 minute
3600000 1 hour
86400000 1 day
The attribute can be assigned dynamic properties by means of the name
TimeColumnTimeRangeBase. The data type is LONG.
TimeColumnTimeRangeFactor property
Time range - TimeColumnTimeRangeFactor
Defines the factor for calculating the time range. Only integer factors are valid.
The attribute can be assigned dynamic properties by means of the name
TimeColumnTimeRangeFactor. The data type is SHORT.
TimeColumnUseValueColumnColors property
Use value column colors - TimeColumnUseValueColumnColors
Defines whether the selected time column will be displayed in the value column colors.
Value Explanation
TRUE The colors of the value column are used to display a selected time column. The settings in the "Font color"
and "Background color" fields are disabled.
FALSE The colors defined in the "Font color" and "Background color" fields are used to display the selected time
column.
The attribute can be assigned dynamic properties by means of the name
TimeColumnUseValueColumnColors. The data type is BOOLEAN.
TimeColumnVisible property
Time columns - TimeColumnVisible
The list shows the time columns you created. Click a time column entry in the list to adapt the
properties and to define the time range of the time column.
WinCC: Scripting (VBS, ANSI-C, VBA)
620 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Select the time columns to be displayed in the table from the list.
Defines whether the selected time column is displayed.
The attribute can be assigned dynamic properties by means of the name TimeColumnVisible.
The data type is BOOLEAN.
TimeFormat - Tolerance
TimeFormat Property
Description
Defines the format of the time specification.
● 0: The information is provided in hh:mm
● -1: The information is provided in hh:mm:ss
● -2: The information is provided in hh:mm:ss.ms
● -3: The information is provided in hh:mm (full hours)
● -4: The information is provided in hh:mm:ss (full minutes)
● -5: The information is provided in hh:mm:ss.ms (full seconds)
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
TimeJump Property
Description
WinCC Online Trend Control
The "Index" property references a trend. "TimeJump" defines whether the time jumps in the
archive should be identified by the color defined in "TimeJumpColor".
WinCC Online Trend Control
The value of this attribute cannot be changed. Read only access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 621
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeJumpColor Property
Description
WinCC Online Trend Control
The "Index" property references a trend. "TimeJumpColor" defines the color identifying the
time jumps in the archive. Whether the information is evaluated is dependent on the value of
the "TimeJump" property. The color is defined as an RGB value. LONG write-read access.
WinCC Online Trend Control
The value of this property cannot be changed. Read only access.
See also
ScreenItem Object (Page 123)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
TimeOverlap Property
Description
WinCC Online Trend Control
The "Index" property references a trend. "TimeOverlap" defines whether the time overlaps in
the archive should be identified by the color defined in "TimeOverlapColor".
WinCC Online Trend Control
The value of this property cannot be changed. Read only access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
TimeOverlapColor Property
Description
WinCC Online Trend Control
The "Index" property references a trend. "TimeOverlapColor" defines the color identifying the
time overlaps in the archive. Whether the information is evaluated depends on the value of the
"TimeOverlap" attribute. The color is defined as an RGB value.
WinCC: Scripting (VBS, ANSI-C, VBA)
622 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
WinCC Online Trend Control
The value of this property cannot be changed. Read only access.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
ScreenItem Object (Page 123)
TimeRange Property
Description
The "Index" property references a column pair or a trend. "TimeRange" defines how the time
range to be displayed should be defined.
● 0: The time range to be displayed is defined by a start time ("BeginTime") and end time
("EndTime").
● -1: The time range to be displayed is defined by a start time ("BeginTime") and a time range
("TimeRangeBase" and "TimeRangeFactor").
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
TimeRangeBase Property
Description
The "Index" property references a column pair or a trend. The time range to be displayed for
this column pair/trend results from multiplying the values "TimeRangeBase" and
"TimeRangeFactor", whereby the value "TimeRangeBase" is interpreted in milliseconds.
The "TimeRangeBase" and "TimeRangeFactor" properties are only evaluated when the
"TimeRange" property is set, i.e. has the value "-1".
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 623
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeRangeFactor Property
Description
The "Index" property references a column pair or a trend. The time range to be displayed for
this column pair/trend results from multiplying the values "TimeRangeBase" and
"TimeRangeFactor", whereby the value "TimeRangeBase" is interpreted in milliseconds.
The "TimeRangeBase" and "TimeRangeFactor" properties are only evaluated when the
"TimeRange" property is set, i.e. has the value "-1".
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
TimeStamp Property
Description
Reads the time stamp of the last read access of a tag. The time stamp is returned in local time.
DATE (read only)
The VBS standard function "FormatDateTime(Date[, NamedFormat])" enables the time stamp
property to be output in plain text. The output is dependent on the current language setting.
The language setting can be set using the VBS standard function SetLocale().
By implementing the second parameter of the FormatDate() function and further VBS standard
functions such as Year, WeekDay, Day, Hour, Minute, Second enable the information, required
by the user, to be split. Use the WeekdayName function to receive the name of the weekday
for WeekDay.
WinCC: Scripting (VBS, ANSI-C, VBA)
624 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
'VBS87
Dim objTag
Dim lngCount
lngCount = 0
Set objTag = HMIRuntime.Tags("Tag11")
objTag.Read
SetLocale("en-gb")
MsgBox FormatDateTime(objTag.TimeStamp) 'Output: e.g. 06/08/2002 9:07:50
MsgBox Year(objTag.TimeStamp) 'Output: e.g. 2002
MsgBox Month(objTag.TimeStamp) 'Output: e.g. 8
MsgBox Weekday(objTag.TimeStamp) 'Output: e.g. 3
MsgBox WeekdayName(Weekday(objTag.TimeStamp)) 'Output: e.g. Tuesday
MsgBox Day(objTag.TimeStamp) 'Output: e.g. 6
MsgBox Hour(objTag.TimeStamp) 'Output: e.g. 9
MsgBox Minute(objTag.TimeStamp) 'Output: e.g. 7
MsgBox Second(objTag.TimeStamp) 'Output: e.g. 50
For lngCount = 0 To 4
MsgBox FormatDateTime(objTag.TimeStamp, lngCount)
Next
'lngCount = 0: Output: e.g. 06/08/2002 9:07:50
'lngCount = 1: Output: e.g. 06 August 2002
'lngCount = 2: Output: e.g. 06/08/2002
'lngCount = 3: Output: e.g. 9:07:50
'lngCount = 4: Output: e.g. 9:07
Example:
The following example issues the time stamp of the tag "Tag1":
'VBS88
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read
MsgBox objTag.TimeStamp
See also
Tag Object (Page 135)
Alarms object (list) (Page 108)
TimeStepBase property
Precision - TimeStepBase
Defines the precision of the time stamp displayed in a table.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 625
VBS for Creating Procedures and Actions
1.14 VBS Reference
Calculate the precision by multiplying the factor with the time unit. Enter factor "3" and time
unit "1s" to display all values which were generated within 3 seconds in the same row, for
example.
Value Description Explanation
0 Exact Only values with precisely the same time stamp are displayed in a table
row.
100 100 ms All values generated within 100 milliseconds are grouped in a table row.
250 250 ms All values generated within 250 milliseconds are grouped in a table row.
500 500 ms All values generated within 500 milliseconds are grouped in a table row.
1000 1s All values generated within 1 second are grouped in a table row.
The attribute can be assigned dynamic properties by means of the name TimeStepBase. The
data type is LONG.
TimeStepFactor property
Precision - TimeStepFactor
Defines the precision of the time stamp displayed in a table.
Calculate the precision by multiplying the factor with the time unit. Enter factor "3" and time
unit "1s" to display all values which were generated within 3 seconds in the same row.
The factor entered is disabled if "Exact" is selected for the time unit or "0" is selected for
"TimeStepBase".
The attribute can be assigned dynamic properties by means of the name TimeStepFactor. The
data type is LONG.
TimeZone Property
Description
Defines the time zone used as a basis for displaying time values. Four settings are possible:
● Local time zone
● Server's time zone
● UTC (Universal Time Coordinated)
● Apply project settings (=> Use WinCC Explorer and access the computer's properties page
to define the time mode specifically for the computer. The following are available for
selection: WinCC V50 (Compatibility mode => Display as was standard in the individual
display sections to V5 ), local time and UTC.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC: Scripting (VBS, ANSI-C, VBA)
626 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
TitleColor property
Table header background - TitleColor
Specifies the background color of the table headers. The button opens the "Color selection"
dialog.
The attribute can be assigned dynamic properties by means of the name TitleColor. The data
type is LONG.
TitleCut property
Shorten contents - TitleCut
Truncates the content of column headers if the column is insufficient.
Value Explanation
TRUE The column headers are truncated.
FALSE The column headers are not truncated.
The attribute can be assigned dynamic properties by means of the name TitleCut . The data
type is BOOLEAN.
TitleCut property (before WinCC V7)
Description
Defines whether the content of the fields of a title bar should be shortened if the column width
is too small. Write/Read access.
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
TitleDarkShadowColor property
Dark shading color - TitleDarkShadowColor
Specifies the color of the dark side of shading. The button opens the "Color selection" dialog.
The setting is only active if the "Shading Color" option or "TitleStyle" is activated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 627
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name
TitleDarkShadowColor. The data type is LONG.
TitleForeColor property
Table header font color - TitleForeColor
Specifies the color of the table header. The button opens the "Color selection" dialog.
The attribute can be assigned dynamic properties by means of the name TitleForeColor. The
data type is LONG.
TitleGridLineColor property
Color of the divider / header - TitleGridLineColor
Defines the color of row/column dividers in the table header. The button opens the "Color
selection" dialog.
The attribute can be assigned dynamic properties by means of the name TitleGridLineColor.
The data type is LONG.
TitleLightShadowColor property
Bright shading color - TitleLightShadowColor
Specifies the color of the bright side of shading. The button opens the "Color selection" dialog.
The setting is only active if the "Shading Color" option or "TitleStyle" is activated.
The attribute can be assigned dynamic properties by means of the name
TitleLightShadowColor. The data type is LONG.
Titleline Property
Description
TRUE, when the control has a title bar and it can be moved in Runtime. BOOLEAN write-read
access.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
WinCC: Scripting (VBS, ANSI-C, VBA)
628 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
TitleSort property
Sort by column title- TitleSort
Defines how to trigger sorting by column title. You can only sort by column title if the "Auto-
scrolling" option is deactivated.
Value Description Explanation
0 No Sorting by column title is not possible.
1 With click Sorting is triggered by clicking in the column header.
2 With double-click Sorting is triggered by double-clicking in the column title.
The attribute can be assigned dynamic properties by means of the name TitleSort. The data
type is LONG.
TitleStyle property
Shading color - TitleStyle
Specifies whether to set a shading color for the table header.
Value Description Explanation
0 Flat Disables the use of shading colors. Flat header style.
1 Button Enables the use of shading colors. 3D representation of the header.
The attribute can be assigned dynamic properties by means of the name TitleStyle. The data
type is LONG.
Toggle Property
Description
TRUE, when the button or round button should lock after being operated in Runtime.
BOOLEAN write-read access.
See also
Round Button (Page 207)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 629
VBS for Creating Procedures and Actions
1.14 VBS Reference
ToleranceHigh Property
Description
Defines or returns the limit value for "Tolerance high".
The type of the evaluation (in percent or absolute) is defined in the "TypeToleranceHigh"
property.
The monitoring of the limit value is only valid if the "CheckToleranceHigh" property is set to
"TRUE".
See also
Bar (Page 172)
ScreenItem Object (Page 123)
ToleranceLow Property
Description
Defines or returns the limit value for "Tolerance low".
The type of the evaluation (in percent or absolute) is defined in the "TypeToleranceLow"
property.
The monitoring of the limit value is only valid if the "CheckToleranceLow" property is set to
"TRUE".
See also
Bar (Page 172)
ScreenItem Object (Page 123)
Toolbar
Toolbar Property
Description
TRUE, when a toolbar is to be displayed. BOOLEAN write-read access.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
WinCC: Scripting (VBS, ANSI-C, VBA)
630 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
ToolbarAlignment property (before WinCC V7)
Description
Defines or returns the position of the toolbar. Write/Read access.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
ToolbarAlignment Property
Alignment - ToolbarAlignment
Defines the orientation of the Control toolbar.
The following settings are available:
Value Description Explanation
0 Top The toolbar is aligned to the top edge.
1 Bottom The toolbar is aligned to the bottom edge.
2 Left The toolbar is aligned to the left edge.
3 Right The toolbar is aligned to the right edge.
The attribute can be assigned dynamic properties by means of the name ToolbarAlignment.
The data type is LONG.
ToolbarBackColor property
Background color - ToolbarBackColor
Specifies the background color of the toolbar. Open the "Color selection" dialog by clicking the
button.
The background color you configured is only displayed if the "Display" option is activated or
"ToolbarUseBackColor" is "TRUE".
The attribute can be assigned dynamic properties by means of the name ToolbarBackColor.
The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 631
VBS for Creating Procedures and Actions
1.14 VBS Reference
ToolbarButtonActive property
Active - ToolbarButtonActive
Activates a button function in Runtime. Clicking the button in Runtime triggers the
corresponding function.
Value Explanation
TRUE The button function is enabled.
FALSE The button function is disabled. You can assign custom functions to the button by means of scripting.
The attribute can be assigned dynamic properties by means of the name
ToolbarButtonActive. The data type is BOOLEAN.
ToolbarButtonAdd property
New - ToolbarButtonAdd
Creates a new, user-defined button function. The name set by WinCC can be edited in the
"Object name" field.
The attribute can be assigned dynamic properties by means of the name ToolbarButtonAdd .
The data type is STRING.
ToolbarButtonBeginGroup property
Separator - ToolbarButtonBeginGroup
Inserts a leading separator (vertical line) for the selected button function on the toolbar. These
separators can be used to group the icons of the button functions.
Value Explanation
TRUE A separator prefix is inserted for the button function selected.
FALSE A separator prefix is not inserted for the button function selected.
The attribute can be assigned dynamic properties by means of the name
ToolbarButtonBeginGroup. The data type is BOOLEAN.
ToolbarButtonClick AlarmControl property
ToolbarButtonClick
Triggers the function linked to the toolbar button. Programmers can use the "ID" to call the
corresponding button function.
ID Button function ID Button function
1 "Help" 21 "Next message"
WinCC: Scripting (VBS, ANSI-C, VBA)
632 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
2 "Configuration dialog" 22 "Last message"
3 "Message list". 23 "Info text dialog"
4 "Short-term archive list". 24 "Comments dialog"
5 "Long-term archive list" 25 "Loop In Alarm"
6 "Lock List". 26 "Lock message"
7 "Hit List" 27 "Enable message"
8 "List of messages to be hidden" 28 "Hide messages"
9 "Ackn. Central Signaling Devices" 29 'Unhide messages"
10 "Single acknowledgment" 30 "Sort dialog"
11 "Group acknowledgement" 31 "Time base dialog"
18 "Emergency acknowledgement" 32 "Copy rows"
13 "Selection dialog" 33 "Connect backup"
14 "Display options dialog" 34 "Disconnect backup"
15 "Lock dialog" 36 "First page"
17 "Print" 37 "Previous page"
35 "Export data" 38 "Next page"
12 "Autoscroll" 39 "Last page"
19 "First message" 1001 "User-defined 1"
20 "Previous message"
The attribute can be assigned dynamic properties by means of the name ToolbarButtonClick.
The data type is LONG.
ToolbarButtonClick FunctionTrendControl property
ToolbarButtonClick
Triggers the function linked to the toolbar button. Programmers can use the "ID" to call the
corresponding button function.
ID Button function ID Button function
1 "Help" 13 "Select time range"
2 "Configuration dialog" 14 "Previous trend"
4 "Zoom area" 15 "Next trend"
5 "Zoom +/-" 16 "Stop"
6 "Zoom X axis +/-" 16 "Start"
7 "Zoom Y axis +/-" 17 "Print"
8 "Shift trend range" 20 "Export data"
9 "Shift axes range" 3 "Ruler"
10 "Original view" 18 "Connect backup"
11 "Select data connection" 19 "Disconnect backup"
12 "Select trends" 1001 "User-defined 1"
The attribute can be assigned dynamic properties by means of the name ToolbarButtonClick.
The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 633
VBS for Creating Procedures and Actions
1.14 VBS Reference
ToolbarButtonClick OnlineTableControl property
ToolbarButtonClick
Triggers the function linked to the toolbar button. The respective button function is called via
the "ID".
The attribute can be assigned dynamic properties by means of the name ToolbarButtonClick.
The data type is LONG.
ID / Button function ID / Button function
1 = Help 13 = Next column
2 = Configuration dialog 14 = Start/stop
3 = First data record 15 = Print
4 = Previous data record 16 = Define statistics area
5 = Next data record 17 = Calculate statistics
6 = Last data record 18 = Connect backup
7 = Edit 19 = Disconnect backup
8 = Copy rows 20 = Export data
9 = Select data connection 21 = Create archive value
10 = Select columns 22 = Select filter
11 = Select time range as of 1001 = User-defined
12 = Previous column
ToolbarButtonClick OnlineTrendControl property
ToolbarButtonClick
Triggers the function linked to the toolbar button. Programmers can use the "ID" to call the
corresponding button function.
ID Button function ID Button function
1 "Help" 17 "Select time range"
2 "Configuration dialog" 18 "Previous trend"
3 "First data record" 19 "Next trend"
4 "Previous data record" 20 "Stop"
5 "Next data record" 20 "Start"
6 "Last data record" 21 "Print"
8 "Zoom area" 26 "Export data"
9 "Zoom +/-" 7 "Ruler"
10 "Zoom time axis +/-" 22 "Define statistics area"
11 "Zoom value axis +/-" 23 "Calculate statistics"
12 "Shift trend range" 24 "Connect backup"
13 "Shift axes range" 25 "Disconnect backup"
14 "Original view" 27 "Relative axis"
15 "Select data connection" 1001 "User-defined 1"
16 "Select trends"
WinCC: Scripting (VBS, ANSI-C, VBA)
634 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name ToolbarButtonClick.
The data type is LONG.
ToolbarButtonClick RulerControl property
ToolbarButtonClick
Triggers the function linked to the toolbar button. Programmers can use the "ID" to call the
corresponding button function.
ID Button function
1 "Help"
2 "Configuration dialog"
3 "Ruler window"
4 "Statistics range"
5 "Statistics"
6 "Print"
7 "Export data"
1001 "User-defined 1"
The attribute can be assigned dynamic properties by means of the name ToolbarButtonClick.
The data type is LONG.
ToolbarButtonClick SysdiagControl property
ToolBarButtonClick
Triggers the function linked to the toolbar button. Programmers can use the "ID" to call the
corresponding button function.
ID Button function
1 "Configuration dialog"
2 "Overview"
3 "Back"
4 "Open"
5 "Diagnostics buffer"
6 "Update diagnostic buffer"
7 "Sort dialog"
8 "Print"
9 "Export data"
The attribute can be assigned dynamic properties using the name ToolbarButtonClick. The
data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 635
VBS for Creating Procedures and Actions
1.14 VBS Reference
ToolbarButtonClick UserAdminControl property
ToolbarButtonClick
Triggers the function linked to the toolbar button. Programmers can use the "ID" to call the
corresponding button function.
ID Button function ID Button function
1 "Help" 9 "Log on"
2 "Configuration dialog" 10 "Log off"
3 "Group list" 11 "Change password"
4 "User list" 12 "Import user administration"
5 "Edit" 13 "Export user administration"
6 "Add" 14 "Sort dialog"
7 "Authorization levels" 15 "Print"
8 "Delete" 16 "Export data"
The attribute can be assigned dynamic properties using the name ToolbarButtonClick. The
data type is LONG.
ToolbarButtonClick UserArchiveControl property
ToolbarButtonClick
Triggers the function linked to the toolbar button. Programmers can use the "ID" to call the
corresponding button function.
ID Button function ID Button function
1 "Help" 12 "Read tags"
2 "Configuration dialog" 13 "Write tags"
3 "Select data connection" 14 "Import archive"
4 "First row" 15 "Export archive"
5 "Previous row" 16 "Sort dialog"
6 "Next row" 17 "Selection dialog"
7 "Last row" 18 "Print"
8 "Delete rows" 20 "Export data"
9 "Cut rows" 19 "Time base dialog"
10 "Copy rows" 1001 "User-defined 1"
11 "Insert rows"
The attribute can be assigned dynamic properties by means of the name ToolbarButtonClick.
The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
636 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ToolbarButtonCount property
ToolbarButtonCount
Defines the number of configurable button functions.
The attribute can be assigned dynamic properties by means of the name
ToolbarButtonCount. The data type is LONG.
ToolbarButtonEnabled property
ToolbarButtonEnabled
Enables operation of custom toolbar buttons.
The attribute can be assigned dynamic properties by means of the name
ToolbarButtonEnabled. The data type is BOOLEAN.
ToolbarButtonHotKey property
Hotkey - ToolbarButtonHotKey
Shows the hotkey for a button function selected.
You create or edit a hotkey by clicking in the "Hotkey" field and pressing the button or key
shortcut required.
The attribute can be assigned dynamic properties by means of the name
ToolbarButtonHotKey. The data type is LONG.
ToolbarButtonID property
Object ID - ToolbarButtonID
Unique ID number for the selected button function. WinCC assigns this read only ID number.
The attribute can be assigned dynamic properties by means of the name ToolbarButtonID.
The data type is LONG.
ToolbarButtonIndex property
ToolbarButtonIndex
References a button function. Using this attribute you can assign the values of other attributes
to a specific button function.
Values between 0 and "ToolbarButtonIndex" minus 1 are valid for "ToolbarButtonCount".
Attribute "ToolbarButtonCount" defines the number of configurable button functions.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 637
VBS for Creating Procedures and Actions
1.14 VBS Reference
The "ToolbarButtonIndex" attribute can be assigned dynamic properties by means of attribute
ToolbarButtonRepos. The data type is LONG.
ToolbarButtonLocked property
ToolbarButtonLocked
Enables/disables the display of the pressed state of a user-defined toolbar button.
The attribute can be assigned dynamic properties by means of the name
ToolbarButtonLocked. The data type is BOOLEAN.
ToolbarButtonName property
Object name - ToolbarButtonName
Shows the name for the selected button function. You rename user-defined button functions.
The "ToolbarButtonName" attribute can be assigned dynamic properties by means of attribute
ToolbarButtonRename. The data type is STRING.
ToolbarButtonPasswordLevel property
Operator authorization - ToolbarButtonPasswordLevel
Shows the authorization for a button function selected. You can edit the authorization using
the selection button.
Authorizations are configured in the "User Administrator" editor.
The attribute can be assigned dynamic properties by means of the name
ToolbarButtonPasswordLevel. The data type is LONG.
ToolbarButtonRemove property
Remove - ToolbarButtonRemove
Removes the selected button function from the list. Only user-defined button functions can be
removed.
The attribute can be assigned dynamic properties by means of the name
ToolbarButtonRemove. The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
638 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ToolbarButtonRename property
ToolbarButtonRename
Renames a custom toolbar element which is referenced by means of "ToolbarButtonIndex"
attribute.
The attribute for custom elements can be assigned dynamic properties by means of the name
ToolbarButtonRename. "ToolbarButtonRename" also sets a dynamic attribute
"ToolbarButtonName". The data type is STRING.
ToolbarButtonRepos property
Up/Down - ToolbarButtonRepos
Changes the sorting order of button functions. "Up" and "Down" move the button function
selected up or down in the list. This moves the button function in the toolbar of a Control towards
the front or towards the back.
The attribute can be assigned dynamic properties by means of the name
ToolbarButtonRepos. The data type is LONG.
ToolbarButtonSize property
Button size in pixels - ToolbarButtonSize
Defines the size of the buttons in the toolbar.
With the maximum value of 280 pixels, the button size can be ten times larger than the original
size of 28 pixels.
The following behavior results for the button size depending on the configured value:
Value of the button size Behavior
Value < 0 Invalid value. The most recent valid value is used.
0 ≤ value ≤ original size of button The original size of the button is used. "Toolbar‐
ButtonSize" is set to the default (= 0).
Original size of the button < value ≤ maximum val‐ The configured value is used.
ue
Maximum value < value Invalid value. The most recent valid value is used.
With a large button size, please note that in some cases not all buttons may be displayed in
the control. To show all activated buttons in Runtime, you must therefore extend the control
or activate fewer buttons as required.
You can create a dedicated button to zoom in or out of the toolbar in Runtime. For instructions,
refer to the example "How to configure a user-defined toolbar button with a self-created
selection dialog" in the documentation "VBS for Creating Procedures and Actions".
The attribute can be assigned dynamic properties by means of the name ToolbarButtonSize .
The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 639
VBS for Creating Procedures and Actions
1.14 VBS Reference
ToolbarButtonTooltipText property
ToolbarButtonTooltipText
Specifies the tooltip text for the button.
The attribute can be assigned dynamic properties by means of the name
ToolbarButtonTooltipText. The data type is STRING.
ToolbarButtonUserDefined property
ToolbarButtonUserDefined
Indicates whether the project engineer has added a new user-defined toolbar button.
Value Explanation
TRUE The toolbar button is assigned a user-defined function.
FALSE The toolbar button is defined by the system.
The attribute can be assigned dynamic properties by means of the name
ToolbarButtonUserDefined. The data type is BOOLEAN.
ToolbarButtonVisible property
Button functions - ToolbarButtonVisible
Select the button functions to be displayed in the toolbar from the list.
Click a list entry to adapt the properties, or to change the position in the status bar of the Control
by means of the "Up" and "Down" buttons.
The attribute can be assigned dynamic properties by means of the name
ToolbarButtonVisible . The data type is BOOLEAN.
ToolbarButtons Property
Description
Defines or returns the buttons contained in the toolbar by setting or resetting the corresponding
bits. Each button is assigned a bit. There are no limitations as to the bit combinations.
Bit - Value (hex) ; Value (dec) ; Button:
● 0 - 0x00000001; 1; Message List
● 1 - 0x00000002; 2; Short-term archive list
● 2 - 0x00000004; 4; Long-term archive list
● 3 - 0x00000008; 8; Acknowledgment of central signaling device
● 4 - 0x00000010; 16; Single Acknowledgment
WinCC: Scripting (VBS, ANSI-C, VBA)
640 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
● 5 - 0x00000020; 32; Group acknowledgment
● 6 - 0x00000040; 64; Autoscroll
● 7 - 0x00000080; 128; Selection Dialog
● 8 - 0x00000100; 256; Lock Dialog
● 9 - 0x00000200; 512; Print message log
● 11 - 0x00000800; 2048; Emergency acknowledgment
● 12 - 0x00001000; 4096; First message
● 13 - 0x00002000; 8192; Last message
● 14 - 0x00004000; 16384; Next message
● 15- 0x00008000; 32768; Previous message
● 16 - 0x00010000; 65536; Infotext Dialog
● 17 -0x00020000; 131072; Comment Dialog
● 18 - 0x00040000; 262144; Loop in Alarm
● 20 - 0x00100000; 1048576; Print current view
● 21 - 0x00200000; 2097152; Lock list
● 22 - 0x00400000; 4194304; Lock/release message
● 23 - 0x00800000; 8388608; Sorting Dialog
● 24 - 0x01000000; 16777216; Time basis dialog
● 25 - 0x02000000; 33554432; Hit list
In order to display more buttons, their values must be logically linked with OR. Write/Read
access.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
ToolbarHotKeys Property
Description
Defines or returns hotkeys of the buttons in the toolbar. Write/Read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 641
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
ToolbarShowTooltips property
Tooltips - ToolbarShowTooltips
Enables the display of tooltips for the button functions in Runtime.
Value Explanation
TRUE Enables the display of tooltips.
FALSE Disables the display of tooltips.
The attribute can be assigned dynamic properties by means of the name
ToolbarShowTooltips. The data type is BOOLEAN.
Attribute "ToolbarButtonTooltipText" defines the tooltip text.
ToolbarUseBackColor property
Show background color - ToolbarUseBackColor
Enables the display of the background color for a toolbar.
Value Explanation
TRUE Enables the display of the background color of a toolbar.
FALSE Disables the display of the background color of a toolbar.
The attribute can be assigned dynamic properties by means of the name
ToolbarUseBackColor. The data type is BOOLEAN.
ToolbarUseHotKeys property
Hotkeys - ToolbarUseHotKeys
Activates the hotkeys for button functions in Runtime. Insert the hotkeys for button functions
in the "Hotkey" field.
Value Explanation
TRUE The hotkeys are activated.
FALSE The hotkeys are deactivated.
WinCC: Scripting (VBS, ANSI-C, VBA)
642 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name
ToolbarUseHotKeys. The data type is BOOLEAN.
ToolbarVisible property
Show toolbar - ToolbarVisible
Enables the display of the Control toolbar.
Value Explanation
TRUE Enables the display of the toolbar.
FALSE Disables the display of the toolbar.
The attribute can be assigned dynamic properties by means of the name ToolbarVisible . The
data type is BOOLEAN.
ToolTip - TrendLower
ToolTipText Property
Description
Defines or returns the text to be displayed as a tooltip when the mouse is positioned over the
object.
STRING (write-read access)
Example:
The following example assigns a tool tip text to every object in the picture "NewPDL1": The
picture "NewPDL1" comprises only objects containing the ToolTipText property:
'VBS89
Dim objScreen
Dim objScrItem
Dim lngIndex
Dim strName
lngIndex = 1
Set objScreen = HMIRuntime.Screens("NewPDL1")
For lngIndex = 1 To objScreen.ScreenItems.Count
strName = objScreen.ScreenItems(lngIndex).ObjectName
Set objScrItem = objScreen.ScreenItems(strName)
'
'Assign tooltiptexts to the objects
objScrItem.ToolTipText = "Name of object is " & strName
Next
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 643
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Radio box (Page 205)
Status display (Page 197)
Connector (Page 165)
Text list (Page 194)
Static text (Page 163)
Slider (Page 210)
Group Display (Page 192)
Rounded rectangle (Page 160)
Round Button (Page 207)
Rectangle (Page 157)
Polyline (Page 156)
Polygon (Page 154)
OLE object (Page 189)
Line (Page 152)
Pie segment (Page 150)
Circular arc (Page 149)
Circle (Page 147)
Group (Page 296)
Graphic Object (Page 185)
Ellipse segment (Page 145)
Ellipse arc (Page 144)
Ellipse (Page 142)
I/O Field (Page 182)
Check box (Page 202)
Button (Page 199)
Bar (Page 172)
Customized Object (Page 294)
3D Bar (Page 167)
Top Property
Function
Defines or returns the Y-coordinate of an object (measured from the top left edge of the picture)
in pixels. The Y-coordinate relates to the top left corner of the rectangle enclosing the object.
WinCC: Scripting (VBS, ANSI-C, VBA)
644 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
LONG (write-read access)
Example:
The following example shifts all objects in the picture "NewPDL1" 5 pixels upwards:
'VBS90
Dim objScreen
Dim objScrItem
Dim lngIndex
Dim strName
lngIndex = 1
Set objScreen = HMIRuntime.Screens("NewPDL1")
For lngIndex = 1 To objScreen.ScreenItems.Count
strName = objScreen.ScreenItems(lngIndex).ObjectName
Set objScrItem = objScreen.ScreenItems(strName)
objScrItem.Top = objScrItem.Top - 5
Next
See also
Left Property (Page 477)
ScreenItem Object (Page 123)
TopConnectedConnectionPointIndex Property
Description
Specifies or sets the index number of the top connecting point.
LONG write-read access.
See also
Connector (Page 165)
ScreenItem Object (Page 123)
TopConnectedObjectName Property
Description
Specifies or sets the object name of the object which is docked on at the bottom connecting
point.
LONG write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 645
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Connector (Page 165)
ScreenItem Object (Page 123)
Transparency property
Description
Defines and returns the percentage transparency of the object.
0 = no transparency; 100 = complete transparency (invisible)
The text and fields of the graphic objects are only transparent at "100."
In runtime, a completely transparent object (invisible) is also functional.
Transparent Property
Description
TRUE, when the button appears completely filled in the color specified in "BackColor".
BOOLEAN write-read access.
See also
WinCC Push Button Control (up to WinCC V7.3) (Page 291)
ScreenItem Object (Page 123)
Trend Property
Description
TRUE, when the tendency (rising or falling) of the measuring value being monitored should
be displayed by a small arrow. BOOLEAN write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
646 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendActualize property
Update -TrendActualize
Enables the update of a selected trend.
Value Explanation
TRUE Enables updates of the trend selected.
FALSE Disables updates of the trend selected. This setting can be useful when comparing a logged trend with a current
trend.
The attribute can be assigned dynamic properties by means of the name TrendActualize. The
data type is BOOLEAN.
TrendAdd property
New - TrendAdd
Creates a new trend.
The attribute can be assigned dynamic properties by means of the name TrendAdd. The data
type is STRING.
TrendAutoRangeBeginTagName property
TrendAutoRangeBeginTagName
This attribute sets the low limit tag for the range of values if the range of values is calculated
automatically by means of online tags.
The attribute can be assigned dynamic properties by means of the name
TrendAutoRangeBeginTagName. The data type is STRING.
TrendAutoRangeBeginValue property
TrendAutoRangeBeginValue
This attribute sets the low limit tag for the range of values if the range of values is calculated
based on the configuration of high and low limits.
The attribute can be assigned dynamic properties by means of the name
TrendAutoRangeBeginValue. The data type is DOUBLE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 647
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendAutoRangeEndTagName property
TrendAutoRangeEndTagName
This attribute sets the high limit tag for the range of values if the range of values is calculated
automatically by means of online tags.
The attribute can be assigned dynamic properties by means of the name
TrendAutoRangeEndTagName. The data type is STRING.
TrendAutoRangeEndValue property
TrendAutoRangeEndValue
This attribute sets the high limit tag for the range of values if the range of values is calculated
based on the configuration of high and low limits.
The attribute can be assigned dynamic properties by means of the name
TrendAutoRangeEndValue. The data type is DOUBLE.
TrendAutoRangeSource property
TrendAutoRangeSource
Defines the mode for automatic calculation of the range of values of trend data.
Value Description Explanation
0 Display data The range of values is calculated automatically based on the data displayed.
1 Value range The range of values is defined based on its configured low and high limit. The low and high
limits are emulated in the "TrendAutoRangeBeginValue" and "TrendAutoRangeEndValue" at‐
tributes.
2 Online tags The low and high limits of the range of values are derived from the values of connected online
tags. The low and high limits are emulated in the "TrendAutoRangeBeginTagName" and
"TrendAutoRangeEndTagName" attributes.
The attribute can be assigned dynamic properties by means of the name
TrendAutoRangeSource. The data type is LONG.
TrendBeginTime property
Start time - TrendBeginTime
Defines the start time of the time range for data transfer to the selected trend.
The attribute can be assigned dynamic properties by means of the name TrendBeginTime.
The data type is Date.
WinCC: Scripting (VBS, ANSI-C, VBA)
648 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendColor property
Trend color - TrendColor
Specifies the trend color. Open the "Color selection" dialog by clicking the button.
The attribute can be assigned dynamic properties by means of the name TrendColor. The data
type is LONG.
LTrendColor property (before WinCC V7)
Description
Determines the color of the trend display or returns it.
The trend display indicates the tendency (rising or falling) of the measuring value being
monitored by a small arrow. In order to activate the trend display, the Trend property must be
set to "True". LONG write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
TrendCount property
TrendCount
Defines the number of configured trends.
The attribute can be assigned dynamic properties by means of the name TrendCount. The
data type is LONG.
TrendEndTime property
End time - TrendEndTime
Defines the end of the time range for data connections of a selected trend.
The attribute can be assigned dynamic properties by means of the name TrendEndTime. The
data type is Date.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 649
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendExtendedColorSet property
Extended - TrendExtendedColorSet
Enables configuration of the point and fill colors and the display of colors in Runtime.
Value Explanation
TRUE The "Point color" and "Fill color" field settings can be configured and are active in Runtime.
FALSE The "Point color" and "Fill color" field settings cannot be configured and are inactive in
Runtime.
The attribute can be assigned dynamic properties by means of the name
TrendExtendedColorSet. The data type is BOOLEAN.
TrendFill property
Filled - TrendFill
Specifies if the area beneath the trend is to be filled.
Value Explanation
TRUE The area beneath the trend is shown filled. You can define the trend color as fill color if the "Advanced"
option is deactivated.
The text background is displayed in the trend color for the trend type "Values". The background color
of the control is used as text color.
FALSE The trend is not visualized with fill color.
The attribute can be assigned dynamic properties by means of the name TrendFill. The data
type is BOOLEAN.
TrendFillColor property
Fill color - TrendFillColor
Specifies the fill color of the trend. The text fill color is specified for the trend type "Values".
The fill color is used if the "Filled" option is activated or "TrendFill" is "TRUE". Open the "Color
selection" dialog by clicking the button.
The configuration is only possible if the "Advanced" option is activated or
"TrendExtendedColorSet" is "TRUE".
The attribute can be assigned dynamic properties by means of the name TrendFillColor. The
data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
650 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendIndex property
TrendIndex
References a configured trend. Using this attribute you can assign the values of other attributes
to a specific trend. The index must always be set before you change the properties of a trend
in runtime.
Values between 0 and "TrendIndex" minus 1 are valid for "TrendCount". Attribute "TrendCount"
defines the number of trends configured.
The "TrendIndex" attribute can be assigned dynamic properties by means of attribute
TrendRepos. The data type is LONG.
TrendLabel property
Label - TrendLabel
Defines the label of the trend selected. The label is displayed in Runtime if the value at attribute
"UseTrendNameAsLabel" is "FALSE".
The attribute can be assigned dynamic properties by means of the name TrendLabel. The data
type is STRING.
TrendLineStyle property
Line style - TrendLineStyle
Defines the line style for trend visualization.
The following settings are available:
Value Description Explanation
0 Solid The trend is visualized as solid line.
1 Dashed The trend is visualized as dashed line.
2 Dotted The trend is visualized as dotted line.
3 Dash dot The trend is visualized as dot-dash line.
4 Dash Dot Dot The trend is visualized as dash-dot-dot line.
The attribute can be assigned dynamic properties by means of the name TrendLineStyle. The
data type is LONG.
TrendLineType property
Trend type - TrendLineType
Defines how to visualize a trend.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 651
VBS for Creating Procedures and Actions
1.14 VBS Reference
The following settings are available:
Value Description Explanation
0 None Only the dots are displayed.
1 Connect dots Visualizes a trend with linear interconnection of points.
linearly
2 Stepped Visualizes a stepped trend and its interconnected points.
3 Values Can only be configured with OnlineTrendControl.
A value is displayed at each time stamp or at the main grid line of the time axis instead of
trend points.
The attribute can be assigned dynamic properties by means of the name TrendLineType. The
data type is LONG.
TrendLineWidth property
Line weight - TrendLineWidth
Defines the line weight of the line displayed.
The attribute can be assigned dynamic properties by means of the name TrendLineWidth. The
data type is LONG.
TrendLowerLimit property
TrendLowerLimit
Specifies the low limit of a tag. The values are identified based on the color set in
"TrendLowerLimitColor" if the tag value is less than "TrendLowerLimit". This setting is only
active if the value at attribute "TrendLowerLimitColoring" is "TRUE".
The attribute can be assigned dynamic properties by means of the name TrendLowerLimit.
The data type is DOUBLE.
TrendLowerLimitColor property
TrendLowerLimitColor
Specifies the color of tag values which are less than the value at "TrendLowerLimit". This
setting is only active if the value at attribute "TrendLowerLimitColoring" is "TRUE".
The attribute can be assigned dynamic properties by means of the name
TrendLowerLimitColor. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
652 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendLowerLimitColoring property
TrendLowerLimitColoring
Enables the "TrendLowerLimitColor" attribute for identifying tag values which are less than the
value at "TrendLowerLimitValue".
Value Explanation
TRUE Attribute "TrendLowerLimitColor" is active.
FALSE Attribute "TrendLowerLimitColor" is inactive.
The attribute can be assigned dynamic properties by means of the name
TrendLowerLimitColoring. The data type is BOOLEAN.
TrendMeasure - TrendVisible
TrendMeasurePoints property
Number of measurement points - TrendMeasurePoints
Defines the number of measurement points for visualization of selected trends.
Defines the number of value pairs provided to the trend from a user archive.
The attribute can be assigned dynamic properties by means of the name
TrendMeasurePoints. The data type is LONG.
TrendName property
Object name - TrendName
Displays the name of the selected trend. The name is defined on the "Trends" tab.
The "TrendName" attribute can be assigned dynamic properties by means of attribute
TrendRename. The data type is STRING.
TrendPointColor property
Point color - TrendPointColor
Defines the color of trend points. Open the "Color selection" dialog by clicking the button.
The configuration is only possible if the "Advanced" option is activated or
"TrendExtendedColorSet" is "TRUE".
The attribute can be assigned dynamic properties by means of the name TrendPointColor.
The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 653
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendPointStyle property
Dot type - TrendPointStyle
Defines the dot style for trend visualization.
The following settings are available:
Value Description Explanation
0 None The points are not displayed.
1 Dots The trend points are visualized with a size of one pixel. The setting
in the "Dot width" field is deactivated.
2 Squares The dots are displayed as square. The setting in the "Dot width"
field is active.
3 Circles The dots are displayed as circles. The setting in the "Dot width" field
is active.
The attribute can be assigned dynamic properties by means of the name TrendPointStyle. The
data type is LONG.
TrendPointWidth property
Dot width - TrendPointWidth
Sets the dot width in pixels. You can only define the dot width for the "square" and "circular"
type.
The attribute can be assigned dynamic properties by means of the name TrendPointWidth.
The data type is LONG.
TrendProvider property
Data source - TrendProvider
Specifies the data source for a selected trend.
The following settings are available:
Value Description Explanation
0 None No data source configured for implementation in Runtime by means of script.
1 Archive tags Data source with archive tags of a process value archive.
2 Online tags Data source with online tags derived from tag management.
3 User archive Data source with columns of a user archive.
The attribute can be assigned dynamic properties by means of the name TrendProvider. The
data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
654 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendProviderCLSID_FunctionTrend property
TrendProviderCLSID_FunctionTrend
Indicates the data source of the trend selected.
Value Explanation
No data source configured for implementation in Runtime by means of script.
{416A09D2-8B5A-11D2- Data source with archive tags of a process value archive.
8B81-006097A45D48}
{A3F69593-8AB0-11D2- Data source with online tags derived from tag management.
A440-00A0C9DBB64E}
{2DC9B1C8-4FC1-41B1- Data source with columns of a user archive.
B354-3E469A13FBFD}
The attribute can be assigned dynamic properties by means of the name
TrendProviderCLSID. The data type is STRING.
TrendProviderCLSID_OnlineTrend property
TrendProviderCLSID_OnlineTrend
Indicates the data source of the trend selected.
Value Explanation
No data source configured for implementation in Runtime by means of script.
{416A09D2-8B5A-11D2- Data source with archive tags of a process value archive.
8B81-006097A45D48}
{A3F69593-8AB0-11D2- Data source with online tags derived from tag management.
A440-00A0C9DBB64E}
The attribute can be assigned dynamic properties by means of the name
TrendProviderCLSID. The data type is STRING.
TrendRangeType property
Time range setting - TrendRangeType
Defines the time range for providing data to the selected trend.
You can only define the number of measuring points if you select user archives as the data
source.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 655
VBS for Creating Procedures and Actions
1.14 VBS Reference
The following configuration options are available:
Value Description Explanation
0 Time range Defines the start time and the time range for the data connec‐
tion.
1 Start to end time Defines the start and end time for the data connection.
2 Number of measurement Defines the start time and the number of measurement points
points for the data connection.
The attribute can be assigned dynamic properties by means of the name TrendRangeType.
The data type is LONG.
TrendRemove property
Remove - TrendRemove
Removes selected trends from the list.
The attribute can be assigned dynamic properties by means of the name TrendRemove. The
data type is STRING.
TrendRename property
TrendRename
Renames a trend which is referenced by means of "TrendIndex" attribute.
The attribute can be assigned dynamic properties by means of the name TrendRename.
"TrendRename" also sets a dynamic attribute "TrendName". The data type is STRING.
TrendRepos property
Up/Down - TrendRepos
Repositions the trend in the trend window. "Up" and "Down" move the selected trend up or
down in the list. This moves the trend towards the foreground or background for visualization
in Runtime.
The attribute can be assigned dynamic properties by means of the name TrendRepos. The
data type is LONG.
TrendSelectTagName property
TrendSelectTagName
Opens a dialog for selecting the tag name for the source of Y axis data in WinCC
OnlineTrendControl. Programmers can set this attribute to allow users to select a tag name
by means of a button, for example.
WinCC: Scripting (VBS, ANSI-C, VBA)
656 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name
TrendSelectTagName. The data type is BOOLEAN.
TrendSelectTagNameX property
TrendSelectTagNameX
Opens a dialog for selecting the tag name for the source of X axis data in WinCC
FunctionTrendControl. Programmers can set this attribute to allow users to select a tag name
by means of a button, for example.
The attribute can be assigned dynamic properties by means of the name
TrendSelectTagNameX. The data type is BOOLEAN.
TrendSelectTagNameY property
TrendSelectTagNameY
Opens a dialog for selecting the tag name for the source of Y axis data in WinCC
FunctionTrendControl. Programmers can set this attribute to allow users to select a tag name
by means of a button, for example.
The attribute can be assigned dynamic properties by means of the name
TrendSelectTagNameY. The data type is BOOLEAN.
TrendShowAlarms property
Displaying alarms - TrendShowAlarms
If you have connected online tags and activate the "Show alarms" option, you can have the
assigned message displayed as a symbol and tooltip for the trend values with limit violation.
Limit monitoring must be configured in the alarm logging for the online tag for this.
The red symbol indicates a high or low limit violation. The tooltip contains the message text
and information text of the message. If you have configured "Loop in Alarm" with the
"OpenPicture" function for the message, you can jump to the assigned picture by double-
clicking this symbol.
The attribute can be assigned dynamic properties by means of the name TrendShowAlarms.
The data type is BOOLEAN.
TrendState property
TrendState
Shows the status of the data link of the selected curve in Runtime.
The attribute can be made dynamic with the name TrendState. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 657
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendTagName property
Tag name - TrendTagName
Displays the name of connected tags. Use the Open button to open a dialog for selecting an
online or archive tag.
The attribute can be assigned dynamic properties by means of the name TrendTagName. The
data type is STRING.
TrendTagNameX property
Tag Name X / Column X - TrendTagNameX
Shows the name of interconnected tags or of the column for the X axis. Using the selection
button, select a tag or a column for the data source you configured.
The attribute can be assigned dynamic properties by means of the name TrendTagNameX.
The data type is STRING.
TrendTagNameY property
Tag Name Y / Column Y - TrendTagNameY
Shows the name of interconnected tags or of the column for the Y axis. Using the selection
button, select a tag or a column for the data source you configured.
The attribute can be assigned dynamic properties by means of the name TrendTagNameY.
The data type is STRING.
TrendTimeAxis property
Time axis - TrendTimeAxis
Defines the time axis to be used for the trend selected. Define the available time axes in the
"Time axes" tab.
The attribute can be assigned dynamic properties by means of the name TrendTimeAxis. The
data type is STRING.
TrendTimeRangeBase property
Time Range - TrendTimeRangeBase
Defines the time unit for calculating the time range.
WinCC: Scripting (VBS, ANSI-C, VBA)
658 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The following time units are available:
Value Description
500 500 ms
1000 1 second
60000 1 minute
3600000 1 hour
86400000 1 day
The attribute can be assigned dynamic properties by means of the name
TrendTimeRangeBase. The data type is LONG.
TrendTimeRangeFactor property
Time range - TrendTimeRangeFactor
Defines the factor for calculating the time range. Only integer factors are valid.
The attribute can be assigned dynamic properties by means of the name
TrendTimeRangeFactor. The data type is SHORT.
TrendTrendWindow property
Trend window - TrendTrendWindow
Defines the trend window for visualizing the trend selected. Define the available trend windows
in the "Trend window" tab.
The attribute can be assigned dynamic properties by means of the name
TrendTrendWindow. The data type is STRING.
TrendUncertainColor property
TrendUncertainColor
Value are in uncertain state if the initial value is unknown after runtime has been activated, or
if a substitute value is used. Set attribute "TrendUncertainColor" to define the color identifier
of these values. The "TrendUncertainColoring" attribute determines whether or not this setting
is evaluated.
The attribute can be assigned dynamic properties by means of the name
TrendUncertainColor. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 659
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendUncertainColoring property
TrendUncertainColoring
Value are in uncertain state if the initial value is unknown after runtime has been activated, or
if a substitute value is used. The "TrendUncertainColoring" attribute is used to enable
identification of such values based on the color set in "TrendUncertainColor".
Value Explanation
TRUE The settings of the "TrendUncertainColor" attribute are active.
FALSE The settings of the "TrendUncertainColor" attribute are inactive.
The attribute can be assigned dynamic properties by means of the name
TrendUncertainColoring. The data type is BOOLEAN.
TrendUpperLimit property
TrendUpperLimit
Specifies the high limit of a tag. If the tag exceeds the value of the "TrendUpperLimit, the values
are marked with the color set in "TrendUpperLimitColor". This setting is only active if the value
at attribute "TrendUpperLimitColoring" is "TRUE".
The attribute can be assigned dynamic properties by means of the name TrendUpperLimit.
The data type is DOUBLE.
TrendUpperLimitColor property
TrendUpperLimitColor
Specifies the color for designating tag values that are above the value of "TrendLowerLimit".
This setting is only active if the value at attribute "TrendUpperLimitColoring" is "TRUE".
The attribute can be assigned dynamic properties by means of the name
TrendUpperLimitColor. The data type is LONG.
TrendUpperLimitColoring property
TrendUpperLimitColoring
Specifies whether the attribute "TrendUpperLimitColor" is used to identify tag values that are
above the limit of the TrendUpperLimit".
Value Explanation
TRUE The setting of the "TrendUpperLimitColor" attribute is active.
FALSE The setting of the "TrendUpperLimitColor" attribute is inactive.
The attribute can be assigned dynamic properties by means of the name
TrendUpperLimitColoring. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
660 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendValueAlignment property
Alignment - TrendValueAlignment
Specifies the alignment of the displayed values for the trend type "Values".
The following settings are available depending on the writing direction of the trend:
● The writing direction of the trend is "from right" or "from left"
Value Description Explanation
0 Bottom The values are displayed at the bottom in the trend window.
1 Centered The values are displayed centered in the trend window.
2 Top The values are displayed at the top in the trend window.
● The writing direction of the trend is "from top" or "from bottom"
Value Description Explanation
0 Left The values are displayed on the left in the trend window.
1 Centered The values are displayed centered in the trend window.
2 Right The values are displayed on the right in the trend window.
The attribute can be assigned dynamic properties by means of the name
TrendValueAlignment. The data type is LONG.
See also
Trend object (list) (Page 231)
WinCC OnlineTrendControl (Page 260)
TrendValueAxis property
Value axis - TrendValueAxis
Defines the value axis to be used for the trend selected. Define the available value axes in the
"Value axes" tab.
The attribute can be assigned dynamic properties by means of the name TrendValueAxis. The
data type is STRING.
TrendValueUnit property
Unit - TrendValueUnit
Specifies a unit for the trend type "Values" that is appended to the displayed value, e.g., "%"
or "°C".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 661
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name TrendValueUnit. The
data type is STRING.
See also
Trend object (list) (Page 231)
WinCC OnlineTrendControl (Page 260)
TrendVisible property
Trends - TrendVisible
The list shows all trends you created.
Select the trends to be displayed in the trend window from the list.
Click a trend entry in the list to adapt the properties and to assign axes and trend windows to
the trend.
The attribute can be assigned dynamic properties by means of the name TrendVisible. The
data type is BOOLEAN.
TrendWindow - TrendYAxis
TrendWindowAdd property
New - TrendWindowAdd
Creates a new trend window.
The attribute can be assigned dynamic properties by means of the name TrendWindowAdd.
The data type is STRING.
TrendWindowCoarseGrid property
Main grid lines - TrendWindowCoarseGrid
Enables the display of grid lines for the main scale.
Value Explanation
TRUE Enables the display of grid lines for the main scale.
FALSE Disables the display of grid lines for the main scale.
The attribute can be assigned dynamic properties by means of the name
TrendWindowCoarseGrid. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
662 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendWindowCoarseGridColor property
Color of main scale - TrendWindowCoarseGridColor
Specifies the grid color of the main scale. Open the "Color selection" dialog by clicking the
button.
The attribute can be assigned dynamic properties by means of the name
TrendWindowCoarseGridColor. The data type is LONG.
TrendWindowCount property
TrendWindowCount
Defines the number of configured trend views.
The attribute can be assigned dynamic properties by means of the name
TrendWindowCount. The data type is LONG.
TrendWindowFineGrid property
Secondary grid lines - TrendWindowFineGrid
Enables the display of grid lines for the secondary scale.
Value Explanation
TRUE Enables the display of grid lines for the secondary scale.
FALSE Disables the display of grid lines for the secondary scale.
The attribute can be assigned dynamic properties by means of the name
TrendWindowFineGrid. The data type is BOOLEAN.
TrendWindowFineGridColor property
Color of secondary scale - TrendWindowFineGridColor
Specifies the grid color of the main scale. Open the "Color selection" dialog by clicking the
button.
The attribute can be assigned dynamic properties by means of the name
TrendWindowFineGridColor. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 663
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendWindowForegroundTrendGrid property
Only for foreground trend - TrendWindowForegroundTrendGrid
Enables the display of grid lines only for the foreground trend in the trend window.
Value Explanation
TRUE Enables the display of grid lines for the foreground trend in the trend window.
FALSE Enables the display of grid lines for all trends in the trend window.
The attribute can be assigned dynamic properties by means of the name
TrendWindowForegroundTrendGrid. The data type is BOOLEAN.
TrendWindowGridInTrendColor property
Use trend color - TrendWindowGridInTrendColor
Sets the trend color for the visualization of the grid lines for the main scale.
Value Explanation
TRUE The grid is displayed in the trend color.
FALSE The grid is displayed with the color set in the "Color" field.
The attribute can be assigned dynamic properties by means of the name
TrendWindowGridInTrendColor. The data type is BOOLEAN.
TrendWindowHorizontalGrid property
For X axis - TrendWindowVerticalGrid
Enables the display of horizontal grid lines.
Value Explanation
TRUE The display of horizontal grid lines is enabled.
FALSE The display of horizontal grid lines is disabled.
The attribute can be assigned dynamic properties by means of the name
TrendWindowHorizontalGrid. The data type is BOOLEAN.
TrendWindowIndex property
TrendWindowIndex
References a configured trend view. Using this attribute you can assign the values of other
attributes to a specific trend view.
WinCC: Scripting (VBS, ANSI-C, VBA)
664 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Values between 0 and "TrendWindowIndex" minus 1 are valid for "TrendWindowCount".
Attribute "TrendWindowCount" defines the number of trend views configured.
The "TrendWindowIndex" attribute can be assigned dynamic properties by means of attribute
TrendWindowRepos. The data type is LONG.
TrendWindowName property
Object name - TrendWindowName
Defines the name of the trend window selected.
The "TrendWindowName" attribute can be assigned dynamic properties by means of attribute
TrendWindowRename. The data type is STRING.
TrendWindowRemove property
Remove - TrendWindowRemove
Removes the selected trend window from the list.
The attribute can be assigned dynamic properties by means of the name
TrendWindowRemove. The data type is STRING.
TrendWindowRename property
TrendWindowRename
Renames a trend view which is referenced by means of "TrendWindowIndex" attribute.
The attribute can be assigned dynamic properties by means of the name
TrendWIndowRename. "TrendWindowRename" also sets a dynamic attribute
"TrendWindowName". The data type is STRING.
TrendWindowRepos property
Up/Down - TrendWindowRepos
Changes the sorting order of the trend windows. "Up" and "Down" move the selected trend up
or down in the list.
The sorting order in the list defines the position in the Control. The first trend window is
displayed at the last position, while the last is displayed at the top position.
The attribute can be assigned dynamic properties by means of the name
TrendWindowRepos. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 665
VBS for Creating Procedures and Actions
1.14 VBS Reference
TrendWindowRulerColor property
Ruler color - TrendWindowRulerColor
Specifies the ruler color. Open the "Color selection" dialog by clicking the button.
The color can be configured and displayed if "1 - graphic" is set for display of the ruler or
"TrendWindowRulerStyle".
The attribute can be assigned dynamic properties by means of the name
TrendWindowRulerColor. The data type is LONG.
TrendWindowRulerLayer property
Ruler layer - TrendWindowRulerLayer
Defines the representation layer of a ruler in the trend window.
The following settings are available:
Value Description Explanation
0 Under grid The ruler is visualized on a layer under the grid.
1 Between grid and The ruler is positioned on top of the trend and under the grid.
trend
2 On top of trend The ruler is positioned on top of the trend.
The attribute can be assigned dynamic properties by means of the name
TrendWindowRulerLayer. The data type is LONG.
TrendWindowRulerStyle property
Ruler - TrendWindowRulerStyle
Defines the appearance of the ruler.
The following settings are available:
Value Description Explanation
0 Simple The ruler is displayed as basic black line.
1 Graphic The ruler is displayed based on the "color" and "weight" configured.
The attribute can be assigned dynamic properties by means of the name
TrendWindowRulerStyle. The data type is LONG.
TrendWindowRulerWidth property
Ruler width - TrendWindowRulerWidth
Defines the width of the ruler in pixels.
WinCC: Scripting (VBS, ANSI-C, VBA)
666 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The width can be configured and displayed if "1 - graphic" is set for display of the ruler or
"TrendWindowRulerStyle".
The attribute can be assigned dynamic properties by means of the name
TrendWindowRulerWidth. The data type is LONG.
TrendWindowSpacePortion property
Proportional area - TrendWindowSpacePortion
Specifies the proportion of the trend widow to be used for the selected curve.
The attribute can be assigned dynamic properties by means of the name
TrendWindowSpacePortion. The data type is LONG.
TrendWindowStatisticRulerColor property
Color of ruler for statistics area - TrendWindowStatisticRulerColor
Specifies the color of the ruler for the statistics area. The button opens the "Color selection"
dialog to select the color.
The color can be configured and displayed if "1 - graphic" is set for display of the ruler for the
statistics area or "TrendWindowStatisticRulerStyle".
The attribute can be assigned dynamic properties by means of the name
TrendWindowStatisticRulerColor. The data type is LONG.
TrendWindowStatisticRulerStyle property
Ruler for statistics area - TrendWindowStatisticRulerStyle
Enables the display of a ruler for defining the statistics area.
The following settings are available:
Value Description Explanation
0 Simple The ruler is displayed as basic black line.
1 Graphic The ruler is displayed based on the "color" and "weight" configured.
The attribute can be assigned dynamic properties by means of the name
TrendWindowStatisticRulerStyle. The data type is LONG.
TrendWindowStatisticRulerWidth property
Width of ruler for statistics area - TrendWindowStatisticRulerWidth
Defines the width of the ruler for the statistics area in pixels.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 667
VBS for Creating Procedures and Actions
1.14 VBS Reference
The width of the ruler can be configured and displayed if "1 - graphic" is set for display of the
ruler for the statistics area or "TrendWindowStatisticRulerStyle".
The attribute can be assigned dynamic properties by means of the name
TrendWindowStatisticRulerWidth. The data type is LONG.
TrendWindowVerticalGrid property
for Y axis - TrendWindowVerticalGrid
Enables the display of vertical grid lines.
Value Explanation
TRUE The display of vertical grid lines is enabled.
FALSE The display of vertical grid lines is disabled.
The attribute can be assigned dynamic properties by means of the name
TrendWindowVerticalGrid. The data type is BOOLEAN.
TrendWindowVisible property
Trend window - TimeAxisTrendWindow
The list shows all trend windows you created.
Select the trend windows to be displayed in the control from the list.
Click a list entry to adapt the ruler and grid line properties.
The attribute can be assigned dynamic properties by means of the name
TrendWindowVisible. The data type is BOOLEAN.
TrendXAxis property
X axis - TrendXAxis
Defines the X axis to be used for the trend selected. Define the available X axes inn the "X
Axes" tab.
The attribute can be assigned dynamic properties by means of the name TrendXAxis. The
data type is STRING.
TrendYAxis property
Y axis - TrendYAxis
Defines the Y axis to be used for the trend selected. Define the available Y axes inn the "Y
Axes" tab.
WinCC: Scripting (VBS, ANSI-C, VBA)
668 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name TrendYAxis. The
data type is STRING.
Type
Type Property
Description
Reads out the object type, e.g. "Rectangle", "Circle" or "Line".
The object type is returned as a string. Read only
A special ID is returned as the type for all the graphic elements provided by WinCC. It can be
found under the topic "Type Identification in VBS“ in the individual descriptions of the WinCC
Object Types.
Special feature
In the case of non-WinCC controls and OLE objects, the version-independent ProgID is
returned as the type.
It is possible to determine the version-dependent ProgID or "User friendly Name" from the
ProgID: In the following example, "Control1" is a control embedded in the picture which already
returns the version-independent ProgID as a result of the Type property.
Note
Since not every Control has a version-dependent ProgID, an error handling measure should
be integrated to query the version-dependent ProgID or UserFriendlyName. If no error handling
is used, the code is terminated immediately without any result when no ProgID is found.
Determine the version-dependent ProgID as follows:
'VBS91
Dim objControl
Dim strCurrentVersion
Set objControl = ScreenItems("Control1")
strCurrentVersion = CreateObject("WScript.Shell").RegRead("HKCR\" & objControl.Type &
"\CurVer\")
MsgBox strCurrentVersion
Note
In order that example above works, a multimedia control should be inserted in the picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 669
VBS for Creating Procedures and Actions
1.14 VBS Reference
Determine the User Friendly Name as follows:
'VBS92
Dim objControl
Dim strFriendlyName
Set objControl = ScreenItems("Control1")
strFriendlyName = CreateObject("WScript.Shell").RegRead("HKCR\" & objControl.Type & "\")
MsgBox strFriendlyName
Note
In order that example above works, a multimedia control should be inserted in the picture.
Example:
The following example displays the type for all objects in the picture "NewPDL1":
'VBS93
Dim objScreen
Dim objScrItem
Dim lngIndex
Dim lngAnswer
Dim strName
lngIndex = 1
Set objScreen = HMIRuntime.Screens("NewPDL1")
For lngIndex = 1 To objScreen.ScreenItems.Count
strName = objScreen.ScreenItems(lngIndex).ObjectName
Set objScrItem = objScreen.ScreenItems(strName)
lngAnswer = MsgBox(objScrItem.Type, vbOKCancel)
If vbCancel = lngAnswer Then Exit For
Next
See also
ScreenItem Object (Page 123)
Object types of the ScreenItem object (Page 141)
TypeAlarmHigh Property
Description
TRUE, when the upper limit value, at which an alarm is triggered, should be evaluated as a
percentage. FALSE, when the evaluation should be as an absolute value. BOOLEAN write-
read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
670 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
ScreenItem Object (Page 123)
Bar (Page 172)
TypeAlarmLow Property
Description
TRUE, when the lower limit value, at which an alarm is triggered, should be evaluated as a
percentage. FALSE, when the evaluation should be as an absolute value. BOOLEAN write-
read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
TypeLimitHigh4 Property
Description
TRUE, when the "Reserve 4" upper limit value should be evaluated as a percentage. FALSE,
when the evaluation should be as an absolute value. BOOLEAN write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
TypeLimitHigh5 Property
Description
TRUE, when the "Reserve 5" upper limit value should be evaluated as a percentage. FALSE,
when the evaluation should be as an absolute value. BOOLEAN write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 671
VBS for Creating Procedures and Actions
1.14 VBS Reference
TypeLimitLow4 Property
Description
TRUE, when the "Reserve 4" lower limit value should be evaluated as a percentage. FALSE,
when the evaluation should be as an absolute value. BOOLEAN write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
TypeLimitLow5 Property
Description
TRUE, when the "Reserve 5" lower limit value should be evaluated as a percentage. FALSE,
when the evaluation should be as an absolute value. BOOLEAN write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
TypeToleranceHigh Property
Description
TRUE, when the "Tolerance high" lower limit value should be evaluated as a percentage.
FALSE, when the evaluation should be as an absolute value. BOOLEAN write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
TypeToleranceLow Property
Description
TRUE, when the "Tolerance low" lower limit value should be evaluated as a percentage.
FALSE, when the evaluation should be as an absolute value. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
672 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Bar (Page 172)
ScreenItem Object (Page 123)
TypeWarningHigh Property
Description
TRUE, when the "Warning high" lower limit value should be evaluated as a percentage. FALSE,
when the evaluation should be as an absolute value. BOOLEAN write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
TypeWarningLow Property
Description
TRUE, when the "Warning low" lower limit value should be evaluated as a percentage. FALSE,
when the evaluation should be as an absolute value. BOOLEAN write-read access.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
1.14.4.20 U
Un - Up
UnitColor Property
Description
Defines the text color for the names of the unit of measurement. LONG write-read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 673
VBS for Creating Procedures and Actions
1.14 VBS Reference
UnitFont Property
Description
Controls the display of the labeling for the unit of measurement. Read only access.
The following properties can be set:
- Font
- Font Style
- Font Size
- "Strikethrough" effect
- "Underline" effect
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
UnitOffset Property
Description
This attribute defines the distance of the text for the unit of measurement in relation to the top
edge of the object. The text can only be positioned along the vertical diameter of the graduated
scale disk. The value of the property is related to the height of the object and is measured from
the top edge of the object to the base of the text.
The value range is 0 is 1.
0: The base of the text is at the top limit of the object. The text is no longer visible because it
is outside the object.
1: The base of the text is at the bottom limit of the object.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
UnitText Property
Description
Defines the text for the unit of measurement. Write/Read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
674 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
UnselBGColor Property
Description
Defines or returns the background color of entries in the text list object which are not selected.
LONG write-read access.
See also
Text list (Page 194)
ScreenItem Object (Page 123)
UnselTextColor Property
Description
Defines or returns the color of the text for entries in the text list object which are not selected.
LONG write-read access.
See also
Text list (Page 194)
ScreenItem Object (Page 123)
UpdateCycle Property
Description
Returns the type and frequency of updating the picture window in Runtime. Read only access.
See also
Picture Window (Page 177)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 675
VBS for Creating Procedures and Actions
1.14 VBS Reference
UpperLimit Property
Description
TRUE, when the "UpperLimitColor" specification is to be used in order to identify the tag values
(from a trend referenced via "Index") which lie above the value defined in "UpperLimitValue".
BOOLEAN write-read access.
See also
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
UpperLimitColor Property
Description
Defines the color to be used in order to identify the tag values (from a trend referenced via
"Index") which lie above the value defined in "UpperLimitValue". Whether the information is
evaluated is dependent on the value of the "UpperLimit" property. The color is defined as an
RGB value. LONG write-read access.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
ScreenItem Object (Page 123)
UpperLimitTagName Property
Description
This defines the upper limit of the trend range, which is automatically taken from the variable
properties configured in PCS 7. Write/Read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
676 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
UpperLimitValue Property
Description
Tag values (from a trend referenced via "Index") which lie above the value defined by
"UpperLimitValue" are identified by the color specified in "UpperLimitColor". Whether the
information is evaluated is dependent on the value of the "UpperLimit" property.
See also
ScreenItem Object (Page 123)
WinCC Online Table Control (before WinCC V7) (Page 285)
WinCC Online Trend Control (before WinCC V7) (Page 288)
WinCC Function Trend Control (before WinCC V7) (Page 281)
Us
UseColumnBackColor property
Use column color / background - UseColumnBackColor
Specifies the settings to be activated for the background colors of columns.
Value Explanation
TRUE The background color settings are active in the "Time columns" or "TimeColumnBackColor" tabs and in the
"Value columns" or "ValueColumnBackColor" tabs.
FALSE The background color settings are active in the "Display" tab.
The attribute can be assigned dynamic properties by means of the name
UseColumnBackColors. The data type is BOOLEAN.
UseColumnForeColor property
Use column color / font - UseColumnForeColor
Defines the active font color settings for the columns.
Value Explanation
TRUE The font color color settings are active in the "Time columns" or "TimeColumnForeColor" tabs and in the "Value
columns" or "ValueColumnForeColor" tabs.
FALSE The font color settings are active in the "Display" tab.
The attribute can be assigned dynamic properties by means of the name
UseColumnForeColors. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 677
VBS for Creating Procedures and Actions
1.14 VBS Reference
UserEditMode property
Edit mode user - UserEditMode
Specifies which editing options the user has in WinCC UserAdminControl regarding user
properties.
Value Name Explanation
0 Read The user can only read the user properties.
1 Change The user can change the user properties.
2 Full access The user can change the user properties without restrictions.
The attribute can be assigned dynamic properties using the name UserEditMode. The data
type is LONG.
UseHeaderFont property
UseHeaderFont
Specifies whether the font defined in the "HeaderFont" attribute is used for the table header
of WinCC UserAdminControl.
The attribute can be assigned dynamic properties using the name UseHeaderFont. The data
type is BOOLEAN.
UseMessageColor property
Show message colors - UseMessageColor
Sets the outputs of messages with colors as agreed by handshake.
Value Explanation
TRUE The message colors are displayed.
FALSE The message colors are not displayed. Instead, the color settings defined for the table content are activated
on the "Display" tab.
The attribute can be assigned dynamic properties by means of the name UseMessageColor.
The data type is BOOLEAN.
UseOnlineTags Property
Description
This defines whether or not the variable properties configured in PCS 7 are applied as trend
parameters. Write/Read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
678 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
UseRangeSubstitutes Property
Description
TRUE, if a separate scaling of the value axis is displayed for the trends in Trend Control.
BOOLEAN write-read access.
UserData-Property
Description
Contains the value that is to be transferred to the VB script while running a customized menu
item or icon. STRING (write-read access)
Example:
Use the "User data" field in the "Menus and Toolbars" editor to apply a parameter to the
procedure
The following example shows the "ActivateScreen" procedure that executes the picture
change. Enter the picture name in the "User Data" field:
Sub ActivateScreen (ByVal Item)
Dim objScreen
Dim strScreenName
' "UserData" contains the screen name specified
' in editor menus and toolbars.
strScreenName = Item.Userdata
HMIRuntime.BaseScreenName = strScreenName
End Sub
UserName property
Description
Returns the name of the user who triggered the alarm object.
See also
Alarms object (list) (Page 108)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 679
VBS for Creating Procedures and Actions
1.14 VBS Reference
UserValue1 Property
Description
Defines or returns a value.
The value can be evaluated by a script, for example. This value is neither evaluated nor
displayed in Runtime.
See also
ScreenItem Object (Page 123)
Group Display (Page 192)
UserValue2-Eigenschaft
Description
Defines or returns a value.
The value can be evaluated by a script, for example. This value is neither evaluated nor
displayed in Runtime.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
UserValue3 Property
Description
Defines or returns a value.
The value can be evaluated by a script, for example. This value is neither evaluated nor
displayed in Runtime.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
680 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
UserValue4 Property
Description
Defines or returns a value.
The value can be evaluated by a script, for example. This value is neither evaluated nor
displayed in Runtime.
See also
Group Display (Page 192)
ScreenItem Object (Page 123)
UseSelectedTitleColor property
Selection color - UseSelectedTitleColor
Specifies whether to use a selection color for the headers of selected table cells.
Value Explanation
TRUE A selection color is used. The "Background" or "SelectedTitleColor" and "Font" or "SelectedTitleForeColor"
settings are active in Runtime.
FALSE Selection color is not used. The "Background" and "Font" settings are disabled in Runtime.
The attribute can be assigned dynamic properties by means of the name
UseSelectedTitleColor. The data type is BOOLEAN.
UseSourceBackColors property
Apply background colors - UseSourceBackColors
Sets the background color derived from the control defined in the "Source" field.
Value Explanation
TRUE The background color from the interconnected control is used.
FALSE The background color from the interconnected control is not used. The settings on the "Layout" tab are used.
The attribute can be assigned dynamic properties by means of the name
UseSourceBackColors. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 681
VBS for Creating Procedures and Actions
1.14 VBS Reference
UseSourceForeColors property
Apply font colors - UseSourceForeColors
Sets the font colors derived from the control defined in the "Source" field.
Value Explanation
TRUE The font color of the interconnected control is activated.
FALSE The font color from the connected control is not used. The settings on the "Layout" tab are used.
The attribute can be assigned dynamic properties by means of the name
UseSourceForeColors. The data type is BOOLEAN.
UseTableColor2 property
Row Color 2 - UseTableColor2
Specifies whether to use a second row color for the representation of the table.
Value Explanation
TRUE "Row color 2" and "Row color 1" are used alternately.
FALSE The "Row color 1" settings are used for all rows.
The attribute can be assigned dynamic properties by means of the name UseTableColor2.
The data type is BOOLEAN.
UseTrendNameAsLabel property
UseTrendNameAsLabel
Sets the "TrendName" or "TrendLabel" attribute for labeling the trend in Runtime.
Value Explanation
TRUE Sets the "TrendName" attribute for labeling the trend in Runtime.
FALSE Sets the "TrendLabel" attribute for labeling the trend in Runtime.
The attribute can be assigned dynamic properties by means of the name
UseTrendNameAsLabel. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
682 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.4.21 V
Val - ValueAxis
Value Property
Description of Tag Object
Displays the value of the tags at the last read access or the value written or to be written. Value
represents the value of a tag. After calling in the "Read" method, the tag value read is returned.
Before writing, the new tag value required can be assigned to the property. After calling in the
"Write" method, the property contains the value last written.
VARIANT (write-read access)
Example:
The following example writes a new value in the "Tag1" tag:
'VBS94
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Value = 50
objTag.Write
Description of WinCC Gauge Control
Defines the value to which the pointer points. Value Range: "ValueMin" to "ValueMax".
Description of DataItem Object
Returns a value copy or object reference. Furthermore, an already added value can be
changed via the value property.
Example:
The example shows how to add a value to the list, and how to output it as a trace. After that,
the value is changed, output again and then removed. It make sense to perform this in several
different actions.
'VBS198
HMIRuntime.DataSet.Add "motor1", 23
HMIRuntime.Trace "motor1: " & HMIRuntime.DataSet("motor1").Value & vbNewLine
HMIRuntime.DataSet("motor1").Value = 55
HMIRuntime.Trace "motor1: " & HMIRuntime.DataSet("motor1").Value & vbNewLine
HMIRuntime.DataSet.Remove("motor1")
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 683
VBS for Creating Procedures and Actions
1.14 VBS Reference
Note
For object references it must be ascertained that objects are multiread-enabled.
See also
WinCC Gauge Control (Page 251)
Write Method (Page 815)
Read Method (Page 785)
Tag Object (Page 135)
DataItem Object (Page 111)
ProcessValues Object (List) (Page 122)
ValueAxisAdd property
New - ValueAxisAdd
Creates a new value axis.
The attribute can be assigned dynamic properties by means of the name ValueAxisAdd. The
data type is STRING.
ValueAxisAlign property
Alignment - ValueAxisAlign
Specifies the mode of alignment of a selected value axis.
The following settings are available:
Value Description Explanation
0 left The selected value axis is displayed on left side of the trend or diagram.
1 right The selected value axis is displayed on right side of the trend or diagram.
The attribute can be assigned dynamic properties by means of the name ValueAxisAlign. The
data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
684 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueAxisAutoPrecisions property
Decimal places automatic - ValueAxisAutoPrecisions
Enables automatic setting of the decimal precision.
Value Explanation
TRUE The decimal precision is defined automatically. The value in the "Decimal places" or "ValueAxisPreci‐
sions" field is disabled.
FALSE The value in the "Decimal places" or "ValueAxisPrecisions" field is active.
The attribute can be assigned dynamic properties by means of the name
ValueAxisAutoPrecisions. The data type is BOOLEAN.
ValueAxisAutoRange property
Value range automatic - ValueAxisAutoRange
Enables automatic calculation of the range of values.
Value Explanation
TRUE The range of values is calculated automatically.
FALSE The range of values is calculated based on the values configured in the "from" and "to" or "ValueAxisBegin‐
Value" and "ValueAxisEndValue" fields.
The attribute can be assigned dynamic properties by means of the name
ValueAxisAutoRange. The data type is BOOLEAN.
ValueAxisBarWindow property
Diagram window - ValueAxisBarWindow
Specifies the diagram window in which the selected value axis will be used. You can specify
the available diagram window in the "Diagram window" tab or using "BarWindowAdd".
The attribute can be assigned dynamic properties using the name ValueAxisBarWindow. The
data type is STRING.
ValueAxisBeginValue property
Value range from - ValueAxisBeginValue
Specifies the start value of the value axis selected. You can configure the value if the
"Automatic" option is disabled or "ValueAxisAutoRange" is "FALSE".
The attribute can be assigned dynamic properties by means of the name
ValueAxisBeginValue. The data type is DOUBLE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 685
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueAxisColor property
Value axis color - ValueAxisColor
Specifies the color of the time axis. The button opens the "Color selection" dialog to select the
color.
The setting is only active if the "Use trend color" or "Use diagram color" option is disabled or
if "ValueAxisInTrendColor" is "FALSE".
The attribute can be assigned dynamic properties by means of the name ValueAxisColor. The
data type is LONG.
ValueAxisCount property
ValueAxisCount
Defines the number of value axes configured.
The attribute can be assigned dynamic properties by means of the name ValueAxisCount. The
data type is LONG.
ValueAxisEndValue property
Value range to - ValueAxisEndValue
Specifies the end value of the value axis selected. You can configure the value if the
"Automatic" option is disabled or "ValueAxisAutoRange" is "FALSE".
The attribute can be assigned dynamic properties by means of the name
ValueAxisEndValue. The data type is DOUBLE.
ValueAxisExponentialFormat property
Exponential notation - ValueAxisExponentialFormat
Sets exponential notation for the display of values of a value axis selected.
Value Explanation
TRUE The values are displayed with exponential notation.
FALSE The values are displayed with decimal notation.
The attribute can be assigned dynamic properties by means of the name
ValueAxisExponentialFormat. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
686 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueAxisInBarColor property
In diagram color - ValueAxisInBarColor
Specifies whether the selected value axis will be displayed in the diagram color. If there is
more than one diagram in the diagram window, the color of the first diagram will be used. You
specify the order of the diagrams on the "Diagrams" tab.
Value Explanation
TRUE The selected value axis is displayed in the diagram color. The setting in the "Color" or "ValueAxisColor" field
is disabled.
FALSE The value axis selected is displayed in the color set in the "Color" or "ValueAxisColor" field.
The attribute can be assigned dynamic properties using the name ValueAxisInBarColor. The
data type is BOOLEAN.
ValueAxisIndex property
ValueAxisIndex
References a value axis. Using this attribute you can assign the values of other attributes to
a specific value axis.
Values between 0 and "ValueAxisCount" minus 1 are valid for "ValueAxisIndex". Attribute
"ValueAxisCount" defines the number of value axes configured.
The "ValueAxisIndex" attribute can be assigned dynamic properties by means of attribute
ValueAxisRepos. The data type is LONG.
ValueAxisInTrendColor property
Use trend color - ValueAxisInTrendColor
Sets the trend color for displaying the value axis selected. The color of the first trend is activated
if several trends are displayed in the trend window. Define the order of trends on the "Trends"
tab.
Value Explanation
TRUE The selected value axis is displayed in the trend color. The setting in the "Color" or "Val‐
ueAxisColor" field is disabled.
FALSE The value axis selected is displayed in the color set in the "Color" or "ValueAxisColor" field.
The attribute can be assigned dynamic properties by means of the name
ValueAxisInTrendColor. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 687
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueAxisInTrendColor property
Use trend color - ValueAxisInTrendColor
Sets the trend color for displaying the value axis selected. The color of the first trend is activated
if several trends are displayed in the trend window. Define the order of trends on the "Trends"
tab.
Value Explanation
TRUE The selected value axis is displayed in the trend color. The setting in the "Color" or "ValueAxisColor" field is
disabled.
FALSE The value axis selected is displayed in the color set in the "Color" or "ValueAxisColor" field.
The attribute can be assigned dynamic properties by means of the name
ValueAxisInTrendColor. The data type is BOOLEAN.
ValueAxisLabel property
Label - ValueAxisLabel
Specifies the label of a value axis selected.
The attribute can be assigned dynamic properties by means of the name ValueAxisLabel. The
data type is STRING.
ValueAxisName property
Object name - ValueAxisName
Specifies the name of a value axis selected.
The "ValueAxisName" attribute can be assigned dynamic properties by means of attribute
ValueAxisRename. The data type is STRING.
ValueAxisPrecisions property
Decimal places - ValueAxisPrecisions
Specifies the decimal precision for displaying the value axis selected. The value can be
configured and is active in Runtime, if the "Automatic" option is disabled or
"ValueAxisAutoPrecisions" is "FALSE".
The attribute can be assigned dynamic properties by means of the name
ValueAxisPrecisions. The data type is SHORT.
WinCC: Scripting (VBS, ANSI-C, VBA)
688 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueAxisRemove property
Remove - ValueAxisRemove
Removes the selected value axis from the list.
The attribute can be assigned dynamic properties by means of the name ValueAxisRemove.
The data type is STRING.
ValueAxisRename property
ValueAxisRename
Renames a value axis which is referenced by means of "ValueAxisIndex" attribute.
The attribute can be assigned dynamic properties by means of the name ValueAxisRename.
"ValueAxisRename" also sets a dynamic attribute "ValueAxisName". The data type is STRING.
ValueAxisRepos property
Up/Down - ValueAxisRepos
Changes the order of value axes. "Up" and "Down" move the value axis selected up or down
in the list.
The list order determines the value axis position in the trend window or diagram window in
runtime. If the orientation is the same and the value axis of the list is further above, the value
axis is shown at a more remote position of the curve or diagram.
The attribute can be assigned dynamic properties by means of the name ValueAxisRepos .
The data type is LONG.
ValueAxisScalingType property
Scaling - ValueAxisScalingType
Specifies the scaling mode for a selected value axis.
The following settings are available:
Value Description Explanation
0 Linear Enables linear scaling of a value axis selected.
1 Logarithmic Enables logarithmic scaling of a value axis selected.
2 Logarithmically negated Enables scaling of a selected value value axis with logarithmic negation.
The attribute can be assigned dynamic properties by means of the name
ValueAxisScalingType. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 689
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueAxisTrendWindow property
Trend window - ValueAxisTrendWindow
Specifies the trend window for displaying the value axis selected. Define the available trend
windows in the "Trend window" tab.
The attribute can be assigned dynamic properties by means of the name
ValueAxisTrendWindow. The data type is STRING.
ValueAxisVisible property
Value axes - ValueAxisVisible
The list shows all value axes you created. Click a value axis entry in the list to adapt the
properties and to assign a trend window or diagram window to the value axis.
Select the value axes in the list that you want to display in the trend windows or diagram
windows.
The attribute can be assigned dynamic properties by means of the name ValueAxisVisible .
The data type is BOOLEAN.
ValueColumn - Vi
ValueColumnAdd property
New - ValueColumnAdd
Creates a new value column.
The attribute can be assigned dynamic properties by means of the name ValueColumnAdd.
The data type is STRING.
ValueColumnAlign property
Alignment - ValueColumnAlign
Defines the mode of alignment of a selected value column.
The following settings are available:
Value Description Explanation
0 left The selected value column is displayed on the left.
1 Centered The selected value column is aligned to center.
2 right The selected value column is displayed on the right.
WinCC: Scripting (VBS, ANSI-C, VBA)
690 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name ValueColumnAlign.
The data type is LONG.
ValueColumnAlignment Property
Description
The "Index" property references a pair of columns. "ValueColumnAlignment" defines the
alignment of the tag value for this column pair.
● 0: Tag values are entered aligned left.
● 1: Tag values are entered centered.
● 2: Tag values are entered aligned right.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
ValueColumnAutoPrecisions property
Automatic - ValueColumnAutoPrecisions
Enables automatic setting of the decimal precision.
Value Explanation
TRUE The decimal precision is defined automatically. The value in the "Decimal places" or "ValueColumnPre‐
cisions" field is disabled.
FALSE The value in the "Decimal places" or "ValueColumnPrecisions" field is active.
The attribute can be assigned dynamic properties by means of the name
ValueColumnAutoPrecisions. The data type is BOOLEAN.
ValueColumnBackColor property
Background color - ValueColumnBackColor
Specifies the background color of the value column selected. Use the button to open the "Color
selection" dialog.
The setting is only active if the "Background color" option is set or "UseColumnBackColor" is
"TRUE" in the "Use column color" field of the "General" tab.
The attribute can be assigned dynamic properties by means of the name
ValueColumnBackColor. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 691
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueColumnCaption property
Description - ValueColumnCaption
Defines the label of the value column selected.
The attribute can be assigned dynamic properties by means of the name
ValueColumnCaption. The data type is STRING.
ValueColumnCount property
ValueColumnCount
Defines the number of value columns configured.
The attribute can be assigned dynamic properties by means of the name ValueColumnCount.
The data type is LONG.
ValueColumnExponentialFormat property
Exponential notation - ValueColumnExponentialFormat
Sets exponential notation for the display of values of a value column selected.
Value Explanation
TRUE Display with exponential notation.
FALSE Display with decimal notation.
The attribute can be assigned dynamic properties by means of the name
ValueColumnExponentialFormat. The data type is BOOLEAN.
ValueColumnForeColor property
Font color - ValueColumnForeColor
Specifies the font color of the value column selected. Use the button to open the "Color
selection" dialog.
The setting is only active if the "Font color" option is set or "UseColumnForeColor" is "TRUE"
in the "Use column color" field of the "General" tab.
The attribute can be assigned dynamic properties by means of the name
ValueColumnForeColor. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
692 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueColumnHideText property
ValueColumnHideText
Sets text format for displaying the content of a value column.
Value Explanation
TRUE The content is not displayed in text format.
FALSE The content is displayed in text format.
The attribute can be assigned dynamic properties by means of the name
ValueColumnHideText. The data type is BOOLEAN.
ValueColumnHideTitleText property
ValueColumnHideTitleText
Sets text format for displaying the value column header.
Value Explanation
TRUE The header is not displayed in text format.
FALSE The header is displayed in text format.
The attribute can be assigned dynamic properties by means of the name
ValueColumnHideTitleText. The data type is BOOLEAN.
ValueColumnIndex property
ValueColumnIndex
References a configured value column. Using this attribute you can assign the values of other
attributes to a specific value column.
Values between 0 and "ValueColumnCount" minus 1 are valid for "ValueColumnIndex".
Attribute "ValueColumnCount" defines the number of value columns configured.
The "ValueColumnIndex" attribute can be assigned dynamic properties by means of attribute
ValueColumnRepos. The data type is LONG.
ValueColumnLength property
Length in characters - ValueColumnLength
Specifies the width of a selected value column.
The attribute can be assigned dynamic properties by means of the name
ValueColumnLength. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 693
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueColumnName property
Object name - ValueColumnName
Specifies the name of a selected value column.
The "ValueColumnName" attribute can be assigned dynamic properties by means of attribute
ValueColumnRename. The data type is STRING.
ValueColumnPrecisions property
Decimal places - ValueColumnPrecisions
Specifies the decimal precision for displaying the data of a value column selected. The value
can be entered if the "Automatic" option is disabled or "ValueColumnAutoPrecisions" is
"FALSE".
The attribute can be assigned dynamic properties by means of the name
ValueColumnPrecisions. The data type is SHORT.
ValueColumnProvider property
Data source - ValueColumnProvider
Specifies the data source for a selected value column.
The following settings are available:
Value Description Explanation
1 Archive tags Data source with archive tags of a process value archive.
2 Online tags Data source with online tags derived from tag management.
The attribute can be assigned dynamic properties by means of the name
ValueColumnProvider. The data type is LONG.
ValueColumnProviderCLSID property
ValueColumnProviderCLSID
Indicates the data source of the value column selected.
Value Explanation
{416A09D2-8B5A-11D2- Data source with archive tags of a process value archive.
8B81-006097A45D48}
{A3F69593-8AB0-11D2- Data source with online tags derived from tag management.
A440-00A0C9DBB64E}
The attribute can be assigned dynamic properties by means of the name
ValueColumnProviderCLSID. The data type is STRING.
WinCC: Scripting (VBS, ANSI-C, VBA)
694 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueColumnRemove property
Remove - ValueColumnRemove
Removes the selected value column from the list.
The attribute can be assigned dynamic properties by means of the name
ValueColumnRemove. The data type is STRING.
ValueColumnRename property
ValueColumnRename
Renames a value column which is referenced by means of "ValueColumnIndex" attribute.
The attribute can be assigned dynamic properties by means of the name
ValueColumnRename. "ValueColumnRename" also sets a dynamic attribute
"ValueColumnName". The data type is STRING.
ValueColumnRepos property
Up/Down - ValueColumnRepos
Changes the sorting order of the value columns. "Up" and "Down" move the value column
selected up or down in the list.
The sorting order in the list determines the order of value columns after the time column if
several value columns are assigned to the same time column. Higher positions of the value
column in the list moves it to closer proximity towards the time column.
You change the order of time columns and their assigned value columns in the "Time columns"
tab.
The attribute can be assigned dynamic properties by means of the name
ValueColumnRepos. The data type is LONG.
ValueColumnSelectTagName property
ValueColumnSelectTagName
Opens a dialog for selecting the tag name for the data source of the value column in WinCC
OnlineTableControl. Programmers can set this attribute to allow users to select a tag name by
means of a button, for example.
The attribute can be assigned dynamic properties by means of the name
ValueColumnSelectTagName. The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 695
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueColumnShowIcon property
ValueColumnShowIcon
Enables the display of value column contents as icon.
Value Explanation
TRUE The content is visualized as icon.
FALSE The content is not visualized as icon.
The attribute can be assigned dynamic properties by means of the name
ValueColumnShowIcon. The data type is BOOLEAN.
ValueColumnShowTitleIcon property
ValueColumnShowTitleIcon
Enables display of the value column header as icon.
Value Explanation
TRUE The header is displayed as icon.
FALSE The header is not displayed as icon.
The attribute can be assigned dynamic properties by means of the name
ValueColumnShowTitleIcon. The data type is BOOLEAN.
ValueColumnSort property
ValueColumnSort
Defines the sorting order of the value column referenced in "ValueColumnIndex" .
The following settings are available:
Value Description Explanation
0 No No sorting
1 Ascending Ascending order, starting at the lowest value.
2 Descending Descending order, starting at the highest value.
The attribute can be assigned dynamic properties by means of the name ValueColumnSort .
The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
696 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ValueColumnSortIndex property
ValueColumnSortIndex
Defines the sorting order of the value column referenced in "ValueColumnIndex". The sorting
criterion is removed from "ValueColumnSort" if you set a "0" value..
The attribute can be assigned dynamic properties by means of the name
ValueColumnSortIndex. The data type is LONG.
ValueColumnState property
ValueColumnState
Displays the data connection status of a selected value column in Runtime.
The attribute can be assigned dynamic properties by means of the name ValueColumnState.
The data type is LONG.
ValueColumnTagName property
Tag name - ValueColumnTagName
Displays the name of connected tags. You can change the tag connection using the selection
button.
The attribute can be assigned dynamic properties by means of the name
ValueColumnTagName. The data type is STRING.
ValueColumnTimeColumn property
Time column - ValueColumnTimeColumn
Specifies the time column for displaying the value column selected. Define the available time
columns in the "Time columns" tab.
The attribute can be assigned dynamic properties by means of the name
ValueColumnTimeColumn. The data type is STRING.
ValueColumnVisible property
Value columns - ValueColumnVisible
The list shows all value columns you created. Click a value column entry in the list to adapt
the properties, to assign the value column, and to define the data connection.
Select the value columns to be displayed in the table from the list. Value columns are displayed
if interconnected with a time column.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 697
VBS for Creating Procedures and Actions
1.14 VBS Reference
The attribute can be assigned dynamic properties by means of the name
ValueColumnVisible . The data type is BOOLEAN.
ValueMax Property
Description
Defines the value at the end of the scale. Write/Read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
ValueMin Property
Description
Defines the value at the start of the scale. Write/Read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
Variable Property
Description
The "Index" property references a pair of columns. "Tag" defines the name of the tag which
should be connected to this column pair.
See also
WinCC Online Table Control (before WinCC V7) (Page 285)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
698 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
VerticalGridLines property
Vertical - VerticalGridLines
Enables the display of vertical dividers.
Value Explanation
TRUE Enables the displays of vertical dividers.
FALSE Disables the display of vertical dividers.
The attribute can be assigned dynamic properties by means of the name VerticalGridLines.
The data type is BOOLEAN.
Visible Property
Description
witches an object visible or invisible or issues a corresponding value:
● TRUE : Object is visible
● FALSE : Object is invisible
VARIANT_BOOL (write-read access)
Example:
The following example sets all the objects in the picture "NewPDL1" to invisible:
'VBS95
Dim objScreen
Dim objScrItem
Dim lngIndex
Dim strName
lngIndex = 1
Set objScreen = HMIRuntime.Screens("NewPDL1")
For lngIndex = 1 To objScreen.ScreenItems.Count
strName = objScreen.ScreenItems(lngIndex).ObjectName
Set objScrItem = objScreen.ScreenItems(strName)
objScrItem.Visible = False
Next
See also
ScreenItem Object (Page 123)
Layer Object (Page 118)
HMIRuntime Object (Page 116)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 699
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.4.22 W
Warning Property
Description
Defines the start of the "Warning zone" as a scale value. Write/Read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
WarningColor Property
Description
Defines the color of the "Warning zone" o the scale. LONG write-read access.
See also
WinCC Gauge Control (Page 251)
ScreenItem Object (Page 123)
WarningHigh Property
Description
Defines or returns the upper limit value for "Warning High".
In order that the limit value is monitored, the "CheckWarningHigh" property must be set to
TRUE.
The display on reaching the limit value and the type of evaluation are defined by means of the
"ColorWarningHigh" and "TypeWarningHigh" properties.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
WinCC: Scripting (VBS, ANSI-C, VBA)
700 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
WarningLow Property
Description
Defines or returns the lower limit value for "Warning Low".
In order that the limit value is monitored, the "CheckWarningLow" property must be set to
TRUE.
The display on reaching the limit value and the type of evaluation are defined by means of the
"ColorWarningLow" and "TypeWarningLow" properties.
See also
Bar (Page 172)
ScreenItem Object (Page 123)
Width Property
Description
Sets or outputs the width of an object in pixels.
LONG
Example:
The following example doubles the width of all objects in the pictures "NewPDL1" whose name
begins with "Button":
'VBS96
Dim objScreen
Dim cmdButton
Dim lngIndex
Dim strName
lngIndex = 1
Set objScreen = HMIRuntime.Screens("NewPDL1")
For lngIndex = 1 To objScreen.ScreenItems.Count
'
'Get all "Buttons"
strName = objScreen.ScreenItems(lngIndex).ObjectName
If "Button" = Left(strName, 6) Then
Set cmdButton = objScreen.ScreenItems(strName)
cmdButton.Width = cmdButton.Width * 2
End If
Next
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 701
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
Height Property (Page 444)
ScreenItem Object (Page 123)
WinCCStyle property
Description
Defines the style in which the object is displayed.
User Defined Shows the object according to the respective settings.
Global Shows the object in a globally defined design.
Windows Style Shows the object in Windows style.
WindowBorder Property
Description
TRUE, when the window is displayed with borders in Runtime. Read only access.
See also
Picture Window (Page 177)
Application Window (Page 171)
ScreenItem Object (Page 123)
WindowPositionMode property
Description
Defines the position and scaling of the picture window on the screen. It is only effective if the
"Independent window" attribute is set to TRUE.
Standard The picture window is positioned in its original size in the configured position on
the screen.
Center The picture window is positioned in its original size, centered on the screen.
Maximize The picture window is scaled to the size of the screen.
WinCC: Scripting (VBS, ANSI-C, VBA)
702 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
WindowsStyle property
Description
Defines whether the object is displayed in the Windows style of WinCC version 6.2. It can only
be selected if "WinCC Classic" is chosen as the current design.
TRUE if the object is displayed in the Windows style of WinCC version 6.2.
FALSE if the object is not displayed in the Windows style of WinCC version 6.2.
The WinCC V6.2 standard design "WinCC Classic" which, for compatibility reasons, is
available for migrated projects. The design supports only a portion of the functions that were
introduced as of WinCC V7.0: For example, you cannot use any SVG graphics.
WindowsStyle Property
Description
TRUE, when the object complies with the general Windows style (e.g. gray buttons without
borders). BOOLEAN write-read access. Note:
● When this property is set to "True", the properties which do not comply with the Windows
style are ignored (e.g. "BorderWidth").
● On the other hand, the definition of a "BorderWidth" or a background color other than gray
causes "WindowsStyle" to receive the value"False".
● Exceptions here are the flash attributes: The definition of flash attributes does not
automatically lead to the deactivation of the "WindowsStyle" attribute.
See also
Slider (Page 210)
Button (Page 199)
ScreenItem Object (Page 123)
WindowType Property
Description
Defines the use of the message window.
● 0 - Message list: shows the currently pending messages.
● 1 - Short-term archive list: shows the archived messages.
● 2 - Long-term archive list: shows the archived messages.
● 3 - Lock list: shows the currently locked messages.
● 4 - Hit list: To display the statistical information of messages.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 703
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
WinCC Alarm Control (before WinCC V7) (Page 279)
ScreenItem Object (Page 123)
WithAxes Property
Description
TRUE, when the scale should be displayed. BOOLEAN write-read access.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
WithLabels Property
Description
TRUE, when the scale labels should be displayed. BOOLEAN write-read access.
See also
WinCC Slider Control (Page 270)
ScreenItem Object (Page 123)
1.14.4.23 X-Z
XAxisColor property (before WinCC V7)
Description
Use this attribute to define the color for the common X-axis. The color is defined as an RGB
value. LONG write-read access.
X/YAxisAdd property
New - X/YAxisAdd
Creates a new X or Y axis.
The X axis attribute can be assigned dynamic properties by means of the name XAxisAdd .
WinCC: Scripting (VBS, ANSI-C, VBA)
704 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The Y axis attribute can be assigned dynamic properties by means of the name YAxisAdd .
The data type is STRING.
X/YAxisAlign property
Alignment - X/YAxisAlign
Defines the alignment mode for a selected axis.
The following settings are available for the X axis:
Value Description Explanation
0 Bottom The X axis selected is displayed below the trend.
1 Top The X axis selected is displayed above the trend.
The X axis attribute can be assigned dynamic properties by means of the name XAxisAlign.
The data type is LONG.
The following settings are available for the Y axis:
Value Description Explanation
0 left The X axis selected is displayed on left side of the trend.
1 right The X axis selected is displayed on right side of the trend.
The Y axis attribute can be assigned dynamic properties by means of the name YAxisAlign.
The data type is LONG.
X/YAxisAutoPrecisions property
Decimal places automatic - X/YAxisAutoPrecisions
Enables automatic setting of the decimal precision.
Value Explanation
TRUE The number of decimal places is set automatically. The value in the "Decimal places" or "X/YAxisPreci‐
sions" field is disabled.
FALSE The value in the "Decimal places" or "X/YAxisPrecisions" field is active.
The X axis attribute can be assigned dynamic properties by means of the name
XAxisAutoPrecisions.
The Y axis attribute can be assigned dynamic properties by means of the name
YAxisAutoPrecisions.
The data type is BOOLEAN.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 705
VBS for Creating Procedures and Actions
1.14 VBS Reference
X/YAxisAutoRange property
Value range automatic - X/YAxisAutoRange
Enables automatic calculation of the value range of the axis selected.
Value Explanation
TRUE The range of values is calculated automatically.
FALSE The range of values is calculated based on the values configured in the "from" and "to" or "X/YAxisBeginValue"
and "X/YAxisEndValue" fields.
The X axis attribute can be assigned dynamic properties by means of the name
XAxisAutoRange.
The Y axis attribute can be assigned dynamic properties by means of the name
YAxisAutoRange.
The data type is BOOLEAN.
X/YAxisBeginValue property
Value range from - X/YAxisBeginValue
Specifies the lower range of values of the axis selected. You can configure the value if the
"Automatic" option is disabled or "X/YAxisAutoRange" is "FALSE".
The X axis attribute can be assigned dynamic properties by means of the name
XAxisBeginValue.
The Y axis attribute can be assigned dynamic properties by means of the name
YAxisBeginValue.
The data type is DOUBLE.
X/YAxisColor property
Color XY axis - X/YAxisColor
Specifies the color of the axis selected. The button opens the "Color selection" dialog to select
the color.
The setting is only active if the "Use trend color" field is disabled or "X/YAxisInTrendColor" is
"FALSE".
The X axis attribute can be assigned dynamic properties by means of the name XAxisColor.
The Y axis attribute can be assigned dynamic properties by means of the name YAxisColor.
The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
706 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
X/YAxisEndValue property
Value range to - X/YAxisEndValue
Specifies the upper range of values of the axis selected. You can configure the value if the
"Automatic" option is disabled or "X/YAxisAutoRange" is "FALSE".
The X axis attribute can be assigned dynamic properties by means of the name
XAxisEndValue.
The Y axis attribute can be assigned dynamic properties by means of the name
YAxisEndValue.
The data type is DOUBLE.
X/YAxisExponentialFormat property
Exponential notation - X/YAxisExponentialFormat
Enables the exponential notation for visualization of a selected axis.
Value Explanation
TRUE The values are displayed with exponential notation.
FALSE The values are displayed with decimal notation.
The X axis attribute can be assigned dynamic properties by means of the name
XAxisExponentialFormat.
The Y axis attribute can be assigned dynamic properties by means of the name
YAxisExponentialFormat.
The data type is BOOLEAN.
X/YAxisInTrendColor property
Use trend color - X/YAxisInTrendColor
Enables the display of an axis selected in the trend color. The color of the first trend is activated
if several trends are displayed in the trend window. Define the order of trends on the "Trends"
tab.
Value Explanation
TRUE The axis selected is displayed in the trend color. The setting in the "Color" or "X/YAxisColor"
field is disabled.
FALSE The axis selected is displayed in the color set in the "Color" or "X/YAxisColor" field.
The X axis attribute can be assigned dynamic properties by means of the name
XAxisInTrendColor.
The Y axis attribute can be assigned dynamic properties by means of the name
YAxisInTrendColor.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 707
VBS for Creating Procedures and Actions
1.14 VBS Reference
The data type is BOOLEAN.
X/YAxisLabel property
Label - X/YAxisLabel
Defines the label text for a selected axis.
The X axis attribute can be assigned dynamic properties by means of the name XAxisLabel.
The Y axis attribute can be assigned dynamic properties by means of the name YAxisLabel.
The data type is STRING.
X/YAxisName property
Object name - X/YAxisName
Specifies the name of a selected axis.
Attribute "XAxisName" can be assigned dynamic properties for the X axis by means of
XAxisRename attribute.
Attribute "YAxisName" can be assigned dynamic properties for the Y axis by means of
YAxisRename attribute.
The data type is STRING.
X/YAxisPrecisions property
Decimal places - X/YAxisPrecisions
Specifies the decimal precision for displaying the axis selected. The value can be configured
and is active in Runtime, if the "Automatic" option is disabled or "X/YAxisAutoPrecisions" is
"FALSE".
The X axis attribute can be assigned dynamic properties by means of the name
XAxisPrecisions.
The Y axis attribute can be assigned dynamic properties by means of the name
YAxisPrecisions.
The data type is SHORT.
X/YAxisRemove property
Remove - X/YAxisRemove
Removes the selected axis from the list.
WinCC: Scripting (VBS, ANSI-C, VBA)
708 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The X axis attribute can be assigned dynamic properties by means of the name
XAxisRemove .
The Y axis attribute can be assigned dynamic properties by means of the name
YAxisRemove .
The data type is STRING.
X/YAxisRepos property
Up/Down - X/YAxisRepos
Changes the sorting order of the axes. "Up" and "Down" move the axis selected up or down
in the list.
The list order determines the axis position in the trend window. The axis output position is
moved away from the trend if the axis is moved further up in the list and the orientation is the
same.
The X axis attribute can be assigned dynamic properties by means of the name XAxisRepos .
The Y axis attribute can be assigned dynamic properties by means of the name YAxisRepos .
The data type is LONG.
X/YAxisScalingType property
Scaling - X/YAxisScalingType
Defines the scaling mode for a selected axis.
The following settings are available:
Value Description
0 Linear
1 Logarithmic
2 Logarithmically negated
The X axis attribute can be assigned dynamic properties by means of the name
XAxisScalingType.
The Y axis attribute can be assigned dynamic properties by means of the name
YAxisScalingType.
The data type is LONG.
X/YAxisTrendWindow property
Trend window - X/YAxisTrendWindow
Specifies the trend window for a selected axis. Define the available trend windows in the "Trend
window" tab.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 709
VBS for Creating Procedures and Actions
1.14 VBS Reference
The X axis attribute can be assigned dynamic properties by means of the name
XAxisTrendWindow.
The Y axis attribute can be assigned dynamic properties by means of the name
YAxisTrendWindow.
The data type is STRING.
X/YAxisVisible property
X/Y axes - X/YAxisVisible
The list shows all axes you created. Click an axis entry in the list to adapt the properties and
to assign the axis to a trend window.
Activate the axes to be displayed in the trend windows in the list.
The X axis attribute can be assigned dynamic properties by means of the name
XAxisVisible .
The Y axis attribute can be assigned dynamic properties by means of the name
YAxisVisible .
The data type is BOOLEAN.
XAxisCount property
XAxisCount
Defines the number of X axes configured.
The attribute can be assigned dynamic properties by means of the name XAxisCount. The
data type is LONG.
XAxisIndex property
XAxisIndex
References a configured X axis. Using this attribute you can assign the values of other
attributes to a specific X axis.
Values between 0 and "XAxisCount" minus 1 are valid for "Index"; the attribute "XAxisCount"
defines the number of configured X axes.
The "XAxisIndex" attribute can be assigned dynamic properties by means of attribute
XAxisRepos. The data type is LONG.
WinCC: Scripting (VBS, ANSI-C, VBA)
710 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
XAxisRename property
XAxisRename
Renames the X axis which is referenced by means of "XAxisIndex" attribute.
The attribute can be assigned dynamic properties by means of the name XAxisRename.
"XAxisRename" also sets a dynamic attribute "XAxisName". The data type is STRING.
YAxisCount property
YAxisCount
Defines the number of Y axes configured.
The attribute can be assigned dynamic properties by means of the name YAxisCount. The
data type is LONG.
YAxisIndex property
YAxisIndex
References a configured Y axis. Using this attribute you can assign the values of other
attributes to a specific Y axis.
Values between 0 and "YAxisCount" minus 1 are valid for "Index". Attribute "YAxisCount"
defines the number of configured Y axes.
The "YAxisIndex" attribute can be assigned dynamic properties by means of attribute
YAxisRepos. The data type is LONG.
YAxisRename property
YAxisRename
Renames the Y axis which is referenced by means of "YAxisIndex" attribute.
The attribute can be assigned dynamic properties by means of the name YAxisRename.
"YAxisRename" also sets a dynamic attribute "YAxisName". The data type is STRING.
ZeroPoint Property
Description
Defines or returns the position of the zero point of the bar graph.
Specify the value as a %age of the total bar height. The zero point can also be outside of the
range represented.
The "ScalingType" property must be set to "2" and "Scaling" to TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 711
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
ScreenItem Object (Page 123)
Bar (Page 172)
ZeroPointValue Property
Description
Defines the value of the zero point of the scale indicator.
Defines or returns the absolute value for the zero point.
See also
Bar (Page 172)
3D Bar (Page 167)
ScreenItem Object (Page 123)
Zoom Property
Description
Sets the zoom factor within a picture or picture window or reads it out.
If the indicated zoom factor is smaller than the minimum value, the zoom factor is automatically
set to the minimum value. If the indicated zoom factor is larger than the minimum value, the
zoom factor is automatically set to the maximum value.
The minimum value of the zoom factor is at 2%, the maximum value at 800%.
With the Screen Object the zoom factor is indicated as a numeric value and with a picture
window object, it is indicated in percent.
Example:
The following example doubles the zoom factor of the current picture:
'VBS97
HMIRuntime.ActiveScreen.Zoom = HMIRuntime.ActiveScreen.Zoom * 2
See also
Picture Window (Page 177)
Screen Object (Page 129)
WinCC: Scripting (VBS, ANSI-C, VBA)
712 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.5 Methods
1.14.5.1 Methods
Overview
Methods, which are applied to individual objects, can be used to read out tag values for further
processing or displaying diagnostics messages in Runtime.
Available Methods in VBS
Activate GetStatusbarElement MoveToNext ShowInfoText
ActivateDynam‐ GetStatusbarElementCollection MoveToNextLine ShowLockDialog
ic
Add GetTimeAxis MoveToNextPage ShowLockList
AttachDB GetTimeAxisCollection MoveToPrevious ShowLongTermArchiveList
CalculateStatis‐ GetTimeColumn MoveToPreviousLine ShowMessageList
tic
CopyRows GetTimeColumnCollection MoveToPreviousPage ShowPercentageAxis
CreateTagSet GetToolbarButton NextColumn ShowPropertyDialog
CutRows GetToolbarButtonCollection NextTrend ShowSelectArchive
DeactivateDy‐ GetTrend OneToOneView ShowSelection
namic
DeleteRows GetTrendCollection PasteRows ShowSelectionDialog
DetachDB GetTrendWindow PreviousColumn ShowSelectTimeBase
Edit GetTrendWindowCollection PreviousTrend ShowShortTermArchiveList
Export GetValueAxis Print ShowSort
GetColumn GetValueAxisCollection QuitHorn ShowSortDialog
GetColumnCol‐ GetValueColumn QuitSelected ShowTagSelection
lection
GetHitlistCol‐ GetValueColumnCollection QuitVisible ShowTimebaseDialog
umn
GetHitlistCo‐ GetXAxis Read ShowTimeSelection
lumnCollection
GetMessage‐ GetXAxisCollection ReadTags ShowTrendSelection
Block
GetMessage‐ GetYAxis Refresh StartStopUpdate
BlockCollection
GetMessage‐ GetYAxisCollection Remove Stop
Column
GetMessage‐ HideAlarm RemoveAll Trace
ColumnCollec‐
tion
GetOperator‐ Item Method Restore UnhideAlarm
Message
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 713
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetOperator‐ LockAlarm SelectedStatisticArea UnlockAlarm
MessageCollec‐
tion
GetRulerBlock LoopInAlarm ServerExport Write
GetRulerBlock‐ MoveAxis ServerImport WriteTags
Collection
GetRulerCol‐ MoveRuler (Page 774) ShowColumnSelection ZoomArea
umn
GetRulerCo‐ MoveToFirst ShowComment ZoomInOut
lumnCollection
GetRulerData MoveToFirstLine ShowDisplayOptionsDialog ZoomInOutTime
GetStatisticAr‐ MoveToFirstPage ShowEmergencyQuitDialog ZoomInOutValues
eaColumn
GetStatisticAr‐ MoveToLast ShowHelp ZoomInOutX
eaColumnCol‐
lection
GetStatisticRe‐ MoveToLastLine ShowHideList ZoomInOutY
sultColumn
GetStatisticRe‐ MoveToLastPage ShowHitList ZoomMove
sultColumnCol‐
lection
1.14.5.2 Methods A to E
Activate Method
Function
Activates the specified picture and picture element, respectively.
Note
Focus assignments should not be configured during a ButtonDown event. Since the focus is
specifically requested during the ButtonDown event, invalid states may occur.
Syntax
Expression.Activate
Expression
Necessary. An expression which returns an object of type "Screen" or "ScreenItem".
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
714 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Examples
The following example shows the use for type "Screen":
'VBS98
Dim objScreen
MsgBox HMIRuntime.ActiveScreen.ObjectName 'Output of active screen
Set objScreen = HMIRuntime.Screens("ScreenWindow1")
objScreen.Activate 'Activate "ScreenWindow1"
MsgBox HMIRuntime.ActiveScreen.ObjectName 'New output of active screen
The following example shows the use for type "ScreenItem":
'VBS158
MsgBox HMIRuntime.ActiveScreen.ActiveScreenItem.ObjectName 'Output of active screen item
HMIRuntime.ActiveScreen.ScreenItems("IOField1").Activate
MsgBox HMIRuntime.ActiveScreen.ActiveScreenItem.ObjectName 'New output of active screen
item
See also
ScreenItem Object (Page 123)
Screen Object (Page 129)
ActivateDynamic method
Function
Dynamically activates a trigger for the defined property and with the defined cycle during
runtime. Every time the trigger is activated a different activation cycle can be used.
Examples of this method are available in chapter "VBS for creating procedures and action >
Creating and editing actions > Trigger > Animation trigger".
Syntax
Expression.ActivateDynamic (ByVAl bstrPropertyName As String, ByVal
bstrCycleName As String)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 715
VBS for Creating Procedures and Actions
1.14 VBS Reference
Parameters
Parameters Description
bstrPropertyName Name of property to which trigger relates.
bstrCycleName Name of activation cycle, e.g. "CycleTime1s".
See also
Animation trigger (Page 69)
Add Method
Description of TagSet Object
Adds a tag to the list. A tag may be added to the tag object by using name or reference.
syntax
Expression.Add [Tag]
Expression
Necessary. An expression which returns an object of type "TagSet".
Parameters
VARIANT
Parameters Description
Tag Name of a WinCC tag or reference to a tag object
to be added to the list.
Example:
In the following example, a TagSet object is generated and a tag is added.
'VBS170
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
WinCC: Scripting (VBS, ANSI-C, VBA)
716 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Tag objects may also be added as follows.
'VBS171
Dim Tag
Set Tag = HMIRuntime.Tags("Motor2")
Dim group2
Set group2 = HMIRuntime.Tags.CreateTagSet
group2.Add Tag
Description of DataSet Object
Adds a value or object reference to the list.
Note
The Data Set Object does not support classes.
Objects of type Screen, Screens, ScreenItem, ScreenItems, Tag and TagSet cannot be
included in the DataSet list.
For object references it must be ascertained that objects are multiread-enabled.
syntax
Expression.Add [vtName], [vtUserData]
Expression
Necessary. An expression which returns an object of type "DataSet".
Parameters
VARIANT
Parameters Description
vtName Name by which value or tag are to be added to list.
vtUserData Value to be added to list.
Example:
In this example, a value is included in the DataSet list.
'VBS172
HMIRuntime.DataSet.Add "Motor1",23
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 717
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
TagSet Object (List) (Page 139)
DataSet Object (List) (Page 113)
AttachDB method
Function
Executes the "Connect backup" key function of the control.
Syntax
Ausdruck.AttachDB()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
CalculateStatistic method
Function
Executes the "Calculate statistics" key function of the OnlineTrendControl and
OnlineTableControl.
Syntax
Ausdruck.CalculateStatistic()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
CopyRows method
Function
Executes the "Copy lines" key function of the control.
WinCC: Scripting (VBS, ANSI-C, VBA)
718 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Syntax
Ausdruck.CopyRows()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
Create method
Function
Creates a new Alarm object.
Syntax
Expression.Create (VARIANT vtApplication)
Expression
Necessary. An expression which returns an object of type "Alarm".
Parameters
VARIANT
Parameters Description
vtApplication Name of alarm object (optional)
See also
Alarms object (list) (Page 108)
CreateTagSet Method
Function
Creates a new TagSet object. This object may be used for optimized multi-tag access.
syntax
Expression.CreateTagSet()
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 719
VBS for Creating Procedures and Actions
1.14 VBS Reference
Expression
Necessary. An expression which returns an object of type "TagSet".
Parameters
VARIANT
Example:
The following example shows how to create a TagSet object.
'VBS168
'Build a Reference to the TagSet Object
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
See also
TagSet Object (List) (Page 139)
Tags Object (List) (Page 137)
CutRows method
Function
Executes the "Cut lines" key function of the UserArchiveControl.
Syntax
Ausdruck.CutRows()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
DeactivateDynamic method
Function
Deactivates the trigger used with the "ActivateDynamic" method for the defined property during
runtime.
WinCC: Scripting (VBS, ANSI-C, VBA)
720 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Syntax
Ausdruck.DeactivateDynamic(ByVal bstrPropertyName As String)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
String
Parameters Description
bstrPropertyName Name of property to which trigger relates.
DeleteRows method
Function
Executes the "Delete Rows" key function of the UserArchiveControl.
Syntax
Ausdruck.DeleteRows()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
DetachDB method
Function
Executes the "Disconnect backup" key function of the control.
Syntax
Ausdruck.DetachDB()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 721
VBS for Creating Procedures and Actions
1.14 VBS Reference
Parameters
--
Edit method
Function
Executes the "Edit" key function of the OnlineTableControl.
Syntax
Ausdruck.Edit()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
Export Method
Function
Executes the "Export archive" or "Export data" key function of the control.
Syntax
Ausdruck.Export()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
WinCC: Scripting (VBS, ANSI-C, VBA)
722 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.5.3 Get methods
GetColumn method
Function
Returns the name or index designated column object of the WinCC UserArchiveControl as
type "ICCAxUAColumn".
Syntax
Ausdruck.GetColumn(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of column of UserArchiveControl.
Example
'VBS312
Dim ctrl
Dim objColumn
Set ctrl = ScreenItems("UAControl")
Set objColumn = ctrl.GetColumn("Field1")
objColumn.Length = 30
Set objColumn = ctrl.GetColumn(3)
objColumn.Align = 2
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "Column" listing, for example, you write "objColumn.Align" instead of
"objColumn.ColumnAlign".
See also
Column object (list) (Page 219)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 723
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetColumnCollection method
Function
Returns the list of all column objects of the WinCC UserArchiveControl as type
"ICCAxCollection".
Syntax
Ausdruck.GetColumnCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
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
'VBS313
Dim ctrl
Dim coll
Dim field
Set ctrl = ScreenItems("UAControl")
Set coll = ctrl.GetColumnCollection
HMIRuntime.Trace "Number of fields:" & coll.Count & vbCrLf
For Each field In coll
HMIRuntime.Trace field.Name & vbCrLf
HMIRuntime.Trace field.Type & vbCrLf
HMIRuntime.Trace field.Length & vbCrLf
HMIRuntime.Trace field.Caption & vbCrLf
Next
See also
Column object (list) (Page 219)
WinCC: Scripting (VBS, ANSI-C, VBA)
724 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetHitlistColumn method
Function
Returns the name or index designated column object of the hitlist of the WinCC AlarmControl
as type "ICCAxMessageColumn".
Syntax
Expression.GetHitlistColumn(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of hitlist column
Example
'VBS314
Dim ctrl
Dim objHitlistColumn
Set ctrl = ScreenItems("AlarmControl")
Set objHitlistColumn = ctrl.GetHitlistColumn("Date")
objHitlistColumn.Sort = 2
Set objHitlistColumn = ctrl.GetHitlistColumn("AverageComeGo")
objHitlistColumn.Visible = FALSE
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "HitlistColumn" listing, for example, you write "objHitlistColumn.Visible" instead of
"objHitlistColumn.HitlistColumnVisible".
See also
HitlistColumn object (list) (Page 220)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 725
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetHistlistColumnCollection method
Function
Returns the list of all column objects of the WinCC AlarmControl hitlist as type
"ICCAxCollection".
Syntax
Expression.GetHitlisteColumnCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
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
'VBS315
Dim ctrl
Dim coll
Dim hitlistcol
Set ctrl = ScreenItems("AlarmControl")
Set coll = ctrl.GetHitlistColumnCollection
HMIRuntime.Trace "Number of hitlist columns:" & coll.Count & vbCrLf
For Each hitlistcol In coll
HMIRuntime.Trace hitlistcol.Index & vbCrLf
HMIRuntime.Trace hitlistcol.Name & vbCrLf
HMIRuntime.Trace hitlistcol.Sort & vbCrLf
HMIRuntime.Trace hitlistcol.SortIndex & vbCrLf
Next
See also
HitlistColumn object (list) (Page 220)
WinCC: Scripting (VBS, ANSI-C, VBA)
726 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetMessageBlock method
Function
Returns the name or index designated message block object of the WinCC AlarmControl as
type "ICCAxMessageBlock".
Syntax
Expression.GetMessageBlock(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of message block.
Example
'VBS316
Dim ctrl
Dim objMsgBlock
Set ctrl = ScreenItems("AlarmControl")
Set objMsgBlock = ctrl.GetMessageBlock("Date")
objMsgBlock.Align = 2
Set objMsgBlock = ctrl.GetMessageBlock("Number")
objMsgBlock.LeadingZeros = 4
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "MessageBlock" listing, for example, you write "objMsgBlock.Align" instead of
"objMsgBlock.MessageBlockAlign".
See also
MessageBlock object (list) (Page 221)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 727
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetMessageBlockCollection method
Function
Returns the list of all message block objects of the WinCC AlarmControl as type
"ICCAxCollection".
Syntax
Expression.GetMessageBlockCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
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
'VBS317
Dim ctrl
Dim coll
Dim msgblock
Set ctrl = ScreenItems("AlarmControl")
Set coll = ctrl.GetMessageBlockCollection
For Each msgblock In coll
msgblock.Align = 1
msgblock.Length = 12
msgblock.Selected = TRUE
Next
WinCC: Scripting (VBS, ANSI-C, VBA)
728 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "MessageBlock" listing, for example, you write "msgblock.Align" instead of
"msgblock.MessageBlockAlign".
See also
MessageBlock object (list) (Page 221)
GetMessageColumn method
Function
Returns the name or index designated column object of the WinCC AlarmControl as type
"ICCAxMessageColumn".
Syntax
Expression.GetMessageColumn(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of column in message list.
Example
'VBS318
Dim ctrl
Dim objMessColumn
Set ctrl = ScreenItems("AlarmControl")
Set objMessColumn = ctrl.GetMessageColumn("Date")
objMessColumn.Visible = FALSE
Set objMessColumn = ctrl.GetMessageColumn("Number")
objMessColumn.Sort = 1
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 729
VBS for Creating Procedures and Actions
1.14 VBS Reference
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "MessageColumn" listing, for example, you write "objMessColumn.Visible" instead of
"objMessColumn.MessageColumnVisible".
See also
MessageColumn object (list) (Page 221)
GetMessageColumnCollection method
Function
Returns the list of all column objects of the WinCC AlarmControl as type "ICCAxCollection".
Syntax
Expression.GetMessageColumnCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
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)
WinCC: Scripting (VBS, ANSI-C, VBA)
730 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
'VBS319
Dim ctrl
Dim coll
Dim msgcol
Set ctrl = ScreenItems("AlarmControl")
Set coll = ctrl.GetMessageColumnCollection
HMIRuntime.Trace "Number of message columns:" & coll.Count & vbCrLf
For Each msgcol In coll
HMIRuntime.Trace msgcol.Index & vbCrLf
HMIRuntime.Trace msgcol.Name & vbCrLf
HMIRuntime.Trace msgcol.Sort & vbCrLf
HMIRuntime.Trace msgcol.SortIndex & vbCrLf
Next
See also
MessageColumn object (list) (Page 221)
GetOperatorMessage method
Function
Returns the name or index designated operator message object of the WinCC AlarmControl
as type "ICCAxOperatorMessage".
Syntax
Expression.GetOperatorMessage(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of operator message
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 731
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
'VBS320
Dim ctrl
Dim objOpMess
Set ctrl = ScreenItems("AlarmControl")
Set objOpMess = ctrl.GetOperatorMessage(0)
objOpMess.Source1 = "Number"
objOpMess.SourceType1 = 1
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "OperatorMessage" listing, for example, you write "objOpMess.Source1" instead of
"objOpMess.OperatorMessageSource1".
See also
OperatorMessage object (list) (Page 222)
GetOperatorMessageCollection method
Function
Returns the list of all operator message objects of the WinCC AlarmControl as type
"ICCAxCollection".
Syntax
Expression.GetOperatorMessageCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
Features and functions of the ICCAxCollection
The following properties are available for the ICCAxCollection:
● Count
● Item
WinCC: Scripting (VBS, ANSI-C, VBA)
732 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The following functions are available for the ICCAxCollection:
● AddItem(vName) As Object
● RemoveItem(vIndex)
Example
'VBS321
Dim ctrl
Dim coll
Dim opmsg
Set ctrl = ScreenItems("AlarmControl")
Set coll = ctrl.GetOperatorMessageCollection
For Each opmsg In coll
HMIRuntime.Trace opmsg.Index & vbCrLf
HMIRuntime.Trace opmsg.Name & vbCrLf
HMIRuntime.Trace opmsg.Number & vbCrLf
HMIRuntime.Trace opmsg.Selected & vbCrLf
Next
See also
OperatorMessage object (list) (Page 222)
GetRow method
Function
Returns the row number designated row object of the table-based controls as type
"ICCAxDataRow".
Syntax
Expression.GetRow(ByVal IRow As Long)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
Long
Parameters Description
IRow Number of the desired line of the control.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 733
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
'VBS356
Dim ctrl
Dim lIndex
Dim lCellIndex
Set ctrl = ScreenItems("UAControl")
Set coll = ctrl.GetRowCollection
'enumerate and trace out row numbers
For lIndex = 1 To coll.Count
HMIRuntime.trace "Row: " & (ctrl.GetRow(lIndex).RowNumber) & " "
'enumerate and trace out column titles and cell texts
For lCellIndex = 1 To ctrl.GetRow(lIndex).CellCount
HMIRuntime.Trace ctrl.GetRow(0).CellText(lCellIndex) & " "
HMIRuntime.trace ctrl.GetRow(lIndex).CellText(lCellIndex) & " "
Next
HMIRuntime.trace vbNewLine
Next
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "Row" listing, for example, you write "objRow.CellCount" instead of
"objRow.RowCellCount".
See also
Row object (list) (Page 223)
GetRowCollection method
Function
Returns the list of all row objects of the table-based controls type "ICCAxDataRowCollection".
Syntax
Expression.GetRowCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
734 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Properties of the ICCAxDataRowCollection
The ICCAxDataRowCollection refers to runtime data. The data is read-only. It is not possible
to add and edit the data.
The following properties are available for the ICCAxDataRowCollection:
● Count - Determines the number of rows in the collection.
● Item - Access to an individual row within the collection via the row number. Numbering runs
from 1 to Count. A Row object is returned.
Example
'VBS357
Dim ctrl
Dim coll
Dim lIndex
Dim lCellIndex
Set ctrl = ScreenItems("AlarmControl")
Set coll = ctrl.GetRowCollection
HMIRuntime.Trace "Number of message rows:" & coll.Count & vbCrLf
'enumerate and trace out row numbers
For lIndex = 1 To coll.Count
HMIRuntime.Trace "Row: " & (ctrl.GetRow(lIndex).RowNumber) & " "
'enumerate and trace out column titles and cell texts
For lCellIndex = 1 To ctrl.GetRow(lIndex).CellCount
HMIRuntime.Trace ctrl.GetMessageColumn(lCellIndex -1).Name & " "
HMIRuntime.Trace ctrl.GetRow(lIndex).CellText(lCellIndex) & " "
Next
HMIRuntime.Trace vbNewLine
Next
See also
Row object (list) (Page 223)
GetRulerBlock method
Function
Returns the Block object designated as name or index of the WinCC RulerControl as type
"ICCAxRulerBlock".
Syntax
Expression.GetRulerBlock(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 735
VBS for Creating Procedures and Actions
1.14 VBS Reference
Parameters
VARIANT
Parameters Description
vIndex Index or name of block in RulerControl
Example
'VBS322
Dim ctrl
Dim objRulerBlock
Set ctrl = ScreenItems("RulerControl")
Set objRulerBlock = ctrl.GetRulerBlock(0)
objRulerBlock.Caption = "RulerBlock1"
Set objRulerBlock = ctrl.GetRulerBlock("Name")
objRulerBlock.Length = 10
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "RulerBlock" listing, for example, you write "objRulerBlock.Caption" instead of
"objRulerBlock.BlockCaption".
See also
RulerBlock object (list) (Page 224)
GetRulerBlockCollection method
Function
Returns the list of all Block objects of the WinCC RulerControl as type "ICCAxCollection".
Syntax
Expression.GetRulerBlockCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
736 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
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
'VBS323
Dim ctrl
Dim coll
Dim rulerblock
Set ctrl = ScreenItems("RulerControl")
Set coll = ctrl.GetRulerBlockCollection
For Each rulerblock In coll
rulerblock.Align = 1
rulerblock.Length = 12
Next
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "RulerBlock" listing, for example, you write "rulerblock.Align" instead of
"rulerblock.RulerBlockAlign".
See also
RulerBlock object (list) (Page 224)
GetRulerColumn method
Function
Returns the Column object designated as name or index of the WinCC RulerControl as type
"ICCAxRulerColumn".
Syntax
Expression.GetRulerColumn(ByVal vIndex As Variant)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 737
VBS for Creating Procedures and Actions
1.14 VBS Reference
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of column of RulerControl.
Example
'VBS324
Dim ctrl
Dim objRulercol
Set ctrl = ScreenItems("RulerControl")
Set objRulercol = ctrl.GetRulerColumn("Name")
objRulercol.Sort = 0
Set objRulercol = ctrl.GetRulerColumn("ValueY")
objRulercol.Visible = FALSE
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "RulerColumn" listing, for example, you write "objRulercol.Visible" instead of
"objRulercol.ColumnVisible".
See also
RulerColumn object (list) (Page 225)
GetRulerColumnCollection method
Function
Returns the list of all Column objects of the WinCC RulerControl as type "ICCAxCollection".
Syntax
Expression.GetRulerColumnCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
738 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
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
'VBS325
Dim ctrl
Dim coll
Dim rulercol
Set ctrl = ScreenItems("RulerControl")
Set coll = ctrl.GetRulerColumnCollection
HMIRuntime.Trace "Number of ruler columns:" & coll.Count & vbCrLf
For Each rulercol In coll
HMIRuntime.Trace rulercol.Index & vbCrLf
HMIRuntime.Trace rulercol.Name & vbCrLf
HMIRuntime.Trace rulercol.Sort & vbCrLf
HMIRuntime.Trace rulercol.SortIndex & vbCrLf
Next
See also
RulerColumn object (list) (Page 225)
GetRulerData method
Function
Returns the value of the called trend at the ruler position.
Syntax
Expression.GetRulerData(ByVal RulerIndex As Long, pvValue As
Variant, Optional pvTimeStamp As Variant, Optional pvFlags As
Variant) Long
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 739
VBS for Creating Procedures and Actions
1.14 VBS Reference
Expression
Necessary. An expression which returns an object of the "Trend" type.
Parameters
Parameters Description
RulerIndex 0 =Ruler
pvValue Value of X axis
pvTimeStamp Time or value of the Y axis
pvFlags Low word shows that "pvFlags" is a quality code (0x00001000)
High word: shows the actual quality code, e.g. (0x801000) for "Good (non-cas‐
cade)"
Example
'VBS326
Dim ctrl
Dim objTrend
Dim objIOField1
Dim objIOField2
Dim value
Dim time
Set ctrl = ScreenItems( "Control1" )
Set objTrend = ctrl.GetTrend( "Trend 1" )
Set objIOField1 = ScreenItems( "I/O Field1" )
Set objIOField2 = ScreenItems( "I/O Field2" )
objTrend.GetRulerData 0, value, time
objIOField1.OutputValue = value
objIOField2.OutputValue = time
GetSelectedRow method
Function
Returns the selected row object of the table-based controls as type "ICCAxDataRow".
Syntax
Expression.GetSelectedRow()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
740 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
'VBS358
Dim ctrl
Dim lCellIndex
Dim lCellCount
Dim headingRow
Dim selectedRow
Set ctrl = ScreenItems("TableControl")
Set headingRow = ctrl.GetRow(0)
Set selectedRow = ctrl.GetSelectedRow
lCellCount = headingRow.CellCount
'enumerate and trace out column titles and cell texts
For lCellIndex = 1 To lCellCount
HMIRuntime.trace headingRow.CellText(lCellIndex) & ": "
HMIRuntime.trace selectedRow.CellText(lCellIndex)
HMIRuntime.trace vbNewLine
Next
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "Row" listing, for example, you write "objRow.CellCount" instead of
"objRow.RowCellCount".
See also
Row object (list) (Page 223)
GetSelectedRows method
Function
Returns the selected row objects of the table-based controls as type "ICCAxDataRow"for
multiple selection.
Syntax
Expression.GetSelectedRows()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 741
VBS for Creating Procedures and Actions
1.14 VBS Reference
Parameters
--
Example
'VBS359
Dim ctrl
Dim lCellIndex
Dim lCellCount
Dim lRowIndex
Dim lRowCount
Dim headingRow
Dim selectedRow
Dim selectedRows
Set ctrl = ScreenItems("TableControl")
Set headingRow = ctrl.GetRow(0)
Set selectedRows = ctrl.GetSelectedRows
lCellCount = headingRow.CellCount
lRowCount = selectedRows.Count
'enumerate selected rows
For lRowIndex = 1 To lRowCount
Set selectedRow = selectedRows(lRowIndex)
HMIRuntime.Trace "Row number: " & CStr(lRowIndex) & vbNewLine
'enumerate and trace out column titles and cell texts
For lCellIndex = 1 To lCellCount
HMIRuntime.trace headingRow.CellText(lCellIndex) & ": "
HMIRuntime.trace selectedRow.CellText(lCellIndex)
HMIRuntime.trace vbNewLine
Next
Next
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "Row" listing, for example, you write "objRow.CellCount" instead of
"objRow.RowCellCount".
See also
Row object (list) (Page 223)
WinCC: Scripting (VBS, ANSI-C, VBA)
742 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetStatisticAreaColumn method
Function
Returns the name or index designated Column object of the WinCC RulerControl statistics
area window as type "ICCAxRulerColumn".
Syntax
Ausdruck.GetStatisticAreaColumn(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of column of statistics area window.
Example
'VBS327
Dim ctrl
Dim objStatAreaCol
Set ctrl = ScreenItems("RulerControl")
Set objStatAreaCol = ctrl.GetStatisticAreaColumn("DatasourceY")
objStatAreaCol.Visible = FALSE
Set objStatAreaCol = ctrl.GetStatisticAreaColumn("ValueY(LL)")
objStatAreaCol.Sort = 1
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "StatisticAreaColumn" listing, for example, you write "objStatAreaCol.Visible" instead
of "objStatAreaCol.ColumnVisible".
See also
StatisticAreaColumn object (list) (Page 226)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 743
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetStatisticAreaColumnCollection method
Function
Returns the list of all column objects of the WinCC RulerControl statistics area window as type
"ICCAxCollection".
Syntax
Ausdruck.GetStatisticAreaColumnCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
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
'VBS328
Dim ctrl
Dim coll
Dim statcol
Set ctrl = ScreenItems("RulerControl")
Set coll = ctrl.GetStatisticAreaColumnCollection
HMIRuntime.Trace "Number of statistic Area columns:" & coll.Count & vbCrLf
For Each statcol In coll
HMIRuntime.Trace statcol.Index & vbCrLf
HMIRuntime.Trace statcol.Name & vbCrLf
HMIRuntime.Trace statcol.Sort & vbCrLf
HMIRuntime.Trace statcol.SortIndex & vbCrLf
Next
See also
StatisticAreaColumn object (list) (Page 226)
WinCC: Scripting (VBS, ANSI-C, VBA)
744 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetStatisticResultColumn method
Function
Returns the name or index designated Column object of the WinCC RulerControl statistics
window as type "ICCAxRulerColumn".
Syntax
Ausdruck.GetStatisticResultColumn(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of column of statistics window.
Example
'VBS329
Dim ctrl
Dim objStatResCol
Set ctrl = ScreenItems("RulerControl")
Set objStatResCol = ctrl.GetStatisticResultColumn("MaxValue")
objStatResCol.Visible = FALSE
Set objStatResCol = ctrl.GetStatisticResultColumn("Average")
objStatResCol.Sort = 2
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "StatisticResultColumn" listing, for example, you write "objStatResCol.Visible" instead
of "objStatResCol.ColumnVisible".
See also
StatisticResultColumn object (list) (Page 226)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 745
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetStatisticResultColumnCollection method
Function
Returns the list of all Column objects of the WinCC RulerControl statistics window as type
"ICCAxCollection".
Syntax
Ausdruck.GetStatisticResultColumnCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
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
'VBS330
Dim ctrl
Dim coll
Dim statcol
Set ctrl = ScreenItems("RulerControl")
Set coll = ctrl.GetStatisticResultColumnCollection
HMIRuntime.Trace "Number of statistic result columns:" & coll.Count & vbCrLf
For Each statcol In coll
HMIRuntime.Trace statcol.Index & vbCrLf
HMIRuntime.Trace statcol.Name & vbCrLf
HMIRuntime.Trace statcol.Sort & vbCrLf
HMIRuntime.Trace statcol.SortIndex & vbCrLf
Next
See also
StatisticResultColumn object (list) (Page 226)
WinCC: Scripting (VBS, ANSI-C, VBA)
746 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetStatusbarElement method
Function
Returns the element of the control status bar designated as name or index as type
"ICCAxStatusbarElement".
Syntax
Ausdruck.GetStatusbarElement(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of status bar element.
Example
'VBS331
Dim ctrl
Dim objStatusBar
Set ctrl = ScreenItems( "Control1" )
Set objStatusBar = ctrl.GetStatusbarElement(1)
objStatusBar.Visible = FALSE
Set objStatusBar = ctrl.GetStatusbarElement(3)
objStatusBar.Width = 10
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "StatusbarElement" listing, for example, you write "objStatusBar.Visible" instead of
"objStatusBar.StatusbarElementVisible".
See also
StatusbarElement object (list) (Page 227)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 747
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetStatusbarElementCollection method
Function
Returns the list of all status bar elements of the control as type "ICCAxCollection".
Syntax
Ausdruck.GetStatusbarElementCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
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
'VBS332
Dim ctrl
Dim coll
Dim statelement
Set ctrl = ScreenItems.Item("Control1")
Set coll = ctrl.GetStatusbarElementCollection
HMIRuntime.Trace "Number of statusbar elements:" & coll.Count & vbCrLf
For Each statelement In coll
HMIRuntime.Trace statelement.Name & vbCrLf
HMIRuntime.Trace statelement.Width & vbCrLf
HMIRuntime.Trace statelement.Text & vbCrLf
Next
WinCC: Scripting (VBS, ANSI-C, VBA)
748 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "StatusbarElement" listing, for example, you write "statelement.Name" instead of
"statelement.StatusbarElementName".
See also
StatusbarElement object (list) (Page 227)
GetTimeAxis method
Function
Returns the time axis object designated as name or index of the WinCC OnlineTrendControl
as type "ICCAxTimeAxis".
Syntax
Ausdruck.GetTimeAxis(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of time axis.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 749
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
'VBS333
Dim ctrl
Dim objTimeAxis
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTimeAxis = ctrl.GetTimeAxis(1)
objTimeAxis.Visible = FALSE
Set objTimeAxis = ctrl.GetTimeAxis("axis 2")
objTimeAxis.Label = "Time axis 2"
objTimeAxis.DateFormat = "dd.MM.yy"
objTimeAxis.TimeFormat = "HH:mm:ss.ms"
objTimeAxis.RangeType = 2
objTimeAxis.BeginTime = "06.04.2010 9:33:18"
objTimeAxis.MeasurePoints = 100
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "TimeAxis" listing, for example, you write "objTimeAx.Visible" instead of
"objTimeAx.TimeAxisVisible".
See also
TimeAxis object (list) (Page 228)
GetTimeAxisCollection method
Function
Returns the list of all time axis objects of the WinCC OnlineTrendControl as type
"ICCAxCollection".
Syntax
Ausdruck.GetTimeAxisCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
750 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
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
'VBS334
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis1
Dim objTimeAxis2
Dim objTrend
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindowCollection.AddItem("myWindow")
Set objTimeAxis1 = ctrl.GetTimeAxisCollection.AddItem("TimeAxis2010")
Set objTimeAxis2 = ctrl.GetTimeAxisCollection.AddItem("TimeAxis2011")
objTimeAxis1.TrendWindow = objTrendWnd.Name
objTimeAxis1.Label = "2010"
objTimeAxis1.RangeType = 1
objTimeAxis1.BeginTime = "01.01.2010 0:00:00"
objTimeAxis1.EndTime = "31.12.2010 11:59:59"
objTimeAxis2.TrendWindow = objTrendWnd.Name
objTimeAxis2.Label = "2011"
objTimeAxis2.RangeType = 1
objTimeAxis2.BeginTime = "01.01.2011 0:00:00"
objTimeAxis2.EndTime = "31.12.2011 11:59:59"
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend1")
objTrend.TrendWindow = objTrendWnd.Name
objTrend.TimeAxis = objTimeAxis1.Name
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend2")
objTrend.TrendWindow = objTrendWnd.Name
objTrend.TimeAxis = objTimeAxis2.Name
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "TimeAxis" listing, for example, you write "objTimeAxis1.Label" instead of
"objTimeAxis1.TimeAxisLabel".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 751
VBS for Creating Procedures and Actions
1.14 VBS Reference
See also
TimeAxis object (list) (Page 228)
GetTimeColumn method
Function
Returns the time column object designated as name or index of the WinCC OnlineTableControl
as type "ICCAxTimeColumn".
Syntax
Ausdruck.GetTimeColumn(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of time column.
Example
'VBS335
Dim ctrl
Dim objTimeCol
Set ctrl = ScreenItems("TableControl")
Set objTimeCol = ctrl.GetTimeColumn("Timecolumn1")
objTimeCol.ShowDate = FALSE
Set objTimeCol = ctrl.GetTimeColumn("Timecolumn2")
objTimeCol.Visible = FALSE
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "TimeColumn" listing, for example, you write "objTimeColumn.ShowDate" instead of
"objTimeColumn.TimeColumnShowDate".
See also
TimeColumn object (list) (Page 229)
WinCC: Scripting (VBS, ANSI-C, VBA)
752 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetTimeColumnCollection method
Function
Returns the list of all time column objects of the WinCC OnlineTableControl as type
"ICCAxCollection".
Syntax
Ausdruck.GetTimeColumnCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
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)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 753
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
'VBS336
Dim ctrl
Dim objTimeCol1
Dim objTimeCol2
Dim coll
Dim timecol
Set ctrl = ScreenItems("TableControl")
Set objTimeCol1 = ctrl.GetTimeColumnCollection.AddItem("TimeColumn2010")
Set objTimeCol2 = ctrl.GetTimeColumnCollection.AddItem("TimeColumn2011")
objTimeCol1.Caption = "2010"
objTimeCol1.RangeType = 1
objTimeCol1.BeginTime = "01.01.2010 0:00:00"
objTimeCol1.EndTime = "31.12.2010 11:59:59"
objTimeCol2.Caption = "2011"
objTimeCol2.RangeType = 0
objTimeCol2.BeginTime = "01.01.2011 0:00:00"
objTimeCol2.TimeRangeFactor = 1
objTimeCol2.TimeRangeBase = 3600000
Set coll = ctrl.GetTimeColumnCollection
For Each timecol In coll
timecol.Align = 1
timecol.Length = 12
timecol.BackColor = RGB(240,240,0)
timecol.ForeColor = RGB(130,160,255)
Next
See also
TimeColumn object (list) (Page 229)
GetToolbarButton method
Function
Returns the name or index designated toolbar button function of the control as type
"ICCAxToolbarButton".
Syntax
Ausdruck.GetToolbarButton(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
754 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Parameters
VARIANT
Parameters Description
vIndex Index or name of toolbar button function.
Example
'VBS337
Dim ctrl
Set ctrl = ScreenItems( "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
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "ToolbarButton" listing, for example, you write "toolbu.Index" instead of
"toolbu.ToolbarButtonIndex".
See also
ToolbarButton object (list) (Page 230)
GetToolbarButtonCollection method
Function
Returns the list of all toolbar button functions of the control as type "ICCAxCollection".
Syntax
Ausdruck.GetToolbarButtonCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 755
VBS for Creating Procedures and Actions
1.14 VBS Reference
Features and functions of the ICCAxCollection
The following properties are available for the ICCAxCollection:
● Count
● Item
The following methods are available for the ICCAxCollection:
● AddItem(vName) As Object
● RemoveItem(vIndex)
Example
'VBS338
Dim ctrl
Dim coll
Dim toolbu
Set ctrl = ScreenItems( "Control1" )
Set coll = ctrl.GetToolbarButtonCollection
HMIRuntime.Trace "Number of toolbar buttons:" & coll.Count & vbCrLf
For Each toolbu In coll
HMIRuntime.Trace toolbu.Name & vbCrLf
HMIRuntime.Trace "Hotkey: " & toolbu.HotKey & vbCrLf
HMIRuntime.Trace "Authorization: " & toolbu.PasswordLevel & vbCrLf
Next
See also
ToolbarButton object (list) (Page 230)
GetTrend method
Function
Returns the trend object designated as name or index of the WinCC OnlineTrendControl or
WinCC FunctionTrendControl as type "ICCAxTrend" or "ICCAxFunctionTrend".
Syntax
Ausdruck.GetTrend(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
756 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Parameters
VARIANT
Parameters Description
vIndex Index or name of curve.
Example
'VBS339
Dim ctrl
Dim objTrend
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrend = ctrl.GetTrend( "Trend 1" )
objTrend.PointStyle = 1
objTrend.LineWidth = 4
Set objTrend = ctrl.GetTrend(2)
objTrend.Provider = 1
objTrend.TagName = "Archive\ArchiveTag2"
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "Trend" listing, for example, you write "objTrend.PointStyle" instead of
"objTrend.TrendPointStyle".
See also
Trend object (list) (Page 231)
GetTrendCollection method
Function
Returns the list of all trend objects of the WinCC OnlineTrendControl or WinCC
FunctionTrendControl as type "ICCAxCollection".
Syntax
Ausdruck.GetTrendCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 757
VBS for Creating Procedures and Actions
1.14 VBS Reference
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
'VBS340
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis
Dim objValAxis
Dim objTrend
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindowCollection.AddItem("myWindow")
Set objTimeAxis = ctrl.GetTimeAxisCollection.AddItem("myTimeAxis")
Set objValAxis = ctrl.GetValueAxisCollection.AddItem("myValueAxis")
objTimeAxis.TrendWindow = objTrendWnd.Name
objValAxis.TrendWindow = objTrendWnd.Name
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend1")
objTrend.Provider = 1
objTrend.TagName = "Archive\ArchiveTag1"
objTrend.TrendWindow = objTrendWnd.Name
objTrend.TimeAxis = objTimeAxis.Name
objTrend.ValueAxis = objValAxis.Name
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "Trend" listing, for example, you write "objTrend.TagName" instead of
"objTrend.TrendTagName".
See also
Trend object (list) (Page 231)
WinCC: Scripting (VBS, ANSI-C, VBA)
758 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetTrendWindow method
Function
Returns the trend window object designated as name or index of the WinCC
OnlineTrendControl or WinCC FunctionTrendControl as type "ICCAxTrendWindow".
Syntax
Ausdruck.GetTrendWindow(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of curve window.
Example
'VBS341
Dim ctrl
Dim objTrendWnd
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindow(1)
objTrendWnd.Visible = FALSE
Set objTrendWnd = ctrl.GetTrendWindow("trend window 2")
objTrendWnd.VerticalGrid = TRUE
objTrendWnd.FineGrid = TRUE
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "TrendWindow" listing, for example, you write "objTrendWnd.Visible" instead of
"objTrendWnd.TrendWindowVisible".
See also
TrendWindow object (list) (Page 232)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 759
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetTrendWindowCollection method
Function
Returns the list of all trend window objects of the WinCC OnlineTrendControl or WinCC
FunctionTrendControl as type "ICCAxCollection".
Syntax
Ausdruck.GetTrendWindowCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
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
'VBS342
Dim ctrl
Dim objTrendWnd
Dim objTimeAxis
Dim objValAxis
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindowCollection.AddItem("myWindow")
Set objTimeAxis = ctrl.GetTimeAxisCollection.AddItem("myTimeAxis")
Set objValAxis = ctrl.GetValueAxisCollection.AddItem("myValueAxis")
objTimeAxis.TrendWindow = objTrendWnd.Name
objValAxis.TrendWindow = objTrendWnd.Name
See also
TrendWindow object (list) (Page 232)
WinCC: Scripting (VBS, ANSI-C, VBA)
760 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetValueAxis method
Function
Returns the value axis object designated as name or index of the WinCC OnlineTrendControl
as type "ICCAxValueAxis".
Syntax
Ausdruck.GetValueAxis(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of value axis.
Example
'VBS343
Dim ctrl
Dim objValAxis
Set ctrl = ScreenItems("OnlineTrendControl")
Set objValAxis = ctrl.GetValueAxis(1)
objValAxis.Visible = FALSE
Set objValAxis = ctrl.GetValueAxis("axis 2")
objValAxis.Label = "Value axis 2"
objValAxis.ScalingType = 0
objValAxis.Precisions = 2
objValAxis.AutoRange = TRUE
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "ValueAxis" listing, for example, you write "objValueAx.Visible" instead of
"objValueAx.ValueAxisVisible".
See also
ValueAxis object (list) (Page 233)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 761
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetValueAxisCollection method
Function
Returns the list of all value axis objects of the WinCC OnlineTrendControl as type
"ICCAxCollection".
Syntax
Ausdruck.GetValueAxisCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
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)
WinCC: Scripting (VBS, ANSI-C, VBA)
762 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
'VBS344
Dim ctrl
Dim objTrendWnd
Dim objValAxis1
Dim objValAxis2
Dim objTrend
Set ctrl = ScreenItems("OnlineTrendControl")
Set objTrendWnd = ctrl.GetTrendWindowCollection.AddItem("myWindow")
Set objValAxis1 = ctrl.GetValueAxisCollection.AddItem("myValueAxis1")
Set objValAxis2 = ctrl.GetValueAxisCollection.AddItem("myValueAxis2")
objValAxis1.TrendWindow = objTrendWnd.Name
objValAxis1.Label = "Value1"
objValAxis2.TrendWindow = objTrendWnd.Name
objValAxis2.inTrendColor = TRUE
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend1")
objTrend.TrendWindow = objTrendWnd.Name
objTrend.ValueAxis = objValAxis1.Name
Set objTrend = ctrl.GetTrendCollection.AddItem("myTrend2")
objTrend.TrendWindow = objTrendWnd.Name
objTrend.ValueAxis = objValAxis2.Name
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "ValueAxis" listing, for example, you write "objValueAxis1.Label" instead of
"objValueAxis1.ValueAxisLabel".
See also
ValueAxis object (list) (Page 233)
GetValueColumn method
Function
Returns the column object designated as name or index of the WinCC OnlineTableControl as
type "ICCAxValueColumn".
Syntax
Ausdruck.GetValueColumn(ByVal vIndex As Variant)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 763
VBS for Creating Procedures and Actions
1.14 VBS Reference
Parameters
VARIANT
Parameters Description
vIndex Index or name of value column of OnlineTable‐
Control.
Example
'VBS345
Dim ctrl
Dim objValueColumn
Set ctrl = ScreenItems("TableControl")
Set objValueColumn = ctrl.GetValueColumn("Valuecolumn1")
objValueColumn.Precisions = 4
Set objValueColumn = ctrl.GetValueColumn(2)
objValueColumn.ExponentialFormat = TRUE
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "ValueColumn" listing, for example, you write "objValueColumn.Precisions" instead of
"objValueColumn.ValueColumnPrecisions".
See also
ValueColumn object (list) (Page 234)
GetValueColumnCollection method
Function
Returns the list of all value column objects of the WinCC OnlineTableControl as type
"ICCAxCollection".
Syntax
Ausdruck.GetValueColulmnCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
764 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
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
'VBS346
Dim ctrl
Dim objValCol1
Dim objValCol2
Dim coll
Dim valcol
Set ctrl = ScreenItems("TableControl")
Set objValCol1 = ctrl.GetValueColumnCollection.AddItem("ValueColumn1")
Set objValCol2 = ctrl.GetValueColumnCollection.AddItem("ValueColumn2")
objValCol1.Caption = "Value Archive"
objValCol1.Provider = 1
objValCol1.TagName = "ProcessValueArchive\arch1"
objValCol1.TimeColumn = "TimeColumn1"
objValCol2.Caption = "Value Tag"
objValCol2.Provider = 2
objValCol2.TagName = "tagxx"
objValCol2.TimeColumn = "TimeColumn2"
Set coll = ctrl.GetValueColumnCollection
For Each valcol In coll
valcol.Align = 2
valcol.Length = 10
valcol.AutoPrecisions = TRUE
Next
See also
ValueColumn object (list) (Page 234)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 765
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetXAxis method
Function
Returns the X axis object designated as name or index of the WinCC FunctionTrendControl
as type "ICCAxValueAxis".
Syntax
Ausdruck.GetXAxis(ByVal vIndex As Variant)
Expression
Required. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of X axis.
Example
'VBS347
Dim ctrl
Dim objXAx
Set ctrl = ScreenItems("FunctionTrendControl")
Set objXAx = ctrl.GetXAxis(0)
objXAx.ScalingType = 0
Set objXAx = ctrl.GetXAxis("X axis 1")
objXAx.Label = "X2"
objXAx.Precisions = 2
objXAx.Color = RGB(109,109,109)
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "XAxis" listing, for example, you write "objXAx.Visible" instead of "objXAx.XAxisVisible".
See also
XAxis object (list) (Page 235)
WinCC: Scripting (VBS, ANSI-C, VBA)
766 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
GetXAxisCollection method
Function
Returns the list of all X axis objects of the WinCC FunctionTrendControl as type
"ICCAxCollection".
Syntax
Ausdruck.GetXAxisCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
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
'VBS348
Dim ctrl
Dim objXAxis1
Dim objXAxis2
Dim coll
Dim axes
Set ctrl = ScreenItems("FunctionTrendControl")
Set objXAxis1 = ctrl.GetXAxisCollection.AddItem("myXAxis1")
objXAxis1.Label = "temperature"
Set objXAxis2 = ctrl.GetXAxisCollection.AddItem("myXAxis2")
objXAxis2.Label = "pressure"
Set coll = ctrl.GetXAxisCollection
HMIRuntime.Trace "Number of XAxis:" & coll.Count & vbCrLf
For Each axes In coll
HMIRuntime.Trace axes.Name & vbCrLf
HMIRuntime.Trace axes.Label & vbCrLf
Next
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 767
VBS for Creating Procedures and Actions
1.14 VBS Reference
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "XAxis" listing, for example, you write "objXAxis1.Label" instead of
"objXAxis1.XAxisLabel".
See also
XAxis object (list) (Page 235)
GetYAxis method
Function
Returns the Y axis object designated as name or index of the WinCC FunctionTrendControl
as type "ICCAxValueAxis".
Syntax
Ausdruck.GetYAxis(ByVal vIndex As Variant)
Expression
Required. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
Parameters Description
vIndex Index or name of Y axis.
WinCC: Scripting (VBS, ANSI-C, VBA)
768 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
'VBS349
Dim ctrl
Dim objYAx
Set ctrl = ScreenItems("FunctionTrendControl")
Set objYAx = ctrl.GetYAxis(0)
objYAx.Align = 0
objYAx.Precisions = 3
Set objYAx = ctrl.GetYAxis("Y axis 1")
objYAx.Label = "Y1"
Msgbox objYAx.Label
objYAx.EndValue = 90
objYAx.BeginValue = 10
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "YAxis" listing, for example, you write "objYAx.Visible" instead of "objYAx.YAxisVisible".
See also
YAxis object (list) (Page 236)
GetYAxisCollection method
Function
Returns the list of all Y axis objects of the WinCC FunctionTrendControl of type
"ICCAxCollection".
Syntax
Ausdruck.GetYAxisCollection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 769
VBS for Creating Procedures and Actions
1.14 VBS Reference
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
'VBS350
Dim ctrl
Dim objYAxis1
Dim objYAxis2
Dim coll
Dim axes
Set ctrl = ScreenItems("FunctionTrendControl")
Set objYAxis1 = ctrl.GetXAxisCollection.AddItem("myYAxis1")
objYAxis1.Label = "temperature"
Set objYAxis2 = ctrl.GetXAxisCollection.AddItem("myYAxis2")
objYAxis2.Label = "pressure"
Set coll = ctrl.GetYAxisCollection
HMIRuntime.Trace "Number of YAxis:" & coll.Count & vbCrLf
For Each axes In coll
HMIRuntime.Trace axes.Name & vbCrLf
HMIRuntime.Trace axes.Label & vbCrLf
Next
Note
If you access the properties with the listing object, you do not have to enter the name of the
listing.
For the "YAxis" listing, for example, you write "objYAxis1.Label" instead of
"objYAxis1.YAxisLabel".
See also
YAxis object (list) (Page 236)
WinCC: Scripting (VBS, ANSI-C, VBA)
770 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
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
--
InsertData method
Function
Adds data to the called trend.
Syntax
Expression.InsertData(dblAxisX As Variant, dblAxisY As Variant)
Expression
Necessary. An expression which returns an object of the "Trend" type.
Parameters
Parameters Description
dblAxisX Value of X axis
dblAxisY Value of Y axis
Order of parameters
WinCC OnlineTrendControl InsertData (y, x)
WinCC FunctionTrendControl InsertData (x, y)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 771
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
'VBS300
Dim lngFactor
Dim dblAxisX
Dim dblAxisY
Dim objTrendControl
Dim objTrend
Set objTrendControl = ScreenItems("Control1")
Set objTrend = objTrendControl.GetTrend("Trend 1")
For lngFactor = -100 To 100
dblAxisX = CDbl(lngFactor * 0.02)
dblAxisY = CDbl(dblAxisX * dblAxisX + 2 * dblAxisX + 1)
objTrend.InsertData dblAxisX, dblAxisY
Next
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").
Note
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
WinCC: Scripting (VBS, ANSI-C, VBA)
772 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
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
See also
ScreenItems Object (List) (Page 127)
ScreenItem Object (Page 123)
Tags Object (List) (Page 137)
Alarms object (list) (Page 108)
ProcessValues Object (List) (Page 122)
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
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 773
VBS for Creating Procedures and Actions
1.14 VBS Reference
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
--
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
--
MoveRuler
Function
Moves the ruler from a specified reference point by a specified distance.
Syntax
Expression.MoveRuler( RulerIndex As Long, RulerMoveRef As Long,
MoveDistance As Long, Optional vTrendWindow As Variant )
WinCC: Scripting (VBS, ANSI-C, VBA)
774 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Expression
Required. An expression that returns an object of the "ScreenItem" type.
Parameter
Parameter Description
RulerIndex Specifies the ruler to move:
0 = Ruler
1 = Ruler at the start of the statistics area
2 = Ruler at the end of the statistics area
RulerMoveRef Specifies the reference point as orientation for the third parameter "MoveDistance":
0 = Time axis start position
1 = Current ruler position
2 = Time axis end position
MoveDistance Number of pixels by which the ruler is moved away from reference point "RulerMoveRef".
vTrendWindow Optional parameter for handling several, independent trend windows.
Specifies the trend window in which the ruler is moved. The ruler moves in all trend windows
if this parameter is not specified.
Return value
Function that returns the new ruler position.
Example
Table 1-1 Move ruler left by 10 pixels
'VBS367
Sub OnClick(ByVal Item)
Dim ctrl
Set ctrl = ScreenItems.Item("Control1")
call ctrl.MoveRuler (0, 1, -10)
End Sub
In the example, the ruler is moved by -10 pixels, starting at reference point 1 (current ruler
position). The ruler is now positioned 10 pixels away from the left of its original position.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 775
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
Table 1-2 Move ruler right by 10 pixels
'VBS368
Sub OnClick(ByVal Item)
Dim ctrl
Set ctrl = ScreenItems.Item("Control1")
ctrl.MoveRuler 0, 1, 10
End Sub
In the example, the ruler is moved by 10 pixels, starting at reference point 1 (current ruler
position). The ruler is now positioned 10 pixels away from the right of its original position.
Example
Table 1-3 Move ruler to end on opening of the window
'VBS369
Sub OnOpen()
Dim ctrl
Set ctrl = ScreenItems.Item("Control1")
ctrl.MoveRuler 0, 2, 0
End Sub
In the example, the ruler is moved by 0 pixels, starting at reference point 2 (time axis end
position). The ruler is now positioned at the time axis end position.
Example
Table 1-4 Calculate current ruler position
'VBS370
Sub OnClick(ByVal Item)
Dim ctrl
Set ctrl = ScreenItems.Item("Control1")
Dim pos
pos = ctrl.MoveRuler (0, 1, 0)
HmiRuntime.Trace "RulerPosition=" & pos & vbCrLf
End Sub
In the example, the ruler is moved by 0 pixels, starting at reference point 1 (current ruler
position). The ruler remains in its original position. The ruler position is returned as value.
WinCC: Scripting (VBS, ANSI-C, VBA)
776 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
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()
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()
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 777
VBS for Creating Procedures and Actions
1.14 VBS Reference
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
--
MoveToLastLine method
Function
Executes the "Last message" key function of the AlarmControl.
Syntax
Ausdruck.MoveToLastLine()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
778 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
MoveToLastPage method
Function
Executes the "Last page" key function of the AlarmControl.
Syntax
Ausdruck.MoveToLastPage()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
MoveToNext method
Function
Executes the "Next data record" key function of the control.
Syntax
Ausdruck.MoveToNext()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
MoveToNextLine method
Function
Executes the "Next message" key function of the AlarmControl.
Syntax
Ausdruck.MoveToNextLine()
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 779
VBS for Creating Procedures and Actions
1.14 VBS Reference
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
MoveToNextPage method
Function
Executes the "Next page" key function of the AlarmControl.
Syntax
Ausdruck.MoveToNextPage()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
MoveToPrevious method
Function
Executes the "Previous data record" key function of the control.
Syntax
Ausdruck.MoveToPrevious()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
780 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
MoveToPreviousLine method
Function
Executes the "Previous message" key function of the AlarmControl.
Syntax
Ausdruck.MoveToPreviousLine()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
MoveToPreviousPage method
Function
Executes the "Previous page" key function of the AlarmControl.
syntax
Ausdruck.MoveToPreviousPage()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
1.14.5.5 Methods N to R
NextColumn method
Function
Executes the "Next column" key function of the OnlineTableControl.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 781
VBS for Creating Procedures and Actions
1.14 VBS Reference
Syntax
Ausdruck.NextColumn()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
NextTrend method
Function
Executes the "Next curve" key function of the OnlineTrendControl and FunctionTrendControl.
Syntax
Ausdruck.NextTrend()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
OneToOneView method
Function
Executes the "Original view" key function of the OnlineTrendControl and FunctionTrendControl.
Syntax
Ausdruck.OneToOneView()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
WinCC: Scripting (VBS, ANSI-C, VBA)
782 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
PasteRows method
Function
Executes the "Paste Rows" key function of the UserArchiveControl.
Syntax
Expression.PasteRows()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
PreviousColumn method
Function
Executes the "Previous column" key function of the OnlineTableControl.
Syntax
Ausdruck.PreviousColumn()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
PreviousTrend method
Function
Executes the "Previous curve" key function of the OnlineTrendControl and
FunctionTrendControl.
Syntax
Ausdruck.PreviousTrend()
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 783
VBS for Creating Procedures and Actions
1.14 VBS Reference
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
Print method
Function
Executes the "Print" key function of the control.
Syntax
Ausdruck.Print()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
QuitHorn method
Function
Executes the "Acknowledge central signaling devices" key function of the AlarmControl.
Syntax
Ausdruck.QuitHorn()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
784 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
QuitSelected method
Function
Executes the "Single acknowledgment" key function of the AlarmControl.
Syntax
Ausdruck.QuitSelected()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
QuitVisible method
Function
Executes the "Group acknowledgment" key function of the AlarmControl.
Syntax
Ausdruck.QuitVisible()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
Read Method
Description of Tag Object
Reads out the status of a tag (tag object) shortly after the moment it was called. At the same
time, the tag object is provided with the values read. Upon reading a tag, its value, quality code
and time stamp are determined. The "LastError" property can be used to determine whether
the call was successful.
The "Name", "ServerPrefix" and "TagPrefix" properties are not changed as a result.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 785
VBS for Creating Procedures and Actions
1.14 VBS Reference
If the value of the tag is read successfully, the properties of the tag object are assigned the
following values:
Property Assignment
Value Tag values
Name Tag name (unchanged)
QualityCode Quality level
Timestamp Current tag time stamp
LastError 0
ErrorDescription ""
If the value of the tag is not read successfully, the properties of the tag object are assigned
the following values:
Property Allocation
Value VT_Empty
Name Tag name (unchanged)
QualityCode Bad Out of Service
Timestamp 0
LastError Read operation error codes
ErrorDescription Error description on LastError
Note
A summary of possible Quality Codes may be found in WinCC Information System under key
word "Communication" > "Diagnostics" or "Communication" > "Quality Codes".
syntax
Expression.Read([Readmode])
Expression
Necessary. An expression which returns a tag object. The return value of the Read method is
the value of the tag read out.
Parameters
The optional "Readmode" parameter enables the distinction between two types of reading:
Parameters Description
0 The tag value is read from the process image
(cache). 0 is the default value.
1 The value of a tag is read directly from AS or chan‐
nel (direct).
WinCC: Scripting (VBS, ANSI-C, VBA)
786 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
If the "Readmode" parameter is omitted, the value is read from the process image by default.
The return value of the Read method is the tag value read out as VARIANT.
Reading From the Process Image
When reading from the process image, the tag is logged on and, from that moment, polled
cyclically from the PLC. The login cycle is dependent on the configured trigger. The value is
read from the tag image by WinCC. For Close Picture, the tag actions are ended again. The
call is characterized by the following:
● The value is read by WinCC from the tag image.
● The call is faster in comparison to direct reading (except with the first call: The first call
basically takes longer because the value from the PLC must be read out and logged on.)
● The duration of the call is not dependent on the bus load or AS.
Behavior in actions with a tag trigger
All of the tags contained in the tag trigger are already known with Open Picture and are
registered with the defined monitoring time. Since all tags are requested at once, the best
possible optimization can be targeted from the channel. If a tag, contained in the trigger, is
requested with Read during an action, the value already exists and is transferred directly to
the call. If a tag is requested which is not contained in the trigger, the behavior is the same as
with a standard trigger.
Behavior in actions with a cyclic trigger
tags are registered with half of the cycle time with the first call. For every other call, the value
is present.
Behavior in event-driven actions
The tag is registered in the "upon change" mode with the first call. Process tags that are
registered in the "upon change" mode correspond with a cyclic read job with a cycle time of
1s.
If an event (e.g. mouse click) requests a value asynchronously, the tag is transferred to the
tag image. The tag is requested cyclically from the AS as of this point in time and therefore
increases the basic load. To bypass this increase in the basic load, the value can also be read
synchronously. The synchronous call causes a one-off increase in the communication load
but the tag is not transferred to the tag image.
Direct reading
In the case of direct reading, the current value is returned. The tag is not registered cyclically,
the value is requested from the AS one time only. Direct reading has the following properties:
● The value is read explicitly from the AS.
● The call takes longer compared to reading from the process image.
● The duration of the call is dependent on the bus load and AS, amongst other things.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 787
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
Reading a tag directly from AS or channel
'VBS100
Dim objTag
Dim vntValue
Set objTag = HMIRuntime.Tags("Tagname")
vntValue = objTag.Read(1) 'Read direct
MsgBox vntValue
Reading a tag from the process image
'VBS101
Dim objTag
Dim vntValue
Set objTag = HMIRuntime.Tags("Tagname")
vntValue = objTag.Read 'Read from cache
MsgBox vntValue
Description of TagSet Object
The TagSet object offers the option of reading several tags in one call.
Functionality here is mostly identical with that of a tag object. In the following, only deviations
thereof are described.
Expression
Necessary. An expression which returns an object of type "TagSet".
Reading From the Process Image
The TagSet object offers the advantage of requesting several tags in one read command. The
tags are registered in the process image as a group, improving performance in the process.
Direct reading
Since one call may process several read commands, performance is enhanced in comparison
to single calls.
WinCC: Scripting (VBS, ANSI-C, VBA)
788 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
The following example shows how tags are included in the TagSet list, how tag values are
imported and subsequently read.
'VBS174
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
group.Read
HMIRuntime.Trace "Motor1: " & group("Motor1").Value & vbNewLine
HMIRuntime.Trace "Motor2: " & group("Motor2").Value & vbNewLine
If the optional parameter "Readmode" is set to 1, the process tags are not registered but read
directly from AS or channel.
group.Read 1
See also
Example: How to Read Tag Values (Page 832)
Example: Writing tag values (Page 830)
LastError Property (Page 459)
ErrorDescription Property (Page 411)
TagSet Object (List) (Page 139)
Tag Object (Page 135)
Read Tags method
Function
Executes the "Read tags" key function of the UserArchiveControl.
Syntax
Ausdruck.ReadTags()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 789
VBS for Creating Procedures and Actions
1.14 VBS Reference
Refresh Method
Function
Drawing all visible pictures again.
syntax
Expression.Refresh
Expression
Necessary. An expression which returns a "Screens" or "Screen" type object.
Parameters
--
Examples
The first example forces all visible pictures to be drawn again:
'VBS149
HMIRuntime.Screens.Refresh
The second example forces the basic picture to be immediately redrawn:
'VBS150
HMIRuntime.Screens(1).Refresh
See also
Screen Object (Page 129)
Screens Object (List) (Page 132)
HMIRuntime Object (Page 116)
Remove Method
Description of TagSet Object
Removes a tag from the TagSet list. The tag may be removed by name or reference to a tag
object.
WinCC: Scripting (VBS, ANSI-C, VBA)
790 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
syntax
Expression.Remove [Tag]
Expression
Necessary. An expression which returns an object of type "TagSet".
Parameters
VARIANT
Parameters Description
Tag Name of a WinCC tag or reference to a tag object
to be removed from the list.
Example:
The following example shows how several tags are included in the TagSet list, and how to
remove a tag again.
'VBS175
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
group.Remove "Motor1"
Description of DataSet Object
Deletes the element specified in parameter "Name" from a list.
syntax
Expression.Remove [Name]
Expression
Necessary. An expression which returns an object of type "DataSet".
Parameters
VARIANT
Parameters Description
Name Name of the object to be removed from the list.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 791
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
The example shows how to remove the object "motor1" from the list.
'VBS166
HMIRuntime.DataSet.Remove("motor1")
Description of objects Logging, AlarmLogs, DataLogs
The method deletes a previously swapped archive segment from the Runtime project.
Archive segments deleted with the "Remove" method are removed from the common archiving
directory of the project.
The call may require a somewhat longer time period, depending on archive data. This may
block the processing of subsequent scripts. Blockage of actions within the picture may be
avoided if you start the call in a Global Scripting action, such as starting the action through a
triggering tag.
The archive separation and deletion creates a CPU load. This will affect performance.
Note
Calling up the "Remove" method is presently only possible at the server. There is an example,
however, which shows how the method may be started by the client from a server.
For redundancy, the following applies: Re-swapped archives are deleted with the "Remove"
method only on the computer from which the method was initiated.
syntax
Objects Logging, AlarmLogs
Expression.Remove [TimeFrom] [TimeTo] [TimeOut] [ServerPrefix]
Expression
Necessary. An expression which returns an object of type "Logging" or "AlarmLogs".
Object DataLogs
Expression.Remove [TimeFrom] [TimeTo] [TimeOut] [Type] [ServerPrefix]
Expression
Necessary. An expression which returns an object of type "DataLogs".
WinCC: Scripting (VBS, ANSI-C, VBA)
792 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Parameters
TimeFrom
Point in time, from which the archives are to be deleted.
When indicating the time format, a short form is also possible. This is described in the "Time
Format" section.
TimeTo
Time up to which archive segments are to be deleted.
When indicating the time format, a short form is also possible. This is described in the "Time
Format" section.
Timeout
Timeout in milliseconds.
If you enter "-1" as a value, the wait will be infinite. If you enter a value of "0", there will be no
wait.
Type:
Type of archive.
The parameter can (optionally) be used only to delete archive segments of the tag logging.
The following values can be entered:
Assigned Value Type Description
1 hmiDataLogFast Tag Logging Fast data
2 hmiDataLogSlow Tag Logging Slow data
3 hmiDataLogAll Tag Logging Fast and Slow data
ServerPrefix
Reserved for future versions.
Return value
If an error occurred during deletion of the archive segments, the method will return an error
message. Additional information may be found under the subject heading "Error Messages
from Database Area".
Time format
Time format is defined as follows: YYYY-MM-DD hh:mm:ss, where YYYY represents the year,
MM the month, DD the day, hh the hour, mm the minute and ss the second. For example, the
time of 2 minutes and one second past 11 o'clock on July 26, 2004 is displayed as follows:
2004-07-26 11:02:01.
For parameters "TimeFrom" and "TimeTo" the statement of data and time is also possible in
short form. Not all format fields must be filled in this case. The short form means that the
information on date and time may be lacking one or several parameters, beginning with the
value for seconds. For example, the statement may be in the form of "YYYY-MM" or "YYYY-
MM-DD hh". Using the statement "TimeFrom" = "2004-09" and "TimeTo" = "2004-10-04" all
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 793
VBS for Creating Procedures and Actions
1.14 VBS Reference
archive segments between September 2004 up to and including October 4th are to be
swapped.
Example:
In the following example, archive segments re-swapped after the fact for a specified time period
may be removed and the return value may be output as Trace.
'VBS182
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Remove("2004-08-22","2004-09-22",-1) &
vbNewLine
In the following example, all archive segments re-swapped after the fact may be removed and
the return value may be output as Trace.
'VBS183
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Remove("","",-1) & vbNewLine
See also
Error Messages from Database Area (Page 822)
Example: How to Start an Action on the Server (Logging Object) (Page 838)
Logging Object (Page 120)
DataSet Object (List) (Page 113)
DataLogs Object (Page 112)
AlarmLogs Object (Page 110)
TagSet Object (List) (Page 139)
RemoveAll Method
Description of TagSet Object
Deletes all tags from a TagSet list.
syntax
Expression.RemoveAll
Expression
Necessary. An expression which returns an object of type "TagSet".
WinCC: Scripting (VBS, ANSI-C, VBA)
794 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Parameters
--
Example:
The following example shows how several tags are included in the TagSet list, and how to
remove all tags again.
'VBS176
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Motor1"
group.Add "Motor2"
group.RemoveAll
Description of DataSet Object
Deletes all values or object references from a DataSet list.
syntax
Expression.RemoveAll
Expression
Necessary. An expression which returns an object of type "DataSet".
Parameters
--
Example:
The example shows how all objects are removed from the list.
'VBS167
HMIRuntime.DataSet.RemoveAll
See also
DataSet Object (List) (Page 113)
TagSet Object (List) (Page 139)
Tag Object (Page 135)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 795
VBS for Creating Procedures and Actions
1.14 VBS Reference
RemoveData method
Function
Deletes the data of the called trend.
Syntax
Expression.RemoveData
Expression
Necessary. An expression which returns an object of the "Trend" type.
Example
'VBS310
Dim objTrendControl
Dim objTrend
Set objTrendControl = ScreenItems("Control1")
Set objTrend = objTrendControl.GetTrend("Trend 1")
objTrend.RemoveData
Restore Method
Description of objects Logging, AlarmLogs, DataLogs
The method adds swapped archive segments to the Runtime project.
Upon swapping, the archive segments are copied to the common archiving directory of the
project. Therefore, the appropriate storage capacity must be available.
The call may require a somewhat longer time period, depending on archive data. This may
block the processing of subsequent scripts. Blockage of actions within the picture may be
avoided if you start the call in a Global Scripting action, such as starting the action through a
triggering tag.
Linking / copying of the archives generates a CPU load because the SQL server experiences
additional load because of turned-on signature checking in particular. Copying of archive
segments will slow down hard disk access.
Upon turned-on signature checking, an error message is returned if an unsigned or modified
archive is to be swapped. There is always only one error message returned, even if several
errors occurred during the swap process. Additionally, a WinCC system message is generated
WinCC: Scripting (VBS, ANSI-C, VBA)
796 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
for each archive segment. An entry is added to the Windows event log in the "Application"
section. This provides the opportunity to check which archive segments are creating the error.
● With an unsigned archive, the return value "0x8004720F" is returned. The archive is stored.
The following text is entered in the event display:
"Validation of database <db_name> failed! No signature found!"
● With an changed archive, the return value "0x80047207" is returned. The even screen, the
entry is "Validation of database <db_name> failed !".
The archive is not stored.
Note
Calling up the "Restore" method is presently only possible at the server. There is an
example, however, which shows how the method may be started by the client from a server.
For redundancy, the following applies: Upon re-swapping of archives with the "Restore"
method, only archive segments are added to the Runtime project on the computer from
which the method was called.
Syntax
Objects Logging, AlarmLogs
Expression.Restore [SourcePath] [TimeFrom] [TimeTo] [TimeOut]
[ServerPrefix]
Expression
Required. An expression which returns an object of type "Logging" or "AlarmLogs".
Object DataLogs
Expression.Restore [SourcePath] [TimeFrom] [TimeTo] [TimeOut] [Type]
[ServerPrefix]
Expression
Required. An expression which returns an object of type "DataLogs".
Parameter
SourcePath
Path to archive data.
TimeFrom
Point in time, from which the archives are to be stored.
When indicating the time format, a short form is also possible. This is described in the "Time
Format" section.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 797
VBS for Creating Procedures and Actions
1.14 VBS Reference
TimeTo
Time up to which archive segments are to be swapped.
When indicating the time format, a short form is also possible. This is described in the "Time
Format" section.
Timeout
Timeout in milliseconds.
If you enter "-1" as a value, the wait will be infinite. If you enter a value of "0", there will be no
wait.
Type
Type of archive.
The parameter can (optionally) be used only to store archive segments of the tag logging.
The following values can be entered:
Assigned Value Type Description
1 hmiDataLogFast Tag Logging Fast data
2 hmiDataLogSlow Tag Logging Slow data
3 hmiDataLogAll Tag Logging Fast and Slow data
ServerPrefix
Reserved for future versions.
Return value
If an error occurred during swapping of archive segments, the method will return an error
message. Additional information may be found under the subject heading "Error Messages
from Database Area".
Time format
Time format is defined as follows: YYYY-MM-DD hh:mm:ss, where YYYY represents the year,
MM the month, DD the day, hh the hour, mm the minute and ss the second. For example, the
time of 2 minutes and one second past 11 o'clock on July 26, 2004 is displayed as follows:
2004-07-26 11:02:01.
For parameters "TimeFrom" and "TimeTo" the statement of data and time is also possible in
short form. Not all format fields must be filled in this case. The short form means that the
information on date and time may be lacking one or several parameters, beginning with the
value for seconds. For example, the statement may be in the form of "YYYY-MM" or "YYYY-
MM-DD hh". Using the statement "TimeFrom" = "2004-09" and "TimeTo" = "2004-10-04" all
archive segments between September 2004 up to and including October 4th are to be
swapped.
WinCC: Scripting (VBS, ANSI-C, VBA)
798 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example
In the following example, all archive segments since the specified time period are re-swapped,
and the return value is output as Trace.
'VBS184
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.Restore("D:\Folder","2004-09-14","",-1) &
vbNewLine
In the following example, all Tag Logging Slow archive segments since the specified time
period are re-swapped, and the return value is output as Trace.
'VBS185
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.DataLogs.Restore("D:\Folder","2004-09-14
12:30:05","2004-09-20 18:30",-1,2) & vbNewLine
In the following example, all Alarm Logging archive segments up to the specified time period
are re-swapped, and the return value is output as Trace.
'VBS186
HMIRuntime.Trace "Ret: " & HMIRuntime.Logging.AlarmLogs.Restore("","2004-09-20",-1) &
vbNewLine
See also
Error Messages from Database Area (Page 822)
Example: How to Start an Action on the Server (Logging Object) (Page 838)
Logging Object (Page 120)
DataLogs Object (Page 112)
AlarmLogs Object (Page 110)
1.14.5.6 Methods S to T
SelectAll
Function
Selects all rows in the table-based control.
Syntax
Expression.SelectAll()
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 799
VBS for Creating Procedures and Actions
1.14 VBS Reference
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
See also
Row object (list) (Page 223)
SelectRow
Function
Selects a particular row in the table-based control.
Syntax
Expression.SelectRow(ByVal IRow As Long, Optional bExtendSelection
As Boolean)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
Parameters Description
IRow Number of the row to be selected.
bExtendSelection Indicates as an option whether the current selection will be extended. Is only rel‐
evant if multiple selections are possible.
Example
● Row 1 is currently selected. If SelectRow( 2, True ) is called, then row 1 and row 2 will be
selected.
● Row 1 is currently selected. If SelectRow( 2, False ) or SelectRow( 2 ) is called without an
optional parameter, then only row 2 will be selected.
See also
Row object (list) (Page 223)
WinCC: Scripting (VBS, ANSI-C, VBA)
800 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
SelectedStatisticArea method
Function
Executes the "Set statistic area" key function of the OnlineTableControl.
Syntax
Ausdruck.SelectedStatisticArea()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ServerExport method
Function
Executes the "Export archive" key function of the UserArchiveControl.
Syntax
Ausdruck.ServerExport()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ServerImport method
Function
Executes the "Import archive" key function of the UserArchiveControl.
Syntax
Ausdruck.ServerImport()
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 801
VBS for Creating Procedures and Actions
1.14 VBS Reference
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowColumnSelection method
Function
Executes the "Select columns" key function of the OnlineTableControl.
Syntax
Ausdruck.ShowColumnSelection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowComment method
Function
Executes the "Comments dialog" key function of the AlarmControl.
Syntax
Ausdruck.ShowComment()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
802 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ShowDisplayOptionsDialog method
Function
Executes the "Display options dialog" key function of the AlarmControl.
Syntax
Ausdruck.ShowDisplayOptionsDialog()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowEmergencyQuitDialog method
Function
Executes the "Emergency acknowledgment" key function of the AlarmControl.
Syntax
Ausdruck.ShowEmergencyQuitDialog()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowHelp method
Function
Executes the "Help" key function of the control.
Syntax
Ausdruck.ShowHelp()
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 803
VBS for Creating Procedures and Actions
1.14 VBS Reference
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
ShowHideList method
Function
Executes the "List of messages to be hidden" key function of the AlarmControl.
Syntax
Ausdruck.ShowHideList()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowHitList method
Function
Executes the "Hitlist" key function of the AlarmControl.
Syntax
Ausdruck.ShowHitList()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
804 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
ShowInfoText method
Function
Executes the "Info text dialog" key function of the AlarmControl.
Syntax
Ausdruck.ShowInfoText()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowInsertValueDialog method
Function
Executes the "Create archive value" key function of the OnlineTableControl.
Syntax
Expression.ShowInsertValueDialog()
Expression
Required. An expression that returns an object of the "ScreenItem" type.
ShowLockDialog method
Function
Executes the "Lock dialog" key function of the AlarmControl.
Syntax
Ausdruck.ShowLockDialog()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 805
VBS for Creating Procedures and Actions
1.14 VBS Reference
Parameters
--
ShowLockList method
Function
Executes the "Lock list" key function of the AlarmControl.
Syntax
Ausdruck.ShowLockList()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowLongTermArchiveList method
Function
Executes the "Long-term archive list" key function of the AlarmControl.
Syntax
Ausdruck.ShowLongTermArchiveList()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowMessageList method
Function
Executes the "Message list" key function of the AlarmControl.
WinCC: Scripting (VBS, ANSI-C, VBA)
806 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Syntax
Ausdruck.ShowMessageList()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowPercentageAxis method
Function
Executes the "Relative axis" key function of the OnlineTrendControl.
Syntax
Ausdruck.ShowPercentageAxis()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowPropertyDialog method
Function
Executes the "Configuration dialog" key function of the control.
Syntax
Ausdruck.ShowPropertyDialog()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
VARIANT
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 807
VBS for Creating Procedures and Actions
1.14 VBS Reference
ShowSelectArchive method
Function
Executes the "Select data connection" key function of the UserArchiveControl.
Syntax
Ausdruck.ShowSelectArchive()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowSelection method
Function
Executes the "Selection dialog" key function of the UserArchiveControl.
Syntax
Ausdruck.ShowSelection ()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowSelectTimeBase method
Function
Executes the "Time base dialog" key function of the UserArchiveControl.
Syntax
Ausdruck.ShowSelectTimeBase()
WinCC: Scripting (VBS, ANSI-C, VBA)
808 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowSelectionDialog method
Function
Executes the "Selection dialog" key function of the AlarmControl.
Syntax
Ausdruck.ShowSelectionDialog()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowShortTermArchiveList method
Function
Executes the "Short-term archive list" key function of the AlarmControl.
Syntax
Ausdruck.ShowShortTermArchiveList()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 809
VBS for Creating Procedures and Actions
1.14 VBS Reference
ShowSort method
Function
Executes the "Sort dialog" key function of the UserArchiveControl.
Syntax
Ausdruck.ShowSort()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowSortDialog method
Function
Executes the "Sort dialog" key function of the AlarmControl.
Syntax
Ausdruck.ShowSortDialog()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowTagSelection method
Function
Executes the "Select data connection" key function of the control.
Syntax
Ausdruck.ShowTagSelection()
WinCC: Scripting (VBS, ANSI-C, VBA)
810 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowTimebaseDialog method
Function
Executes the "Time base dialog" key function of the AlarmControl.
Syntax
Ausdruck.ShowTimebaseDialog()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ShowTimeSelection method
Function
Executes the "Select time range" key function of the control.
Syntax
Ausdruck.ShowTimeSelection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 811
VBS for Creating Procedures and Actions
1.14 VBS Reference
ShowTrendSelection method
Function
Executes the "Select trends" key function of the OnlineTrendControl and
FunctionTrendControl.
Syntax
Ausdruck.ShowTrendSelection()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
-- -
StartStopUpdate method
Function
Executes the "Start" or "Stop" key function of the control.
Syntax
Ausdruck.StartStopUpdate()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
Stop Method
Function
Terminates WinCC Runtime.
syntax
HMIRuntime.Stop
WinCC: Scripting (VBS, ANSI-C, VBA)
812 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Parameters
---
Example:
The following example terminates WinCC Runtime:
'VBS124
HMIRuntime.Stop
See also
HMIRuntime Object (Page 116)
Trace Method
Description
Displays messages in the diagnostics window.
syntax
HMIRuntime.Trace
Parameters
STRING
Example:
The following example writes a text in the diagnostics window:
'VBS103
HMIRuntime.Trace "Customized error message"
See also
HMIRuntime Object (Page 116)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 813
VBS for Creating Procedures and Actions
1.14 VBS Reference
1.14.5.7 Methods U to Z
UnhideAlarm method
Function
Executes the "Unhide alarm" key function of the AlarmControl.
Syntax
Ausdruck.UnhideAlarm()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
UnlockAlarm method
Function
Executes the "Unlock alarm" key function of the AlarmControl.
Syntax
Ausdruck.UnlockAlarm()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
UnselectAll
Function
Deselects all rows in the table-based control.
WinCC: Scripting (VBS, ANSI-C, VBA)
814 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Syntax
Expression.UnselectAll()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
See also
Row object (list) (Page 223)
UnselectRow
Function
Deselects a particular row in the table-based control.
Syntax
Expression.UnselectRow(ByVal IRow As Long)
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
Long
Parameters Description
IRow Number of the row to be selected.
See also
Row object (list) (Page 223)
Write Method
Description of Tag Object
Writes a value synchronously or asynchronously in a tag. The "LastError" property can be used
to determine whether the call was successful.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 815
VBS for Creating Procedures and Actions
1.14 VBS Reference
If the value of the tag is set successfully, the properties of the tag object are assigned the
following values:
Property Allocation
Value Tag values set by the user (unchanged)
Name Tag name (unchanged)
QualityCode Bad Out of Service
Timestamp 0
LastError 0
ErrorDescription ""
If the value of the tag is not set successfully, the properties of the tag object are assigned the
following values:
Property Allocation
Value Tag values set by the user (unchanged)
Name Tag name (unchanged)
QualityCode Bad Out of Service
Timestamp 0
LastError Write operation error codes
ErrorDescription Error description on LastError
syntax
Expression.Write [Value],[Writemode]
Expression
Necessary. An expression which returns a tag object.
Parameters
The value to be written can be transferred directly to the method as a parameter. If the
parameter is not specified, the value in the "Value" property is used. The "Writemode" option
parameter can be used to select whether the tag value should be written synchronously or
asynchronously. If the "Writemode" parameter is not used, writing is performed asynchronously
as its default value.
During the writing process, no information is supplied on the status of the tags.
WinCC: Scripting (VBS, ANSI-C, VBA)
816 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
The "Value" property contains the value which was set before or during the writing operation,
therefore is may not correspond to the real current value of the tag. If the data on the tag should
be updated, use the Read method.
Parameters Description
Value (optional) The tag value is specified. The specified value
overwrites the value in the "Value" property in the
tag object.
The tag value is not specified. The tag receives the
current value from the "Value" property of the tag
object.
Writemode (optional) 0 or empty: The tag value is written asynchronous‐
ly. 0 is the default value.
1: The tag value is written synchronously.
On asynchronous writing, it is written immediately into the tag image. The user does not receive
any feedback if the value has been written in the programmable controller, too.
In the case of synchronous writing (direct to the PLC), the writing operation actually occurs
when the PLC is ready to operate. The use receives a check-back message if the writing
operation was not successful.
Example:
Asynchronous writing
'VBS104
Dim objTag
Set objTag = HMIRuntime.Tags("Var1")
objTag.Value = 5
objTag.Write
MsgBox objTag.Value
or
'VBS105
Dim objTag
Set objTag = HMIRuntime.Tags("Var1")
objTag.Write 5
MsgBox objTag.Value
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 817
VBS for Creating Procedures and Actions
1.14 VBS Reference
Synchronous writing
'VBS106
Dim objTag
Set objTag = HMIRuntime.Tags("Var1")
objTag.Value = 5
objTag.Write ,1
MsgBox objTag.Value
or
'VBS107
Dim objTag
Set objTag = HMIRuntime.Tags("Var1")
objTag.Write 5, 1
MsgBox objTag.Value
Description of TagSet Object
The TagSet object offers the option of writing several tags in one call.
Functionality here is mostly identical with that of a tag object. In the following, only deviations
thereof are described.
Expression
Necessary. An expression which returns an object of type "TagSet".
Parameters
In order to write different values, the "Value" property of individual tag objects must be set, and
write must be called thereafter without the "Value" parameter. Since the write commands are
grouped into one call, it results in improved performance compared to single calls.
In a TagSet object, it is not possible to pass on a value using the "Write" method. Individual
values must be set using the "Value" property of the individual tag objects.
WinCC: Scripting (VBS, ANSI-C, VBA)
818 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Example:
The following example shows how tags are included in the TagSet list, how tag values are set
and subsequently written.
'VBS173
Dim group
Set group = HMIRuntime.Tags.CreateTagSet
group.Add "Wert1"
group.Add "Wert2"
group("Wert1").Value = 3
group("Wert2").Value = 9
group.Write
If you set the optional parameter "Writemode" equal to 1, the process tags are written
synchronously (directly to AS).
group.Write 1
See also
LastError Property (Page 459)
ErrorDescription Property (Page 411)
TagSet Object (List) (Page 139)
Tag Object (Page 135)
WriteTags method
Function
Executes the "Write tags" key function of the UserArchiveControl.
Syntax
Expression.WriteTags()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 819
VBS for Creating Procedures and Actions
1.14 VBS Reference
ZoomArea - Method
Function
Executes the "Zoom area" key function of the OnlineTrendControl and FunctionTrendControl.
Syntax
Ausdruck.ZoomArea()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ZoomInOut - Method
Function
Executes the "Zoom +/-" key function of the OnlineTrendControl and FunctionTrendControl.
Syntax
Ausdruck.ZoomInOut()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ZoomInOutTime method
Function
Executes the "Zoom time axis +/-" key function of the OnlineTrendControl.
Syntax
Ausdruck.ZoomInOutTime()
WinCC: Scripting (VBS, ANSI-C, VBA)
820 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ZoomInOutValues - Method
Function
Executes the "Zoom value axis +/-" key function of the OnlineTrendControl.
Syntax
Ausdruck.ZoomInOutValues()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ZoomInOutX method
Function
Executes the "Zoom X axis +/-" key function of the FunctionTrendControl.
Syntax
Ausdruck.ZoomInOutX()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 821
VBS for Creating Procedures and Actions
1.14 VBS Reference
ZoomInOutY - Method
Function
Executes the "Zoom Y axis +/-" key function of the FunctionTrendControl.
Syntax
Ausdruck.ZoomInOutY()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
ZoomMove method
Function
Executes the "Move trend area" key function of the OnlineTrendControl and
FunctionTrendControl.
Syntax
Ausdruck.ZoomMove()
Expression
Necessary. An expression that returns an object of the "ScreenItem" type.
Parameters
--
1.14.6 Appendix
1.14.6.1 Error Messages from Database Area
Introduction
Upon access to databases, a value is returned upon execution. Values in the range "0x8..."
represent an error message. Values not equal to "0x8..." represent a status message.
WinCC: Scripting (VBS, ANSI-C, VBA)
822 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.14 VBS Reference
Status Messages
The following status messages are defined:
0x0 OK
0x1 Function did not find any errors in parameter supply and did not find any internal errors. The
following causes may result in this value.
When connecting databases:
- No archive could be found in the given time window.
- Archives were found in the given time window, but they were already connected.
When separating databases:
- No connected archives could be found in the given time window. No checks are performed
on whether or not archives are attached at all.
Error Messages
The following error messages are defined (n in English only):
Error code Error Message
0x80047200 WinCC is not activated
0x80047201 Invalid archive type
0x80047202 Invalid lower boundary
0x80047203 Invalid upper boundary
0x80047204 Path 'CommonArchiving' could not be created in the project path
0x80047205 Timeout, please retry
0x80047206 WinCC was deactivated
0x80047207 Wrong signification
At least one database had a invalid signature and has not been attached.
0x80047208 Database could not be attached
0x80047209 Copy to 'CommonArchiving' is not possible.
0x8004720A Invalid syntax for database filename.
0x8004720B No list of databases.
0x8004720C Database already detached.
0x8004720D Database could not be detached.
0x8004720F Unsigned database attached.
At least one database without signature has been attached.
0x80047210 Path error :
- Path invalid,
- no *.MDF files found in specified path or
- no permission to specified path.
See also
Remove Method (Page 790)
Write Method (Page 815)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 823
VBS for Creating Procedures and Actions
1.14 VBS Reference
Read Method (Page 785)
Restore Method (Page 796)
Logging Object (Page 120)
DataLogs Object (Page 112)
AlarmLogs Object (Page 110)
WinCC: Scripting (VBS, ANSI-C, VBA)
824 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
1.15 Examples of VBScript
1.15.1 Examples of VBScript
Introduction
The following section contains application examples of VBS in WinCC. The "Examples in
WinCC" section contains examples of codes with which the WinCC Runtime environment can
be made dynamic. These examples have been conceived so that they can be assumed 1:1 in
the configuration.
The "General Examples" section contains examples with which to influence the Microsoft
environment. There is no guarantee nor support for the running capability of these examples.
See also
Examples in WinCC (Page 825)
1.15.2 Examples in WinCC
1.15.2.1 Examples in WinCC
Introduction
This section contains examples of using VBScript in WinCC with regard to the following topics:
● Access to objects in the Graphics Designer (e.g. color or text change)
● Set color of objects above RGB colors
● Configuring language change
● Deactivate Runtime
● Start external program
● Globally configure picture change (from Global Script)
● Configuring Change Picture Via Property
● Use trace for diagnostics output
● Set value of a tag
● Read value of a tag
● Check the success of a read/write action into a tag
● Asynchronously set value of a tag
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 825
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
See also
Example: Starting an external application (Page 861)
Example: Writing Object Properties (Page 835)
Example: How to Read Tag Values (Page 832)
Example: Writing tag values (Page 830)
Example: Configuring diagnostics output via Trace (Page 829)
Example: Configuring Change Picture Via Property (Page 829)
Example: Configuring change picture globally (Page 828)
Example: Deactivating Runtime (Page 828)
Example: How to Configure Language Changes (Page 827)
Example: Defining the color of objects (Page 827)
Example: Accessing objects in Graphics Designer (Page 826)
1.15.2.2 Example: Accessing objects in Graphics Designer
Introduction
Access can be made to all Graphic Designer objects using VBS WinCC in order to make the
graphic Runtime environment dynamic. Graphic objects can be made dynamic on operation
(e.g. clicking the mouse on a button), depending on a tag or cyclically (e.g. flashing).
The following examples illustrate how to change a graphic object following a mouse click.
Procedure
In the following example, the radius of a circle is set to 20 in Runtime per mouse click:
'VBS121
Dim objCircle
Set objCircle= ScreenItems("Circle1")
objCircle.Radius = 20
Note
The expression used in the example only applies to Graphics Designer. In the case of analog
actions in Global Script, address the objects using the HMIRuntime object.
See also
Examples in WinCC (Page 825)
WinCC: Scripting (VBS, ANSI-C, VBA)
826 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
1.15.2.3 Example: Defining the color of objects
Introduction
The colors of graphic objects are defined via RGB values (Red/Green/Blue). The color values
for graphic objects can be set or read out.
Procedure
The following example defines the fill color for "ScreenWindow1" to blue:
'VBS122
Dim objScreen
Set objScreen = HMIRuntime.Screens("ScreenWindow1")
objScreen.FillStyle = 131075
objScreen.FillColor = RGB(0, 0, 255)
See also
Examples in WinCC (Page 825)
1.15.2.4 Example: How to Configure Language Changes
Introduction
The Runtime language of WinCC can be changed using VBS. The most typical use is buttons
with the corresponding language codes which are placed on the start page of a project.
You specify the Runtime language in VBS by using a country code, e.g., 1031 for German -
Default, 1033 for English - USA etc. A summary of all country codes may be found in the Basics
of VBScript under the subject header "Regional Scheme ID (LCID) Diagram".
Procedure
Use the "Mouse click" event on a button to create a VBS action and enter the following action
code to switch the Runtime language to German:
'VBS123
HMIRuntime.Language = 1031
See also
Examples in WinCC (Page 825)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 827
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
1.15.2.5 Example: Deactivating Runtime
Introduction
It is possible to terminate WinCC Runtime with VBS, e.g. via a mouse click or in dependence
on tag values or other events, such as multiple faulty input of a password when starting
Runtime.
What to do
The following example terminates WinCC Runtime:
'VBS124
HMIRuntime.Stop
See also
Examples in WinCC (Page 825)
1.15.2.6 Example: Configuring change picture globally
Introduction
VBS can be used to initiate a global picture change and thus, for example, display a picture
from a server on a client in a distributed system. To do this, server's server prefix must precede
the target picture.
What to do
Configure the following code for a picture change to a button, for example:
'VBS125
HMIRuntime.BaseScreenName = "Serverprefix::New screen"
See also
Examples in WinCC (Page 825)
WinCC: Scripting (VBS, ANSI-C, VBA)
828 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
1.15.2.7 Example: Configuring Change Picture Via Property
Introduction
If partitioned pictures are used in the configuration, e.g. in a basic picture title and operating
bar for the user interface and an embedded picture window for the actual picture display,
configure a picture change using the properties of the picture window.
The property of the "ScreenName" picture window must be changed in order for the other
picture to appear. The action and picture window must be configured in the same picture.
What to do
In the following example, the "test.pdl" picture is displayed in the "ScreenWindow" picture
window when executing the action:
'VBS126
Dim objScrWindow
Set objScrWindow = ScreenItems("ScreenWindow")
objScrWindow.ScreenName = "test"
See also
Examples in WinCC (Page 825)
1.15.2.8 Example: Configuring diagnostics output via Trace
Introduction
If a GSC diagnostics window has been inserted in the picture, diagnostics output can be
displayed in the diagnostics window in Runtime using the Trace command.
GSC Diagnostics issues the Trace methods contained in the actions in the chronological
sequence they are called. This also applies to Trace instructions in procedures which are called
in actions. The targeted implementation of Trace instructions, e.g. for the output of tag values,
enables the progress of actions and the procedures called in them to be traced. The Trace
instructions are entered in the form "HMIRuntime.Trace(<Ausgabe>)".
The GSC Diagnostics displays trace output from C and VBS.
What to do
The following example writes a text in the diagnostics window:
'VBS127
HMIRuntime.Trace "Customized error message"
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 829
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
See also
Examples in WinCC (Page 825)
1.15.2.9 Example: Writing tag values
Introduction
Using VBS, it is possible to write a tag value to the PLC, e.g. by clicking the mouse on a button
to specify setpoint values, or to set internal tag values to trigger other actions.
Various write variations are mentioned and explained below.
Simple writing
In the following example, a value is written to the "Tag1" tag:
'VBS128
HMIRuntime.Tags("Tag1").Write 6
This is the simplest form of writing since no object reference is generated.
Writing with object reference
In the following example, a local copy of the tag object is created and a value written to "Tag1":
'VBS129
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Write 7
Referencing offers the advantage of being able to work with the tag object before writing. The
tag value can be read, calculations executed and written again:
'VBS130
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read
objTag.Value = objTag.Value + 1
objTag.Write
Synchronous writing
Normally, the value to be written is transferred to the tag management and processing of the
action resumed. In some cases, however, it must be ensured that the value has actually been
written before processing of the action can be resumed.
WinCC: Scripting (VBS, ANSI-C, VBA)
830 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
This type of writing is realized by specifying the value 1 for the additional, optional parameters:
'VBS131
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Write 8.1
or
'VBS132
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Value = 8
objTag.Write ,1
Note
Please note that the call takes longer in comparison to the standard call. The duration is also
dependent on the channel and AS, amongst other things.
The type of writing complies to the SetTagXXXWait() call in C scripting.
Writing with status handling
In order to ensure that a value has been written successfully, it is necessary to execute an
error check or determine the status of the tag, after the writing process.
This is done by checking the value of the "LastError" property after writing. When the test
proves successful, i.e. the job has been placed successfully, the tag status is checked.
In the case of a write job, the current status from the process is not determined. To establish
this, it is necessary to read the tag. The value specified in the Quality Code property after the
read process provides an indication of the tag status and, if necessary, makes reference to a
failed AS connection.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 831
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
In the following example, the "Tag1" tag is written. If an error occurs during writing, the error
value and error description appear in the Global Script diagnostics window. Finally, the Quality
Code is checked. If the Quality Code is no OK (0x80), it is displayed in the diagnostics window.
'VBS133
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Write 9
If 0 <> objTag.LastError Then
HMIRuntime.Trace "Error: " & objTag.LastError & vbCrLf & "ErrorDescription: " &
objTag.ErrorDescription & vbCrLf
Else
objTag.Read
If &H80 <> objTag.QualityCode Then
HMIRuntime.Trace "QualityCode: 0x" & Hex(objTag.QualityCode) & vbCrLf
End If
End If
Note
After writing a tag, the QualityCode property of the local tag object is set to "BAD Out of Service"
because it is not known which Quality Code manages the tag in the process.
The Quality Code cannot be written from VBS.
See also
Write Method (Page 815)
Examples in WinCC (Page 825)
1.15.2.10 Example: How to Read Tag Values
Introduction
VBS can be used to read and further process a tag value. This makes it possible, for example,
to click the mouse on a button to obtain information on the system status or to execute a
calculation.
Various read variations are mentioned and explained below.
WinCC: Scripting (VBS, ANSI-C, VBA)
832 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Simple reading
In the following example, the value of "Tag1" is read and displayed in the Global Script
diagnostics window:
'VBS134
HMIRuntime.Trace "Value: " & HMIRuntime.Tags("Tag1").Read & vbCrLf
This is the simplest form of reading since no object reference is generated.
Reading with object reference
In the following example, a local copy of the tag object is created, the tag value read and
displayed in the Global Script diagnostics window:
'VBS135
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
HMIRuntime.Trace "Value: " & objTag.Read & vbCrLf
Referencing offers the advantage of being able to work with the tag object. The tag value can
be read, calculations executed and written again:
'VBS136
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read
objTag.Value = objTag.Value + 1
objTag.Write
Using the Read method, process tags which have been read are added to the image, from
this moment on they cyclically requested from the AS. If the tag is already in the image, the
value contained in it is returned.
For Close Picture, the tag actions are ended again.
Note
If a tag is requested in a Global Script action, it remains registered throughout the enter Runtime
of WinCC.
Direct reading
Normally, the tag values are read from the tag image. In certain situations, however, it may be
necessary to read the value direct from the AS, e.g. to synchronize fast processes.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 833
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
If the optional parameter is set to 1 for the read process, the tag is not logged in cyclically but
the value is requested once from the AS.
'VBS137
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
HMIRuntime.Trace "Value: " & objTag.Read(1) & vbCrLf
Note
Please note that the call takes longer in comparison to the standard call. The duration is also
dependent on the channel and AS, amongst other things.
This type of call must be avoided in the case of cyclic C actions because this is the main reason
for performance problems.
This type of read process corresponds to GetTagXXXWait() call from C scripting.
Reading with status handling
In order to ensure that a value is valid, a check should be made following reading. This occurs
by the fact that the Quality Code is controlled.
In the following example, the "myWord" tag is read and the QualityCode then checked. When
the Quality Code does not correspond to OK (0x80) the LastError, ErrorDescription and
QualityCode properties are displayed in the Global Script diagnostics window.
'VBS138
Dim objTag
Set objTag = HMIRuntime.Tags("Tag1")
objTag.Read
If &H80 <> objTag.QualityCode Then
HMIRuntime.Trace "Error: " & objTag.LastError & vbCrLf & "ErrorDescription: " &
objTag.ErrorDescription & vbCrLf & "QualityCode: 0x" & Hex(objTag.QualityCode) & vbCrLf
Else
HMIRuntime.Trace "Value: " & objTag.Value & vbCrLf
End If
Note
If an error occurs during reading, QualityCode is set to BAD NON-SPECIFIC. Therefore, it is
sufficient to check the QualityCode following reading.
WinCC: Scripting (VBS, ANSI-C, VBA)
834 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
See also
Read Method (Page 785)
Examples in WinCC (Page 825)
1.15.2.11 Example: Writing Object Properties
Introduction
VBS enables access to the properties of all Graphics Designer picture objects. Properties can
be read out to be modified or changed during Runtime.
The following examples illustrate various forms of access.
Simple setting of a property
In the following example, the background color of the "Rectangle1" object contained in the
picture is set to red:
'VBS139
ScreenItems("Rectangle1").BackColor = RGB(255,0,0)
This is the simplest form of writing since no object reference is generated.
Note
If the work is completed without an object reference, only the standard properties are provided
in Intellisense.
The form of expression used in the example only applies to Graphics Designer. In the case of
analog actions in Global Script, address the objects using the HMIRuntime object.
Setting a property with object reference
In the following example, a reference is created to the "Rectangle1" object contained in the
picture and the background is set to red using the VBS standard function RGB():
'VBS140
Dim objRectangle
Set objRectangle = ScreenItems("Rectangle1")
objRectangle.BackColor = RGB(255,0,0)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 835
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Referencing is useful when several object properties must be changed. When using
Intellisense, this process then lists all the object properties.
Note
The form of expression used in the example only applies to Graphics Designer. In the case of
analog actions in Global Script, address the objects using the HMIRuntime object.
Setting properties via the picture window
VBS in Graphics Designer offers two possibilities for picture transcending addressing:
● via the Screen object of a picture window with "ScreenItems"
● from the basic picture with "HMIRuntime.Screens"
Referencing via the picture window
In the following example, the color of a rectangle is changed in an subordinate picture window.
The script is executed in the picture "BaseScreen", in which the picture window
"ScreenWindow1" is located. The picture window displays a picture, which contains an object
of the type "Rectangle" with the name "Rectangle1".
'VBS199
Sub OnLButtonUp(ByVal Item, ByVal Flags, ByVal x, ByVal y)
Dim objRectangle
Set objRectangle = ScreenItems("ScreenWindow1").Screen.ScreenItems("Rectangle1")
objRectangle.BackColor = RGB(255,0,0)
End Sub
Referencing from the basic picture
You can reference the picture with the object to be modified via HMIRuntime.Screens. The
specification of the picture is defined relative to the basic picture via the following access code:
[<Grundbildname>.]<Bildfenstername>[:<Bildname>]... .<Bildfenstername>[:<Bildname>]
In the following example, a reference is created to the "Screen2" object contained in the
"Rectangle1" picture and the background color is set to red.
The picture "Screen2", in this case, is in "Screen1". "Screen1" is displayed in the basic picture
"BaseScreen".
'VBS141
Dim objRectangle
Set objRectangle =
HMIRuntime.Screens("BaseScreen.ScreenWindow1:Screen1.ScreenWindow1:Screen2").ScreenItems("
Rectangle1")
objRectangle.BackColor = RGB(255,0,0)
WinCC: Scripting (VBS, ANSI-C, VBA)
836 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
It is not necessary to specify the picture name. It is possible to address a picture uniquely using
the picture window name. Therefore, it is sufficient to specify the name of the picture window,
as in the following example:
'VBS142
Dim objRectangle
Set objRectangle =
HMIRuntime.Screens("ScreenWindow1.ScreenWindow2").ScreenItems("Rectangle1")
objRectangle.BackColor = RGB(255,0,0)
This type of addressing enables objects in picture windows to be addressed in different
pictures. This is a particularly interesting aspect in respect of the picture module technique.
Make the property dynamic using the return value
Actions on properties can not only be triggered by events or cyclically but properties can also
be made dynamic directly via an action.
In the following example, the background color of an object is made dynamic via a return value.
The value transferred can come from the evaluation of events in the PLC, for example and
used for the graphic display of an operating status:
'VBS146
Function BackColor_Trigger(ByVal Item)
BackColor_Trigger = RGB(125,0,0)
End Function
Note
If you make an object property dynamic with a VBS action via the return value of a script, the
value of the object property is written only if it has changed in relation to the last script run. It
is not considered if the value had been changed from another location.
Therefore it is illegal to change properties which have been made dynamic by VBS action via
the return value from another location (e.g., other C scripts or VBS scripts).
if you do not observe this, wrong values can be the results.
See also
VBS Reference (Page 103)
Examples in WinCC (Page 825)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 837
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
1.15.2.12 Example: How to Start an Action on the Server (Logging Object)
Introduction
In multi-user projects, the Logging object presently functions on the server only. The following
example shows how to start an action on the server from the client, and how to swap and
delete archive segments on client accordingly.
The example shows a global action started with a control tag. The contents of the control tag
determine whether the "Restore" method or the "Remove" method is called. At the end of the
action, the control tag is set to "0".
A query prevents the action from being started on client computers.
Path and time period are passed on by internal tags.
The path information may also contain a network release. Archive segments to be swapped
must therefore not be stored locally at the server. It must be warranted, though, that the server
may directly access the path.
Note
The example shows a delete suggestion and may be adjusted as needed.
What to do
1. Create the following internal tags with project-wide updating in the WinCC Explorer:
- StartLogging (unsigned 8 bit value)
- SourcePath (Text tag 8 bit character set)
- TimeFrom (Text tag 8 bit character set)
- TimeTo (Text tag 8 bit character set)
- RetVal (signed 32 bit value)
2. Create a global VBS action and enter the tag ’StartLogging’ as tag trigger with cycle "Upon
Change".
3. Copy the following script into the action
WinCC: Scripting (VBS, ANSI-C, VBA)
838 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
'VBS180
Dim StartLogging
Dim SourcePath
Dim TimeFrom
Dim TimeTo
Dim RetVal
'Exit when running on client
If (Left(HMIRuntime.ActiveProject.Path, 1) = "\") Then
Exit Function
End If
'read parameters
StartLogging = HMIRuntime.Tags("StartLogging").Read
SourcePath = HMIRuntime.Tags("SourcePath").Read(1)
TimeFrom = HMIRuntime.Tags("TimeFrom").Read(1)
TimeTo = HMIRuntime.Tags("TimeTo").Read(1)
'restore or remove depends on the parameter
If (StartLogging = 1) Then
RetVal = HMIRuntime.Logging.Restore(SourcePath, TimeFrom, TimeTo, -1)
HMIRuntime.Tags("RetVal").Write RetVal, 1
HMIRuntime.Tags("StartLogging").Write 0,1
Elseif (StartLogging = 2) Then
RetVal = HMIRuntime.Logging.Remove(TimeFrom, TimeTo, -1)
HMIRuntime.Tags("RetVal").Write RetVal, 1
HMIRuntime.Tags("StartLogging").Write 0,1
End If
The action may be started on a client with the following action, for example. Please note that
parameters must be written prior to setting the control tag.
'VBS181
'set parameters
HMIRuntime.Tags("SourcePath").Write "\\client_pc\temp",1
HMIRuntime.Tags("TimeFrom").Write "2004",1
HMIRuntime.Tags("TimeTo").Write "2004",1
'start action
HMIRuntime.Tags("StartLogging").Write 1.1
Note
Tags are predominantly written and read in "direct" mode. This will synchronize the sequences.
Since this deals with internal tags, this mode may be used without any further concerns.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 839
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
1.15.2.13 Example: You connect or disconnect a database backup with VBS
Introduction
You can connect and read swapped-out databases with VBScript.
The example below describes access to a swapped-out WinCC process value archive via the
WinCC OLE DB Provider. A backup file is connected, read and the connection terminated
again.
1. Create connection for access via ADO and specify data source (1.1)
2. Define command for access: Read relative time range for the last 10 minutes (1.2)
3. Establish the connection (2.1)
4. Execute command (2.2)
5. Define data record structure and test first data record (2.3)
6. Call subsequent rows of the result set (3.1)
7. Clean up: Disconnect (4.1)
The example does not include error processing.
Further information on the OLE DB Provider is available in the documentation for the WinCC/
Connectivity Pack under "Access via OLE DB Provider > Retrieve archive data".
Requirement
● WinCC or WinCC/Connectivity Pack is installed on the PC.
WinCC: Scripting (VBS, ANSI-C, VBA)
840 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Example
'VBS372
Sub OnClick(Byval Item)
Const MaxRows = 100
' 1.1 Create connection string for ADO access
Dim ProviderName
Dim CatalogName
Dim DataSourceName
Dim ConnectionString
Dim CommandString
ProviderName = "Provider=WinCCOLEDBProvider.1;"
CatalogName = "Catalog=CC_Test_15_04_14_08_23_27R;"
DataSourceName = "Data Source=.\WinCC"
ConnectionString = ProviderName + CatalogName + DataSourceName
' 1.2 Define command string for access (relative time range, last 10
minutes)
CommandString = "TAG:R,'ArcTag\Tag_1','0000-00-00
00:10:00.000','0000-00-00 00:00:00.000'"
Dim DBConnection
Dim DBCommand
Dim DBRecordset
' 2.1 Open connection
HMIRuntime.Trace "before open connection" & vbNewLine
Set DBConnection = CreateObject("ADODB.Connection")
DBConnection.ConnectionString = ConnectionString
DBConnection.CursorLocation = 3
DBConnection.open
Set DBRecordset = CreateObject("ADODB.Recordset")
' 2.2 Execute command
HMIRuntime.Trace "before execute command" & vbNewLine
Set DBCommand = CreateObject("ADODB.Command")
DBCommand.CommandType = 1
DBCommand.ActiveConnection = DBConnection
DBCommand.CommandText = CommandString
Set DBRecordset = DBCommand.Execute
Dim lngCount
Dim lngValue
' 2.3 Record structure and first record data (test)
lngCount = DBRecordset.Fields.Count
HMIRuntime.Trace "RecordSet.Field.Count=" & lngCount & vbNewLine
If (lngCount>0) Then
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 841
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
DBRecordset.movefirst
lngValue = DBRecordset.Fields(0).Value
HMIRuntime.Trace "RecordSet.Fields(0).Value=" & lngValue & " (ValueID)"
& vbNewLine
lngValue = DBRecordset.Fields(1).Value
HMIRuntime.Trace "RecordSet.Fields(1).Value=" & lngValue &
" (TimeStamp)" & vbNewLine
lngValue = DBRecordset.Fields(2).Value
HMIRuntime.Trace "RecordSet.Fields(2).Value=" & lngValue & " (Value)"
& vbNewLine
lngValue = DBRecordset.Fields(3).Value
HMIRuntime.Trace "RecordSet.Fields(3).Value=" & lngValue &
" (QualityCode)" & vbNewLine
lngValue = DBRecordset.Fields(4).Value
HMIRuntime.Trace "RecordSet.Fields(4).Value=" & lngValue & " (Flags)"
& vbNewLine
Dim DBValueID
Dim DBTimeStamp
Dim DBValue
Dim DBQualityCode
Dim DBFlags
Dim Count
Count = 0
HMIRuntime.Trace "before While DBReader (MaxRows=" & MaxRows & ")" &
vbNewLine
' 3.1 Fetch subsequent rows of the result set
DBRecordset.movefirst
Do While (Not DBRecordset.EOF And Count < MaxRows)
DBValueID = DBRecordset.Fields(0).Value
DBTimeStamp = DBRecordset.Fields(1).Value
DBValue = DBRecordset.Fields(2).Value
DBQualityCode = DBRecordset.Fields(3).Value
DBFlags = DBRecordset.Fields(4).Value
HMIRuntime.Trace "Rec[" & Count & "]=( " & DBValueID & "," &
DBTimeStamp & "," & DBValue & "," & DBQualityCode & "," & DBFlags & " )" &
vbNewLine
Count = Count + 1
DBRecordset.movenext
Loop
HMIRuntime.Trace Count & "records read finish" & vbNewLine
Else
HMIRuntime.Trace "Selection returned no fields" & vbNewLine
End If
' 4.1 Clean up
DBRecordset.Close
Set DBRecordset = Nothing
Set DBCommand = Nothing
DBConnection.Close
Set DBConnection = Nothing
WinCC: Scripting (VBS, ANSI-C, VBA)
842 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
HMIRuntime.Trace "Connection closed again" & vbNewLine
End Sub
1.15.2.14 Dynamization of Controls
Example: Calling Methods of an ActiveX Control
Introduction
The following examples illustrate how to call methods and properties of an ActiveX control
which is embedded in a WinCC picture.
Example 1: WinCC FunctionTrendControl
This example fills "Trend 1" of the FuntionTrendControl "Control1" with values which describe
a parabola.
To dynamize a trend with VBS, in the configuration dialog of the control on the "Data
connection" tab under "Data supply" set "0 - None".
'VBS300
Dim lngFactor
Dim dblAxisX
Dim dblAxisY
Dim objTrendControl
Dim objTrend
Set objTrendControl = ScreenItems("Control1")
Set objTrend = objTrendControl.GetTrend("Trend 1")
For lngFactor = -100 To 100
dblAxisX = CDbl(lngFactor * 0.02)
dblAxisY = CDbl(dblAxisX * dblAxisX + 2 * dblAxisX + 1)
objTrend.InsertData dblAxisX, dblAxisY
Next
Example 2: WinCC FunctionTrendControl with value supply via array
In this example, "Trend 1" of the FunctionTrendControl "Control1" is supplied with values stored
in arrays.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 843
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
To dynamize a trend with VBS, in the configuration dialog of the control on the "Data
connection" tab under "Data supply" set "0 - None".
'VBS301
Dim lngIndex
Dim dblAxisX(100)
Dim dblAxisY(100)
Dim objTrendControl
Dim objTrend
Set objTrendControl = ScreenItems("Control1")
Set objTrend = objTrendControl.GetTrend("Trend 1")
For lngIndex = 0 To 100
dblAxisX(lngIndex) = CDbl(lngIndex * 0.8)
dblAxisY(lngIndex) = CDbl(lngIndex)
Next
objTrend.InsertData dblAxisX, dblAxisY
Example 3: WinCC FunctionTrendControl (before WinCC V7)
This example fills the FunctionTrendControl named "Control1" with values that describe a
parabola.
'VBS111
Dim lngFactor
Dim dblAxisX
Dim dblAxisY
Dim objTrendControl
Set objTrendControl = ScreenItems("Control1")
For lngFactor = -100 To 100
dblAxisX = CDbl(lngFactor * 0.02)
dblAxisY = CDbl(dblAxisX * dblAxisX + 2 * dblAxisX + 1)
objTrendControl.DataX = dblAxisX
objTrendControl.DataY = dblAxisY
objTrendControl.InsertData = True
Next
WinCC: Scripting (VBS, ANSI-C, VBA)
844 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Example 4: WinCC FunctionTrendControl with value supply via array (before WinCC V7)
In this example, a FunctionTrendControl called "Control1" is supplied with 100 value pairs. In
order that the value pair can be transferred correctly, the transfer e.g. in "dblAxisXY" must not
occur directly but via an intermediate tag, e.g. "varTemp".
'VBS152
Dim lngIndex
Dim dblXY(1)
Dim dblAxisXY(100)
Dim varTemp
Dim objTrendControl
Set objTrendControl = ScreenItems("Control1")
For lngIndex = 0 To 100
dblXY(0) = CDbl(lngIndex * 0.8)
dblXY(1) = CDbl(lngIndex)
dblAxisXY(lngIndex) = dblXY
Next
varTemp = (dblAxisXY)
objTrendControl.DataXY = varTemp
objTrendControl.InsertData = True
Example 5: Microsoft Web Browser
This example controls MS Web Browser.
'VBS112
Dim objWebBrowser
Set objWebBrowser = ScreenItems("WebControl")
objWebBrowser.Navigate "http://www.siemens.de"
...
objWebBrowser.GoBack
...
objWebBrowser.GoForward
...
objWebBrowser.Refresh
...
objWebBrowser.GoHome
...
objWebBrowser.GoSearch
...
objWebBrowser.Stop
...
Note
Insert the instructions, separated by stops, in self-defined procedures. Declaration and
assignments must always precede them.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 845
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
See also
General examples for VBScript (Page 857)
Example: How to configure a user-defined toolbar button with a self-created selection dialog
Introduction
In the following example you create a user-defined toolbar button of an OnlineTrendControl.
On this toolbar button you configure a self-created selection dialog with which you can
optionally set one of two different time ranges of the OnlineTrendControl.
Requirement
● The Graphics Designer is open.
● An archive is created in the Tag Logging Editor.
Inserting and configuring WinCC OnlineTrendControl
1. Create a new process picture in the Graphics Designer.
2. Save the process picture under "OnlineTrend.pdl".
3. Insert a WinCC OnlineTrendControl into the process picture.
4. Select "Configuration dialog..." from the shortcut menu of the control.
The "Properties of WinCC OnlineTrendControl" dialog opens.
5. On the "Trend" tab under "Data connection" connect the trend to an archive tag.
6. On the "Toolbar" tab under "Button functions" create a new user-defined toolbar button with
object ID "1001" for the OnlineTrendControl.
7. Click on "Accept" to save the changes.
8. Click "OK" to close the dialog box.
9. Select "Properties" from the shortcut menu of the control.
The "Object properties" dialog box opens.
10.Enter "Control1" as the object name for the control.
11.In the Object Properties of "Control1" select the "Event" tab.
12.On the "OnToolbarButtonClicked" object event, configure the VB script "Create VBS action
on "OnToolbarButtonClicked" event of user-defined toolbar button (VBS302)".
13.Close the "Object properties" dialog box.
Creating a process picture for the selection dialog
1. Create a new process picture in the Graphics Designer.
2. Save the process picture under "Selectiondialog.pdl".
WinCC: Scripting (VBS, ANSI-C, VBA)
846 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
3. Click the "Properties" button on the shortcut menu of the process picture.
The "Object properties" dialog box opens.
4. Under "Geometry", set value "200" for the "Picture width" and "Picture height" attributes.
5. Close the "Object properties" dialog box.
6. Insert two "Button" objects into the process picture.
7. Enter "Morning" or "Afternoon" as text for the button.
Dynamizing selection dialog button
1. In the Object Properties of the "Morning" button select the "Event" tab.
2. On the "Mouse-click" event, configure the VB script "Create VBS action on "Mouse-click"
event of "Morning" button (VBS303)".
3. Close the "Object properties" dialog box.
4. In the Object Properties of the "Afternoon" button select the "Event" tab.
5. On the "Mouse-click" event configure the VB script "Create VBS action on "Mouse-click"
event of "Afternoon" button (VBS304)".
6. Close the "Object properties" dialog box.
Inserting and configuring a picture window
1. Insert a "Picture window" object into the "OnlineTrend.pdl" process picture.
2. Select "Properties" from the shortcut menu of the picture window.
The "Object properties" dialog box opens.
3. Enter "PictureWindow1" as the object name for the picture window.
4. Under "Miscellaneous" set the "Display" attribute to "no".
5. Under "Miscellaneous", select the "Selectiondialog.pdl" process picture for the "Picture
name" attribute.
6. Close the "Object properties" dialog box.
Create VBS action on "OnToolbarButtonClicked" event of user-defined toolbar button (VBS302)
'VBS302
'Open selection window if Toolbarbutton with ID 1001 is pressed
If lId = 1001 Then
ScreenItems("PictureWindow1").Visible = True
End If
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 847
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Create VBS action on "Mouse-click" event of "Morning" button (VBS303)
'VBS303
Dim obj
Set obj = Parent.Parent.ScreenItems("Control1")
'choose time axis, stop update, set begin time and time range
obj.TimeAxisName = "Time axis 1"
obj.TimeAxisActualize = False
obj.TimeAxisBeginTime = CStr(Date & " 4:00:00")
obj.TimeAxisTimeRangeBase = 3600000
obj.TimeAxisTimeRangeFactor = 8
'close the selection window
Parent.Visible = False
Create VBS action on "Mouse-click" event of "Afternoon" button (VBS304)
'VBS304
Dim obj
Set obj = Parent.Parent.ScreenItems("Control1")
'choose time axis, stop update, set begin time and time range
obj.TimeAxisName = "Time axis 1"
obj.TimeAxisActualize = False
obj.TimeAxisBeginTime = CStr(Date & " 12:00:00")
obj.TimeAxisTimeRangeBase = 3600000
obj.TimeAxisTimeRangeFactor = 8
'close the selection window
Parent.Visible = False
Example: How to add elements to an empty WinCC OnlineTrendControl
Introduction
In the following example you insert the Trend Window, Value Axis, Time Axis and Trends
elements into an empty WinCC OnlineTrendControl.
Requirement
● The Graphics Designer is open.
● An archive is created in the Tag Logging Editor with three archive tags.
WinCC: Scripting (VBS, ANSI-C, VBA)
848 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Inserting and configuring WinCC OnlineTrendControl
1. Create a new process picture in the Graphics Designer.
2. Insert a WinCC OnlineTrendControl into the process picture.
3. Select "Configuration dialog..." from the shortcut menu of the control.
The "Properties of WinCC OnlineTrendControl" dialog opens.
4. In the "Trends" area of the "Trends" tab delete the default trend window "Trend 1".
5. Click on "Accept" to save the changes.
6. Click "OK" to close the dialog box.
7. Select "Properties" from the shortcut menu of the control.
The "Object properties" dialog box opens.
8. Enter "Control1" as the object name for the control.
9. Close the "Object properties" dialog box.
Inserting and configuring a button
1. Insert a "Button" object into the process picture.
2. Enter "Paste elements" as text for the button.
3. Select "Properties" from the shortcut menu of the button.
The "Object properties" dialog box opens.
4. In the Object Properties of the button select the "Event" tab.
5. On the "Mouse-click" event configure the VB script "Create VBS action on "Mouse-click"
event of button (VBS305)".
6. Close the "Object properties" dialog box.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 849
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Create VBS action on "Mouse-click" event of button (VBS305)
'VBS305
Dim objTrendControl
Dim objTrendWindow
Dim objTimeAxis
Dim objValueAxis
Dim objTrend
'create reference to TrendControl
Set objTrendControl = ScreenItems("Control1")
'create reference to new window, time and value axis
Set objTrendWindow =
objTrendControl.GetTrendWindowCollection.AddItem("myWindow")
Set objTimeAxis =
objTrendControl.GetTimeAxisCollection.AddItem("myTimeAxis")
Set objValueAxis =
objTrendControl.GetValueAxisCollection.AddItem("myValueAxis")
'assign time and value axis to the window
objTimeAxis.TrendWindow = objTrendWindow.Name
objValueAxis.TrendWindow = objTrendWindow.Name
'add new trend and assign properties
Set objTrend = objTrendControl.GetTrendCollection.AddItem("myTrend1")
objTrend.Provider = 1
objTrend.TagName = "TestArchive\ArchivTag1"
objTrend.Color = RGB(255,0,0)
objTrend.TrendWindow = objTrendWindow.Name
objTrend.TimeAxis = objTimeAxis.Name
objTrend.ValueAxis = objValueAxis.Name
'add new trend and assign properties
Set objTrend = objTrendControl.GetTrendCollection.AddItem("myTrend2")
objTrend.Provider = 1
objTrend.TagName = "TestArchive\ArchivTag2"
objTrend.Color = RGB(0,255,0)
objTrend.TrendWindow = objTrendWindow.Name
objTrend.TimeAxis = objTimeAxis.Name
objTrend.ValueAxis = objValueAxis.Name
'add new trend and assign properties
Set objTrend = objTrendControl.GetTrendCollection.AddItem("myTrend3")
objTrend.Provider = 1
objTrend.TagName = "TestArchive\ArchivTag3"
objTrend.Color = RGB(0,0,255)
objTrend.TrendWindow = objTrendWindow.Name
objTrend.TimeAxis = objTimeAxis.Name
objTrend.ValueAxis = objValueAxis.Name
WinCC: Scripting (VBS, ANSI-C, VBA)
850 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Note
In the VB script, replace the archive used and the archive tags "Archive\ArchiveTagX" with the
names of the archive and archive tags that have been created.
Example: How to add a trend and a setpoint trend to an empty OnlineTrendControl.
Introduction
In the following example, you add a trend and a setpoint trend to an empty WinCC
OnlineTrendControl. The time axis and value axis are added for the trends in a trend window.
Requirement
● A "WinCC OnlineTrendControl" with the name "Control2" is inserted in the process picture
in the Graphics Designer.
● A button is inserted in the Graphics Designer. You have configured the event "mouse click",
for example, for the button, with a VBS action and the following script.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 851
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Example
'VBS352
Dim objTrendControl
Dim objTrendWindow
Dim objTimeAxis
Dim objValueAxis
Dim objTrend
'tags used to generate trend data
Dim dtCurrent
Dim dblCurrent
Dim lIndex
Dim vValues(360)
Dim vTimeStamps(360)
'create reference to TrendControl
Set objTrendControl = ScreenItems("Control2")
'---- reference trend ----
'create reference to new window, time and value axis
Set objTrendWindow = objTrendControl.GetTrendWindowCollection.AddItem("myWindow")
Set objTimeAxis = objTrendControl.GetTimeAxisCollection.AddItem("myRefTimeAxis")
Set objValueAxis = objTrendControl.GetValueAxisCollection.AddItem("myRefValueAxis")
'assign time and value axis to the window
objTimeAxis.TrendWindow = objTrendWindow.Name
objTimeAxis.ShowDate = False
objValueAxis.TrendWindow = objTrendWindow.Name
'add trend and assign propertys
Set objTrend = objTrendControl.GetTrendCollection.AddItem("myRefTrend")
objTrend.Provider = 0
objTrend.Color = RGB(0,0,0)
objTrend.TrendWindow = objTrendWindow.Name
objTrend.TimeAxis = objTimeAxis.Name
objTrend.ValueAxis = objValueAxis.Name
'generate values for reference trend
dtCurrent = CDate("23.11.2006 00:00:00")
For lIndex = 0 To 360
vValues(lIndex) = ( Sin(dblCurrent) * 60 ) + 60
vTimeStamps(lIndex) = dtCurrent
dblCurrent = dblCurrent + 0.105
dtCurrent = dtCurrent + CDate ("00:00:01")
Next
'insert data to the reference trend
objTrend.RemoveData
objTrend.InsertData vTimeStamps, vValues
'---- data trend ----
'add time and value axis to the existing window
Set objTimeAxis = objTrendControl.GetTimeAxisCollection.AddItem("myTimeAxis")
Set objValueAxis = objTrendControl.GetValueAxisCollection.AddItem("myValueAxis")
'assign time and value axis to the window
WinCC: Scripting (VBS, ANSI-C, VBA)
852 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
objTimeAxis.TrendWindow = objTrendWindow.Name
objTimeAxis.ShowDate = False
objValueAxis.TrendWindow = objTrendWindow.Name
'add new trend and assign properties
Set objTrend = objTrendControl.GetTrendCollection.AddItem("myTrend")
objTrend.Provider = 0
objTrend.Color = RGB(255,200,0)
objTrend.Fill = True
objTrend.TrendWindow = objTrendWindow.Name
objTrend.TimeAxis = objTimeAxis.Name
objTrend.ValueAxis = objValueAxis.Name
'generate values for data trend
dtCurrent = CDate("23.11.2006 00:00:00")
For lIndex = 0 To 360
vValues(lIndex) = ( Sin(dblCurrent) * 60 ) + 60
vTimeStamps(lIndex) = dtCurrent
dblCurrent = dblCurrent + 0.106
dtCurrent = dtCurrent + CDate ("00:00:01")
Next
'insert values to the data trend
objTrend.RemoveData
objTrend.InsertData vValues, vTimeStamps
Result
Example: How to add elements to a WinCC OnlineTrendControl
Introduction
In the following example, insert value columns with properties in an empty WinCC
OnlineTableControl and link the columns to archive tags.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 853
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Requirement
● An archive is created in the "Tag Logging Editor" with three archive tags.
● A "WinCC OnlineTableControl" with the name "Control2" is inserted in the process picture
in the Graphics Designer.
● A button is inserted in the Graphics Designer. You have configured the event "mouse click",
for example, for the button, with a VBS action and the following script.
Example
'VBS351
Dim objTableControl
Dim objTimeColumn
Dim objValueColumn
Dim objTrend
'create reference to TableControl and enable BackColor
Set objTableControl = ScreenItems("Control2")
objTableControl.UseColumnBackColor = True
'create reference to new TimeColumn and assign column length
Set objTimeColumn = objTableControl.GetTimeColumnCollection.AddItem("myRefTimeAxis")
objTimeColumn.Length = 20
'add new ValueColumn and assign propertys
Set objValueColumn = objTableControl.GetValueColumnCollection.AddItem("myValueTable1")
objValueColumn.Provider = 1
objValueColumn.TagName = "Process value archive\PDL_ZT_1"
objValueColumn.BackColor = RGB(255,255,255)
objValueColumn.TimeColumn = objTimeColumn.Name
'add new ValueColumn and assign propertys
Set objValueColumn = objTableControl.GetValueColumnCollection.AddItem("myValueTable2")
objValueColumn.Provider = 1
objValueColumn.TagName = "Process value archive\PDL_ZT_2"
objValueColumn.BackColor = RGB(0,255,255)
objValueColumn.TimeColumn = objTimeColumn.Name
'add new ValueColumn and assign propertys
Set objValueColumn = objTableControl.GetValueColumnCollection.AddItem("myValueTable3")
objValueColumn.Provider = 1
objValueColumn.TagName = "Process value archive\PDL_ZT_3"
objValueColumn.BackColor = RGB(255,255,0)
objValueColumn.TimeColumn = objTimeColumn.Name
WinCC: Scripting (VBS, ANSI-C, VBA)
854 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Result
Example: Scripts for WinCC AlarmControl
Introduction
The following examples demonstrate the use of scripts for WinCC AlarmControl.
Requirement
● You have already configured messages in the "Alarm Logging" editor.
Example 1: Setting filters
A filter with message number "2" is set, or reset if the filter has already been set. The status
is also output in the dialog window.
'VBS353
Dim objAlarmControl
'create reference to AlarmControl
Set objAlarmControl = ScreenItems("Control1")
'set / reset the filter and create a trace
If (objAlarmControl.MsgFilterSQL = "") Then
objAlarmControl.MsgFilterSQL = "MSGNR = 2"
HMIRuntime.Trace "MsgFilterSQL set to MSGNR = 2" & vbNewLine
Else
objAlarmControl.MsgFilterSQL = ""
HMIRuntime.Trace "no filter" & vbNewLine
End If
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 855
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Example 2: Adding a column to WinCC AlarmContol
The column "Message text" is added or removed if the column already exists. The status is
also output in the dialog window. The message block of the "Message text" column has the
object name "Text1".
'VBS354
'add this function to the declaration section
Function IsExistingMsgColumn( objAlarmControl, strName )
'this function checks if the MessageColumn exists
on error resume next
objAlarmControl.GetMessageColumn( strName )
If err.number = 0 Then
IsExistingMsgColumn = True
else
err.Clear
IsExistingMsgColumn = False
end if
End Function
'example code
Dim objAlarmControl
Dim colMsgColumn
'create reference to the alarm control
Set objAlarmControl = ScreenItems("Control1")
Set colMsgColumn = objAlarmControl.GetMessageColumnCollection
'add or remove the MsgColumn
If ( IsExistingMsgColumn(objAlarmControl, "Text1") ) Then
HMIRuntime.Trace "Remove MsgColumn" & vbNewLine
colMsgColumn.RemoveItem("Text1")
Else
HMIRuntime.Trace "Add MsgColumn" & vbNewLine
colMsgColumn.AddItem("Text1")
End If
Example 3: Output content of message window in dialog window
'VBS355
Dim objAlarmControl
Dim lIndex
Dim lCellIndex
'create reference to the alarm control
Set objAlarmControl = ScreenItems("Control1")
'enumerate and trace out row numbers
For lIndex = 1 To objAlarmControl.GetRowCollection.Count
HMIRuntime.trace "Row: " & (objAlarmControl.GetRow(lIndex).RowNumber) & " "
'enumerate and trace out column titles and cell texts
For lCellIndex = 1 To objAlarmControl.GetRow(lIndex).CellCount
HMIRuntime.trace objAlarmControl.GetMessageColumn(lCellIndex -1).Name & " "
HMIRuntime.trace objAlarmControl.GetRow(lIndex).CellText(lCellIndex) & " "
Next
HMIRuntime.trace vbNewLine
Next
WinCC: Scripting (VBS, ANSI-C, VBA)
856 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
1.15.3 General Examples
1.15.3.1 General examples for VBScript
Introduction
This section contains examples of the general use of VBScript with regard to the following
topics:
● Program data connection with VBS
● To retrieve methods
● Using the MS Automation Interface
● Starting External Applications
Note
All objects supplied with the Windows Script Host (WSH) from Microsoft can be integrated in
their environment using the standard VBS method "CreateObject". However, there is no direct
access to the WSH object itself using VBS from WinCC.
Example 1: "FileSystemObject" object for working with the file system
Dim fso, MyFile
Set fso = CreateObject("Scripting.FileSystemObject")
Set MyFile = fso.CreateTextFile("c:\testfile.txt", True)
MyFile.WriteLine("This is a test.")
MyFile.Close
Example 2: "WScript.Shell"-Object for working with the Windows environment
See also
Example: Configuring a Database Connection with VBS (Page 858)
Example: Starting an external application (Page 861)
Example: Using the MS Automation interface (Page 860)
Example: Calling Methods of an ActiveX Control (Page 843)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 857
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
1.15.3.2 Example: Configuring a Database Connection with VBS
Introduction
The following examples describe the configuration of an Access database link via an ODBC
driver.
● Example 1 writes a tag value from WinCC in an Access database.
● Example 2 reads a value from the database and writes it in a WinCC tag.
The examples do not contain any handling faults.
Procedure, Example 1
1. Create the Access database with the WINCC_DATA table and columns (ID, TagValue) with
the ID as the Auto Value.
2. Set up the ODBC data source with the name "SampleDSN", reference to the above Access
database.
3. Programming.
Example 1
'VBS108
Dim objConnection
Dim strConnectionString
Dim lngValue
Dim strSQL
Dim objCommand
strConnectionString = "Provider=MSDASQL;DSN=SampleDSN;UID=;PWD=;"
lngValue = HMIRuntime.Tags("Tag1").Read
strSQL = "INSERT INTO WINCC_DATA (TagValue) VALUES (" & lngValue & ");"
Set objConnection = CreateObject("ADODB.Connection")
objConnection.ConnectionString = strConnectionString
objConnection.Open
Set objCommand = CreateObject("ADODB.Command")
With objCommand
.ActiveConnection = objConnection
.CommandText = strSQL
End With
objCommand.Execute
Set objCommand = Nothing
objConnection.Close
Set objConnection = Nothing
Procedure, Example 2
1. Create the WinCC tag with the name dbValue.
2. Create Access database with WINCC_DATA table and ID, TagValue columns: ID, create
TagValue (ID as auto value).
WinCC: Scripting (VBS, ANSI-C, VBA)
858 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
3. Set up the ODBC data source with the name "SampleDSN", reference to the above Access
database.
4. Programming.
Example 2
'VBS108a
Dim objConnection
Dim objCommand
Dim objRecordset
Dim strConnectionString
Dim strSQL
Dim lngValue
Dim lngCount
strConnectionString = "Provider=MSDASQL;DSN=SampleDSN;UID=;PWD=;"
strSQL = "select TagValue from WINCC_DATA where ID = 1"
Set objConnection = CreateObject("ADODB.Connection")
objConnection.ConnectionString = strConnectionString
objConnection.Open
Set objRecordset = CreateObject("ADODB.Recordset")
Set objCommand = CreateObject("ADODB.Command")
objCommand.ActiveConnection = objConnection
objCommand.CommandText = strSQL
Set objRecordset = objCommand.Execute
lngCount = objRecordset.Fields.Count
If (lngCount>0) Then
objRecordset.movefirst
lngValue = objRecordset.Fields(0).Value
HMIRuntime.Tags("dbValue").Write lngValue
Else
HMIRuntime.Trace "Selection returned no fields" & vbNewLine
End If
Set objCommand = Nothing
objConnection.Close
Set objRecordset = Nothing
Set objConnection = Nothing
There are several ways in which to define the ConnectionString for the connection depending
on the provider used:
Microsoft OLE DB provider for ODBC
Enables connections to any ODBC data source. The corresponding syntax is:
"[Provider=MSDASQL;]{DSN=name|FileDSN=filename};
[DATABASE=database;]UID=user; PWD=password"
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 859
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Other Microsoft OLE DB Providers (e.g. MS Jet, MS SQL Server)
It is possible to work without DSN. The corresponding syntax is:
"[Provider=provider;]DRIVER=driver; SERVER=server;
DATABASE=database; UID=user; PWD=password"
See also
General examples for VBScript (Page 857)
1.15.3.3 Example: Using the MS Automation interface
Introduction
The following three examples illustrate how to use the MS Automation interface.
Example 1: MS Excel
In this example, an output value from an input field is written in an Excel table.
'VBS113
Dim objExcelApp
Set objExcelApp = CreateObject("Excel.Application")
objExcelApp.Visible = True
'
'ExcelExample.xls is to create before executing this procedure.
'Replace <path> with the real path of the file ExcelExample.xls.
objExcelApp.Workbooks.Open "<path>\ExcelExample.xls"
objExcelApp.Cells(4, 3).Value = ScreenItems("IOField1").OutputValue
objExcelApp.ActiveWorkbook.Save
objExcelApp.Workbooks.Close
objExcelApp.Quit
Set objExcelApp = Nothing
WinCC: Scripting (VBS, ANSI-C, VBA)
860 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Example 2: MS Access
This example opens a report from MS Access.
'VBS114
Dim objAccessApp
Set objAccessApp = CreateObject("Access.Application")
objAccessApp.Visible = True
'
'DbSample.mdb and RPT_WINCC_DATA have to create before executing
'this procedure.
'Replace <path> with the real path of the database DbSample.mdb.
objAccessApp.OpenCurrentDatabase "<path>\DbSample.mdb", False
objAccessApp.DoCmd.OpenReport "RPT_WINCC_DATA", 2
objAccessApp.CloseCurrentDatabase
Set objAccessApp = Nothing
Example 3: MS Internet Explorer
This example opens the MS IE.
'VBS115
Dim objIE
Set objIE = CreateObject("InternetExplorer.Application")
objIE.Navigate "http://www.siemens.de"
Do
Loop While objIE.Busy
objIE.Resizable = True
objIE.Width = 500
objIE.Height = 500
objIE.Left = 0
objIE.Top = 0
objIE.Visible = True
See also
General examples for VBScript (Page 857)
1.15.3.4 Example: Starting an external application
Introduction
The following two examples illustrate how to start an external application.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 861
VBS for Creating Procedures and Actions
1.15 Examples of VBScript
Example:
'VBS117
Dim objWshShell
Set objWshShell = CreateObject("Wscript.Shell")
objWshShell.Run "Notepad Example.txt", 1
See also
General examples for VBScript (Page 857)
WinCC: Scripting (VBS, ANSI-C, VBA)
862 System Manual, 09/2018, A5E45518271-AA
VBS for Creating Procedures and Actions
1.16 Basic Principles of VBScript
1.16 Basic Principles of VBScript
1.16.1 Basic Principles of VBScript
Introduction
The most important topics of the Microsoft VBScript Reference are provided below:
● VBScript Language Directory
● VBScript Tutorial with the most important basic principles
● Scripting runtime reference
If a full version of the VBScript Reference is required, it is available under
http://msdn2.microsoft.com/en-us/library/t0aew7h6 (http://msdn2.microsoft.com/en-us/library/
t0aew7h6)
See also
Microsoft VBScript Reference (http://msdn2.microsoft.com/en-us/library/t0aew7h6)
1.16.2 VBScript Basics
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 863
VBS for Creating Procedures and Actions
1.16 Basic Principles of VBScript
WinCC: Scripting (VBS, ANSI-C, VBA)
864 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions 2
2.1 Creating Functions and Actions with ANSI-C
Contents
In Runtime, background tasks, such as printing daily reports, monitoring tags or performing
picture-specific calculations, are performed as actions.
These actions are started by triggers.
Functions can be called from actions. WinCC has a multitude of functions, which can be
modified by the user. Furthermore, the user can also develop his own functions.
The Global Script editor is used to create and edit functions and actions.
This chapter will show you
● How to use the Global Script editor
● How to create and edit functions
● How to create and edit actions
● How to use the diagnostic tools to analyze runtime problems
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 865
ANSI-C for Creating Functions and Actions
2.2 Creating Functions and Actions
2.2 Creating Functions and Actions
Introduction
WinCC supports the use of functions and actions for dynamization of the processes in your
WinCC project. These functions and actions are written in ANSI-C.
Difference between Functions and Actions
Actions are activated by a trigger, namely a triggering event. Functions do not have a trigger
and are used as components of actions as well as in Dynamic Dialogs, in Tag Logging and in
Alarm Logging.
Trigger Types
The following trigger types are available:
WinCC: Scripting (VBS, ANSI-C, VBA)
866 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.2 Creating Functions and Actions
Outline of the Functions and Actions
The diagram provides an overview of the range of functions and actions:
Actions are used for picture-independent background tasks, such as printing daily reports,
monitoring tags or performing calculations.
Functions are pieces of code, which can be used in several locations, but are only defined in
one place. WinCC includes a multitude of functions. Furthermore, you can also write your own
functions and actions.
The included standard functions can be modified by the user. In the event that WinCC is
reinstalled or upgraded, the standard functions that were modified are deleted or replaced by
the unedited standard functions. Therefore, you should back up the modified functions prior
to upgrading or reinstalling.
Design tool
WinCC provides the "Global Script" editor for designing, creating and editing functions and
actions. Global Script is started from the navigation window of WinCC Explorer.
Unicode support
You can set the suitable code page in the toolbar of the "Global Script" editor. This means that
the system language no longer has to be changed with the Microsoft setting "Start > Settings
> Control Panel > Regional and Language Options".
You can select "Dynamic: Project setting" as the language setting for scripts. The C script is
compiled in English. The code page of the centrally configured language is used for the strings
in runtime.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 867
ANSI-C for Creating Functions and Actions
2.2 Creating Functions and Actions
You can specify the project setting in the "Project Properties" dialog in the WinCC Explorer.
You can select the following from a list in the "Options" under "C scripts with "Dynamic"
language setting in runtime":
● "Respective set WinCC Runtime language"
The C script is executed in the WinCC Runtime language.
● Operating system language for non-Unicode programs. Select the language from the list.
The C script is executed with the code page setting of the operating system.
See also
Runtime Behavior of Actions (Page 927)
How To Create and Edit Actions (Page 907)
Creating and Editing Functions (Page 894)
The Global Script Editor (Page 880)
Use of DLLs in Functions and Actions (Page 878)
Use of Global C-Tags (Page 876)
How to Add Global Script Runtime to a Project's Startup List (Page 875)
How to Generate a New Header (Page 890)
Characteristics of Global Actions (Page 874)
Characteristics of Local Actions (Page 873)
Characteristics of Internal Functions (Page 872)
Characteristics of Standard Functions (Page 870)
Characteristics of Project Functions (Page 869)
WinCC: Scripting (VBS, ANSI-C, VBA)
868 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.3 Characteristics of Project Functions
2.3 Characteristics of Project Functions
Characteristics of Project Functions
Project functions ...
● can be created by yourself
● can be edited by you
● can be password-protected against modification and viewing by unauthorized persons
● have no trigger
● are only known within the project
● are assigned file name extension "*.fct"
Project functions are saved in the "\library"" subdirectory of the WinCC project.
Use of Project Functions
Project functions can be used...
● in other project functions
● in Global Script actions
● in C-Actions in the Graphics Designer and within the Dynamic Dialog
● in Alarm Logging within the Loop in Alarm functionality
● in Tag Logging when starting and releasing archives and when swapping-out cyclic archives
See also
How to Protect a Function Against Unauthorized Access (Page 902)
Creating and Editing Functions (Page 894)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 869
ANSI-C for Creating Functions and Actions
2.4 Characteristics of Standard Functions
2.4 Characteristics of Standard Functions
Characteristics of Standard Functions
Standard functions ...
● are provided for use in WinCC
● cannot be created by yourself
● can be edited by you
● can be password-protected against modification and viewing by unauthorized persons
● have no trigger
● are known across projects
● are assigned file name extension "*.fct"
Standard functions are saved in the "\aplib" subdirectories in the WinCC installation directory.
Use of Standard Functions
Standard functions can be used...
● in project functions
● in other standard functions
● in Global Script actions
● in C-actions in the Graphics Designer and within the Dynamic Dialog
● in Alarm Logging within the Loop in Alarm functionality
● in Tag Logging when starting and releasing archives and when swapping-out cyclic archives
WinCC: Scripting (VBS, ANSI-C, VBA)
870 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.4 Characteristics of Standard Functions
Note
The included standard functions can be edited by the user. In the event that WinCC is
reinstalled or upgraded, the standard functions that were modified are deleted or replaced by
the unedited standard functions. Therefore, you should back up the modified functions prior
to upgrading or reinstalling.
See also
How to Use Standard and Project Functions (Page 900)
Creating and Editing Functions (Page 894)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 871
ANSI-C for Creating Functions and Actions
2.5 Characteristics of Internal Functions
2.5 Characteristics of Internal Functions
Characteristics of Internal Functions
Internal functions ...
● are provided for use in WinCC
● cannot be created by you
● cannot be edited
● cannot be renamed
● have no trigger
● are know project-wide
● are assigned file name extension "*.icf"
Internal functions are saved in the "\aplib" subdirectories in the WinCC installation directory.
Use of Internal Functions
Internal functions can be used...
● in project functions
● in standard functions
● in actions
● in C-actions in the Graphics Designer and within the Dynamic Dialog
WinCC: Scripting (VBS, ANSI-C, VBA)
872 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.6 Characteristics of Local Actions
2.6 Characteristics of Local Actions
Characteristics of Local Actions
Local actions ...
● can be created by yourself
● can be edited by you
● can be password-protected against modification and viewing by unauthorized persons
● have at least one trigger
● are only executed on the assigned computer
● are assigned file name extension "*.pas"
Local actions are saved in the "\<computer_name\Pas" subdirectory in the project directory.
Use of Local Actions
Actions are used for picture-independent background tasks, such as printing daily reports,
monitoring tags or performing calculations. An action is started by the trigger configured for it.
In order for an action to be executed, Global Script Runtime must be included in the startup
list.
In contrast to global actions, local actions can be assigned to a single computer. It is thus for
example possible to ensure that a report is only printed on the server.
See also
How to Protect an Action Against Unauthorized Access (Page 914)
Triggers (Page 916)
How To Create and Edit Actions (Page 907)
How to Add Global Script Runtime to a Project's Startup List (Page 875)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 873
ANSI-C for Creating Functions and Actions
2.7 Characteristics of Global Actions
2.7 Characteristics of Global Actions
Characteristics of Global Actions
Global actions ...
● can be created by yourself
● can be edited by you
● can be password-protected against modification and viewing by unauthorized persons
● have at least one trigger to start them
● are executed on all project computers in a client-server project
● are assigned file name extension "*.pas"
Global Actions are saved in the "\Pas" subdirectory of the WinCC project.
Use of Global Actions
Actions are used for background tasks, such as printing daily reports, monitoring tags or
performing calculations. An action is started by the trigger configured for it. In order for an
action to be executed, Global Script Runtime must be included in the startup list.
In contrast to local actions, global actions are executed on all project computers in a client-
server project. In a single-user project there is no difference between global and local actions.
See also
How to Protect an Action Against Unauthorized Access (Page 914)
Triggers (Page 916)
How To Create and Edit Actions (Page 907)
How to Add Global Script Runtime to a Project's Startup List (Page 875)
WinCC: Scripting (VBS, ANSI-C, VBA)
874 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.8 How to Add Global Script Runtime to a Project's Startup List
2.8 How to Add Global Script Runtime to a Project's Startup List
Introduction
In order to run Global Script Actions in Runtime, Global Script Runtime must be added to the
project's startup list. This does not affect the executability of the functions.
Procedure
1. In the shortcut menu of computer in WinCC Explorer, select "Properties". The "Computer
list properties" dialog opens.
2. Click "Properties". The "Computer Properties" dialog opens.
3. Select the "Startup" tab
4. Activate "Global Script Runtime".
5. Click "OK" to close the dialog.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 875
ANSI-C for Creating Functions and Actions
2.9 Use of Global C-Tags
2.9 Use of Global C-Tags
Definition of global C tags
A global C-tag is defined by adding the definition line in front of the function name of a function:
int a; //The tag a is defined as an integer
void dummy() //Function name
{
. //Function code
}
Validity range
A tag defined in this manner is known to every function and action in Runtime. It is created as
soon as Runtime is started, even if the function itself was not called.
Note
When you operate the WinCC Service Mode, there is no common data area for C scripting.
Thus, for example, no global C variables can be exchanged between "Global Script" and the
"Graphics Designer".
Use of global C tags
Global C tags are used in functions or actions by declaring them as external within the function
or action:
void dummy() //Function name
{
extern int a; //External declaration of the tag a
. //Function code
}
The compiler is thus informed that it need not create the tag, since it is created in another
location in Runtime.
If the value of tag a changes, this change can be read by every function and action.
Each C-tag may only be defined in one location. For reasons of clarity and to avoid duplicate
definitions, we recommend defining global C tags in only one location.
WinCC: Scripting (VBS, ANSI-C, VBA)
876 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.9 Use of Global C-Tags
Note
A maximum of 64 Kbytes are available to a function and the global C-tag defined with it.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 877
ANSI-C for Creating Functions and Actions
2.10 Use of DLLs in Functions and Actions
2.10 Use of DLLs in Functions and Actions
Adjusting DLLs
WinCC allows you to use your own DLLs (Dynamic Link Libraries).
Functions in existing DLLs can be enabled for functions and actions by making the necessary
additions to the respective function or action.
Add the following code in front of the function or action:
#pragma code("<Name>.dll")
<Type of returned value> <Function_name 1>(...);
<Type of returned value> <Function_name2>(...);
.
.
.
<Type of returned value> <Function_name n>(...);
#pragma code()
The functions <Function_name 1> ... <Function_name n> from <Name.dll> are declared and
can now be called by the respective function or action.
Example:
#pragma code("kernel32.dll")
VOID GetLocalTime(LPSYSTEMTIME lpSystemTime);
#pragma code()
SYSTEMTIME st;
GetLocalTime(&st);
As an alternative to this procedure, you can also make the necessary additions in the
"Apdefap.h" header file.
When using own DLLs in WinCC, you must use the release version. WinCC is delivered as a
release version and thus uses the release version of the system DLLs. If you generate a custom
DLL in the debug version, it is possible that both the release and the debug version of the DLL
are loaded, increasing the memory requirements.
WinCC: Scripting (VBS, ANSI-C, VBA)
878 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.10 Use of DLLs in Functions and Actions
Structures of the DLL have to be set up using 1-byte alignment.
Note
The DLL must be saved in either the "\bin" directory or in a path defined in the "PATH" system
tag. This tag is defined in the operating system properties.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 879
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
2.11 The Global Script Editor
2.11.1 The Global Script Editor
Introduction
WinCC supports the creation and editing of functions and actions with the Global Script editor.
Global Script is started from the project window of WinCC Explorer.
Structure of the Global Script Editor
The Global Script editor is designed in accordance with the Windows standards. It comes with
toolbars, a menu bar and a status bar. It has several windows featuring drop-down menus.
Menu bar (1)
The menu bar content depends on the situation. It is always visible.
Toolbars (2)
Global Script contains two toolbars You may always unhide these toolbars and use the mouse
WinCC: Scripting (VBS, ANSI-C, VBA)
880 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
to move them to any screen position.
You may hide/unhide the toolbars using the "View" > "Toolbars" menu command and move
these to any position in the editor.
Navigation window (3)
The navigation window serves to select functions and actions for editing, or to insert an editing
window at the cursor position. The functions and actions are organized in groups with hierarchic
order. Functions are always displayed by their function name, while actions are displayed by
their file name.
Editing window (4)
The editing window is used to edit functions and actions. It is only visible when a function or
action has been opened for editing. Each function or action is opened in a separate edit
window. Several editing windows can be opened simultaneously.
Output window (5)
The output window displays results of the "Search in files" or "Compile all functions" functions.
By default, it is visible, but can be hidden.
● Search in files:
A hit list is returned for each search term found in a single line of the output window, which
consists of the line number, path and file name, as well as the line text with the specified
number of the line in which the search term was found. You can directly open the
corresponding file by double-clicking an entry in the output window. The cursor is placed
in the line in which the search term was found.
● Compile All Functions:
Compiler warnings and error messages are output for all functions compiled. In the next
line, the path and file name of the compiled function as well as the summary message from
the compiler are displayed.
Status bar (6)
The status bar is located on the bottom edge of the Global Script window; you may hide/unhide
the status bar. It contains information about the position of the cursor in the edit window and
the keyboard settings. In addition, the status bar shows either a brief description for the
currently selected Global Script functionality or a tip.
Window docking
Window docking is a useful tool for the flexible arrangement of windows. It lets you reposition
windows to obtain separate windows, or to group windows in tab groups. For example, you
can arrange your actions horizontally, vertically, or as tab group. You may hide windows
automatically and show these again as required.
For more information ,refer to chapter "Creating process pictures".
See also
Printing Functions and Actions (Page 892)
How to Search in Files (Page 891)
How to Compile All Functions (Page 890)
How to Generate a New Header (Page 890)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 881
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
How to Delete Actions or Project and Standard Functions (Page 889)
How to Use "Save As..." (Page 888)
How to Set the Font Style (Page 888)
How to Set Different Views (Page 887)
Working with the Toolbars (Page 885)
Working in the Edit Window (Page 882)
2.11.2 Working in the Edit Window
2.11.2.1 Working in the Edit Window
Introduction
The edit window includes an array of functions, which can be executed with either the keyboard
or the mouse.
In the edit window, you can edit functions and actions.
Contents
The window can be split. The upper part of the edit window displays the code of the function
or action. In the lower part, you can see the messages that the compiler output while compiling
the function or action.
WinCC: Scripting (VBS, ANSI-C, VBA)
882 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
Properties
When the window is opened for the first time, the lower part of the window is minimized. When
the compiler process is started, the lower part of the window is enlarged to allow for the display
of the compiler messages. The division of the window can be adjusted with the mouse. Double-
click an error message to jump to the corresponding line in the code.
Color code
The C code is color-coded as follows:
Color Description Example
Blue Keywords define, double, if
Green Comments // is a comment
Red Strings "Rectangle3"
Black Other C-codes level=100*newvalue/255;
Note
A function or action cannot have more than 32767 characters including spaces.
See also
Editing Functions with the Mouse (Page 884)
Editing Functions with the Keyboard (Page 883)
2.11.2.2 Editing Functions with the Keyboard
You can carry out the following editing functions using the keyboard:
Editing function Keyboard operation
Switch between write modes Insert/Overwrite <INSERT>
Add new line <ENTER>
Delete one character to the right <DELETE>
Delete one character to the left <BACKSPACE>
Delete marked text <DELETE> or <BACKSPACE>
Jump to beginning of line <POS1>
Jump to end of line <END>
Jump to beginning of text <CTRL+POS1>
Jump to end of text <CTRL+END>
Move cursor <Cursor keys>
Move cursor by one window content to beginning <PAGE UP>
of text
Move cursor by one window content to end of text <PAGE DOWN>
Move cursor to first line in window <CTRL+PAGE UP>
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 883
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
Editing function Keyboard operation
Move cursor to last line in window <CTRL+PAGE DOWN>
Jump to next tab position <TAB>
Cut marked text and paste to clipboard <CTRL+X>
Copy marked text to clipboard <CTRL+C>
Paste text from clipboard <CTRL+V>
2.11.2.3 Editing Functions with the Mouse
You can carry out the following editing functions using the mouse:
Editing code Mouse command (left mouse button)
Select text Drag mouse over text
Select a word Double-click the word
Select a line Place the mouse pointer at the start of the line and click.
Extended selection <Shift> + click
Set cursor Click
Move selected text Drag and drop
Duplicate selected text <Ctrl> + drag and drop
Open the shortcut menu Click with the right mouse button
Editing code Mouse action (right mouse button)
Open the shortcut menu Right-click in the text window
Other editing functions
● Compiler error messages:
– By double-clicking a compiler error message, the editor jumps to the corresponding line
in the code.
● With the following actions, the selected text is replaced by the result of the action:
– Input of character(s) using the keyboard
– Pasting of text from the clipboard
– Insertion of a function call by means of parameter assignment
WinCC: Scripting (VBS, ANSI-C, VBA)
884 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
2.11.3 Working with the Toolbars
Purpose
The toolbars are located in their default position below the menu bar, at the top of the Global
Script window. The toolbar buttons allow for fast and easy execution to a number of Global
Script functions.
There are two toolbars available:
"Standard" toolbar
"Edit" toolbar
Contents
The standard toolbar contains buttons for the following functions:
Button Function Key combination
Creates a new action. <ALT+A> or
<CTRL+N>
Creates a new standard function. <ALT+S> or
<CTRL+N>
Creates a new project function. <ALT+P> or
<CTRL+N>
Creates a new header file. <CTRL+H>
Opens an existing action or function. <CTRL+O>
Saves the content of the active editing window. This func‐ <CTRL+S>
tion is only available if an editing window is open.
Cuts the selected text and copies it to the clipboard. This <CTRL+X>
function is only available if text has been selected.
Copies the selected text to the clipboard. This function is <CTRL+C>
only available if text has been selected.
Pastes the contents of the clipboard at the location of the <CTRL+V>
cursor. This function is only available if the clipboard is not
empty.
Undoes the last of a maximum of 30 editor actions. This <CTRL+Z>
function is only available if an editor action has been per‐
formed.
Redoes the last editor action that was undone. This func‐ <CTRL+A>
tion is only available if an editor action has been undone.
Prints the contents of the active editing window as project <CTRL+P>
documentation. This function is only available if an editing
window is open.
Activates the direct help (What's this?). <SHIFT+F1>
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 885
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
Button Function Key combination
Generates a new header. <CTRL+G>
Allows you to set the font. <CTRL+F>
Note
The key combination <CTRL+N> is only available if at least one editing window is open. If the
active editing window contains a function and <CTRL+N> is pressed, a new project function
is created. If the active editing window contains an action, this key combination creates a new
global action.
The editing toolbar contains buttons for the following functions:
Button Function Key combination
Enables you to add information <CTRL+I>
about functions and, in the case
of an action, to setup a trigger.
This function is only available if
an editing window is open.
Compiles the code in the active <SHIFT+F8>
editing window. This function is
only available if an editing win‐
dow is open.
Set the appropriate code page. -
Verify that the code page selec‐
tion matches the source text.
You cannot use more than one
language in the source text.
Opens the tag dialog. This func‐ <CTRL+R>
tion is only available if an editing
window is open.
Opens a dialog for the selection <CTRL+W>
of a picture. The name of the se‐
lected picture is inserted at the
position of the cursor in the edit‐
ing window. This function is only
available if an editing window is
open.
Imports an action. This function <CTRL+M>
is only available if the active win‐
dow contains an action.
WinCC: Scripting (VBS, ANSI-C, VBA)
886 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
Button Function Key combination
Exports the action from the ac‐ <CTRL+T>
tive editing window. This function
is only available if the active win‐
dow contains an action.
Sets the authorization for operat‐ <CTRL+E>
ing the action. This function is
only available if the active win‐
dow contains an action.
Properties
Both toolbars can be shown or hidden.
They can be pinned below the menu bar.
When they are not pinned down, they can be dragged with the mouse to any position on the
screen.
See also
How to Set Different Views (Page 887)
2.11.4 How to Set Different Views
Introduction
In this context, views are considered to be different combinations of elements visible in the
Global Script editor, such as the output window, status bar and toolbars. These elements can
be individually displayed or hidden.
By default, all elements are visible.
Procedure
1. Opens the "View" menu in the Global Script menu bar.
2. Activate or deactivate the display of the desired elements e.g. the toolbars. If "show" is
chosen, a check mark is displayed in front of the name.
Note
When Global Script restarted, the editor reverts to the default settings and all elements are
again visible.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 887
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
2.11.5 How to Set the Font Style
Introduction
The font style is composed of the settings "Font", "Style" and "Size".
The style selected is active in all edit windows.
Procedure
1. Click the button in the standard toolbar to open the dialog for setting the font style.
2. Make the desired settings.
3. Confirm your settings by clicking "OK".
Alternative procedure
You can also open the dialog for the font style settings in the following manner:
Select the "Options" menu in the Global Scripts menu bar and select "Font", or use the
corresponding key combination.
Note
The settings are automatically saved and are not reset when WinCC is restarted.
2.11.6 How to Use "Save As..."
Introduction
If a function or action is created, Global Script saves the corresponding file in a predefined
path with a default file name, e.g. "new_function_1.fct" for functions and "gsccs1.pas" for
actions. Since these default file names are not particularly useful, use "Save As ..." to save
the function or action under a different - more meaningful - file name. The file with the default
file name is retained.
With "Save As ...", only the file name is changed, the function or action name remains
unchanged.
Global Script expects that the function or action is saved in a project directory. If this is not
the case, a message is displayed, but the file is saved nonetheless.
Requirement
"Save As..." is only available, if at least one edit window is open. It saves the content of the
active edit window.
WinCC: Scripting (VBS, ANSI-C, VBA)
888 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
Procedure
1. In the Global Script menu bar, open the "File" menu.
2. Select "Save As...".
3. Enter the new file name.
4. Close the dialog by clicking the "Save" button.
See also
How to Delete Actions or Project and Standard Functions (Page 889)
2.11.7 How to Delete Actions or Project and Standard Functions
Introduction
Actions or project and standard functions can be deleted during configuration or in Runtime.
Global Script deletes the entry in the navigation window as well as the associated file.
If a deleted function is called by an action, the action is terminated upon calling the function.
If a Global Script diagnostic window is open at this time, a message is displayed. The
termination of the action is logged in the "WinCC_Sys_xx.log" diagnostic file (xx = consecutive
number). This diagnostic file is located in the "Diagnostics" subdirectory of the WinCC
installation directory.
Procedure
1. In the Global Script navigation window, call up the shortcut menu for the function or action
to be deleted.
2. Select "Delete".
3. Confirm the command by clicking "Yes".
Alternative operation
Instead of using the shortcut menu, you can also delete the selected function or action by using
the <DELETE> key.
Note
If a function is deleted, the entry in the respective header file is deleted as well.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 889
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
2.11.8 How to Generate a New Header
Introduction
The header must be generated again in the following cases:
● After you have copied project functions from a different project to the "library" directory in
your project path.
● After you have copied standard functions from another PC to the "aplib" directory or
subdirectories.
By regenerating the header, you enter the copied functions in the respective header files. You
can then use the functions in your project.
Procedure
1. Click in the "Standard" toolbar.
Alternative operation
Alternatively, you can start a generation process as follows:
Open the "Options" menu and select "Regenerate Header" or use the corresponding key
combination.
Note
Once the regeneration is finished, the contents of the navigation window are updated.
If WinCC is in Runtime, the Runtime system is not influenced by the regeneration of the header.
2.11.9 How to Compile All Functions
Introduction
If you have changed the header files manually, you have to recompile all functions. All project
functions, standard functions and internal functions are automatically compiled with the menu
command "Compile all functions".
If functions are called in other functions, error messages are possible. The reason for this is
that the called functions have not yet been compiled. These functions must then be compiled
individually.
Requirement
This function is only available, if all edit windows are closed.
WinCC: Scripting (VBS, ANSI-C, VBA)
890 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
Procedure
1. Open the "Options" menu.
2. Select "Compile All Functions".
Alternative operation
You can compile all functions using the key combination <ALT+U>.
Result
The results of the individual compilation runs are displayed in the output window, e.g. warnings
and error messages of the compiler. The path and the file name of the compiled function as
well as the summary message of the compiler are also displayed.
Note
In a multi-user project, the "Compile All Functions" function is not available. Assigning functions
is no longer possible with these projects.
The functions compiled in this way will not become active until the next time you start Runtime
on a WinCC PC.
2.11.10 How to Search in Files
Introduction
All files of the group selected in the navigation window are searched for the specified search
term.
The result of the search is displayed in the output window as follows:
For each found search term, a line is displayed in the output window. This line contains the
line number of the line in the code in which the search term was found, plus the path and file
name as well as the line of code itself.
Standard and project functions as well as actions can be opened by double-clicking the search
results. The cursor is positioned at the start of the line in which the search term was found. In
the case of internal functions, the function containing the search term is shown in the navigation
window and selected.
Procedure
1. Open the shortcut menu for the group to be searched in the Global Script navigation window.
2. Select "Find in Files".
3. In the dialog, enter the search term to be found.
4. Click "Find" to start the search. The result of the search is displayed in the output window.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 891
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
2.11.11 Printing Functions and Actions
2.11.11.1 Printing Functions and Actions
Introduction
Actions or project or standard functions can be printed using specified system layouts.
This is however only possible, if the function or action to be printed is displayed in the edit
window. The content of the active edit window is printed.
The printout can be examined on the screen in page view.
The printing process can be controlled by a number of print parameters.
The following system layouts are used:
● @gsc_pfc.rpl for project functions
● @gsc_sfc.rpl for standard functions
● @gsc_act.rpl for actions
See also
How to Print the Project Documentation (Page 893)
How to Open Page View (Page 893)
How to Set the Print Parameters (Page 892)
2.11.11.2 How to Set the Print Parameters
Introduction
You can modify the printout as follows:
● By specifying a layout that differs from the standard layout
● By selecting a page range
● By selecting a printer selection
● By printing to file
Requirement
At least one edit window must be open.
Procedure
1. In the Global Script menu bar, open the "File" menu.
2. Select "Project Documentation Setup..."
WinCC: Scripting (VBS, ANSI-C, VBA)
892 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.11 The Global Script Editor
3. In the subsequent dialog, adjust the desired settings.
4. Apply the settings by clicking "OK".
Note
The settings are automatically saved and are not reset when WinCC is restarted.
2.11.11.3 How to Open Page View
Introduction
Before you begin printing a function or action, it is sometimes an advantage to first see a
preview of the printout on the screen (in page view).
The content of the active edit window is displayed in page view.
Procedure
1. In the Global Script menu bar, open the "File" menu.
2. Select "Project Documentation Setup...".
2.11.11.4 How to Print the Project Documentation
Introduction
You can output the contents of the active edit window to a printer or to a file. The selected print
parameter settings are applied.
Procedure
1. In the Global Script menu bar, open the "File" menu.
2. Select "Print Project Documentation".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 893
ANSI-C for Creating Functions and Actions
2.12 Creating and Editing Functions
2.12 Creating and Editing Functions
2.12.1 Creating and Editing Functions
Introduction
The system distinguishes between project, standard and internal functions. WinCC is delivered
with a broad selection of standard and internal functions. Furthermore, you can create your
own project and standard functions or modify standard functions. Please remember, however,
that the standard functions included with WinCC are overwritten when WinCC is reinstalled so
any modifications are lost.
Internal functions cannot be created or edited.
Using Functions
If the same calculation must be performed - with different starting values - in several actions,
it would be to your advantage to program a function to perform this calculation. Subsequently
you can simply call this function with the current parameters in the actions.
This approach has a number of advantages:
● The code is only programmed once.
● Modifications are only made at one point, namely in the procedure, not in each action.
● The action code is shorter and, thus clearer.
WinCC: Scripting (VBS, ANSI-C, VBA)
894 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.12 Creating and Editing Functions
Finding Functions
To access existing functions or create new ones, you can either use the "File" menu in the
Global Script navigation window or click the corresponding button in the toolbar.
Functions are stored in the file system as follows:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 895
ANSI-C for Creating Functions and Actions
2.12 Creating and Editing Functions
Editing and Compiling Functions
A function is edited and compiled in its own edit window. The edit window displays messages
from the compiler after a compilation run. These might be warnings or error messages. In each
case, a summary of the number of warnings and error messages is output.
What Happens When Functions Are Renamed?
In the navigation window, functions are always displayed with their function not their Windows
file names. If you change the name of a function and then compile it, the name displayed in
the navigation window longer match the function name. This is indicated in the navigation
window with the prefix "*" (asterisk) in front of the name. As soon as you save the function, the
current function name is displayed in the navigation window.
Note re. Saving Functions
If you save a function that has not been properly compiled, the symbol is shown in the
navigation window.
If you save a function that has not been compiled without errors, the symbol is shown in the
navigation window.
See also
Working in the Edit Window (Page 882)
How to Use Functions from Other Sources (Page 906)
How to Rename a Function (Page 905)
How to Compile and Save a Function (Page 903)
How to Protect a Function Against Unauthorized Access (Page 902)
Inserting Additional Function-Related Information (Page 901)
How to Use Standard and Project Functions (Page 900)
How to Use Internal Functions (Page 899)
How to Write Function Code (Page 898)
How to Create a New Function (Page 897)
Characteristics of Standard Functions (Page 870)
Characteristics of Project Functions (Page 869)
WinCC: Scripting (VBS, ANSI-C, VBA)
896 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.12 Creating and Editing Functions
2.12.2 How to Create a New Function
Introduction
The procedure is identical for both project and standard functions. In the navigation window,
specify the type (project or standard function) and, for standard functions, the group, e.g.
"graphics". This also specifies the place where the file is to be saved.
Global Script suggests a default name, e.g. "new_function_3", for the new function. This is also
the file name of the function. To ensure that the function name is unique, the suggested name
includes a sequential number.
As a rule, the default name should be replaced with a more informative function name. When
the renamed function is first saved, the file name can also be changed.
Global Script adds the following information to the function: date created, date modified and
version. This information can be viewed in the "Properties" dialog. In the same dialog, you can
also assign a password to protect the function against unauthorized modification or viewing.
To open the dialog, click the button.
Note
The characters supported by ANSI-C are also supported for the function name:
● Letters, apart from regional special characters
● Numbers
● Underscore
Procedure
1. In the navigation window, open the shortcut menu for the desired group.
2. Select "New"
If a new function has been created, the first line of code in the associated edit window
contains the type of return value and the default name of the new function. In the brackets
following this, you can enter transfer parameters if you wish.
The function code is entered between the curly brackets.
Alternative operation
Alternatively, you can also create a new function by clicking the associated button in the toolbar,
via the "File" menu or by using the corresponding key combination.
See also
Inserting Additional Function-Related Information (Page 901)
How to Use "Save As..." (Page 888)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 897
ANSI-C for Creating Functions and Actions
2.12 Creating and Editing Functions
2.12.3 How to Write Function Code
Introduction
The function code is written in the edit window for the function. The programming language is
ANSI-C.
The code of any project or standard function can call other functions. The called function can
be a project, standard, internal or DLL function. To make certain that the called function is
known to the calling function, the line #include "apdefap.h" is added as the first line of code in
the calling function code.
In the navigation window under "Internal Functions", the C-function library is available as
"c_bib".
The first line of code contains the type of the return value and the default name of the new
function. Parameters can be passed by entering them in the following brackets.
The function code is entered between the curly brackets.
Note
Storage space for local tags
A maximum of 32 KB of memory is available for local tags (tags defined within the curly brackets
of the function code).
Path information
Use a double backslash as separator for folder information:
● Double backslash: \\
Example
Addressing a process picture in the "New Folder" GraCS subdirectory:
void OnClick(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName)
{
SetLeft("New Folder\\PictureInSubfolder.pdl","Circle1",60);
}
Procedure
1. Double-click the function in the navigation window to open it in an edit window.
2. Set the cursor where you wish to begin writing.
3. Enter the desired code.
Alternative operation
You can also open a function as follows:
WinCC: Scripting (VBS, ANSI-C, VBA)
898 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.12 Creating and Editing Functions
In the navigation window, open the shortcut menu of the desired action and select "Open" or
use the "File/Open..." menu.
You can also click on the button in the "Standard" toolbar or use the corresponding key
combination.
See also
How to Use Standard and Project Functions (Page 900)
How to Use Internal Functions (Page 899)
Editing Functions with the Mouse (Page 884)
Editing Functions with the Keyboard (Page 883)
Working in the Edit Window (Page 882)
2.12.4 How to Use Internal Functions
Introduction
You can use any of the internal functions as part of your function code. The internal functions
are found in the navigation window in the "Internal Functions" group.
If you have used the "Assigning Parameters" dialog to add a function, the function's comments
show the type of value returned.
Procedure
1. Place the cursor at the point at which the internal function is to be inserted.
2. In the navigation window, open the shortcut menu for the internal function to be added.
3. Select "Assigning Parameters". The "Assigning Parameters" dialog is opened.
This dialog has one line for each parameter. In the "Value" column, enter the respective
current parameter.
4. In the "Value" column, enter the current value for each of the required parameters.
This can be accomplished by either a direct entry from the keyboard, or you can open the
menu in the "Value" column (single-click and then click the displayed button). From the
menu, you can open the selection dialog for tags, pictures or graphic objects.
5. Confirm your entries with "OK". The parameterized function is inserted in the edit window
at the location of the cursor.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 899
ANSI-C for Creating Functions and Actions
2.12 Creating and Editing Functions
Alternative operation
Alternatively you can also open the "Assigning Parameters" dialog for an internal function by
double-clicking the function to be added.
Note
If you close the "Assigning Parameters" dialog with "OK" without entering the current parameter
value, the internal function is inserted with its formal parameters. You can then set the
parameters in the edit window at a later stage.
Instead of using the "Assigning Parameters" dialog, you can also use the keyboard to enter
the function.
2.12.5 How to Use Standard and Project Functions
Introduction
You can use any project or standard function as part of the function code, if you have first
added the line #include "apdefap.h" in the header. The project functions are found in the
navigation window in the "Project Functions" group. The standard functions are found in the
navigation window in the "Standard Functions" group.
Project functions are entered in the "Ap_pbib.h" header file; standard functions are entered in
the "Ap_glob.h" header file. These entries are made by the system. The " Ap_glob.h" header
file is integrated into the "Ap_pbib.h" header file. The "Ap_pbib.h" header file itself is linked to
the "Apdefap.h" header file. Therefore all project and standard functions are declared in the
"Apdefap.h" file header.
To inform the compiler of the project and standard functions added, add the line #include
"apdefap.h" as the first line in the function code.
If you have used the "Assigning Parameters" dialog to add a function, the function comments
show the type of value returned.
Procedure
1. Place the cursor at the point at which the project or standard function is to be inserted.
2. In the navigation window, open the shortcut menu for the function to be added.
3. Select "Assigning Parameters". The "Assigning Parameters" dialog is opened.
This dialog has one line for each parameter. In the "Value" column, enter the respective
current parameter.
4. In the "Value" column, enter the current value for each of the required parameters.
This can be accomplished by either a direct entry from the keyboard, or you can open the
menu in the "Value" column (single-click and then click the displayed button). From the
menu, you can open the selection dialog for tags, pictures or graphic objects.
5. Confirm the entries by clicking "OK".
WinCC: Scripting (VBS, ANSI-C, VBA)
900 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.12 Creating and Editing Functions
Note
If the function does not require a parameter, it is added to the function code immediately without
opening the "Assigning Parameters" dialog.
If you close the "Assigning Parameters" dialog with "OK" without entering the current parameter
value, the internal function is inserted with its formal parameters. You can then set the
parameters in the edit window at a later stage.
2.12.6 Inserting Additional Function-Related Information
Introduction
Additional information can be assigned to every function.
When a new action is created, the creation date is automatically entered in the function-related
information and is unchangeable. In addition, the version number 1.0 is also assigned to the
number. The version numbers can be individually assigned when editing a function. When a
function is changed and saved, the current date of change is entered automatically and is
unchangeable. This dialog can be used to assign a password to protect the function from
unauthorized viewing and modification.
Requirements
The function to which the information relates must be open in an edit window.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 901
ANSI-C for Creating Functions and Actions
2.12 Creating and Editing Functions
Procedure
1. Click the button in the editing toolbar. The "Properties" dialog is opened.
2. Select the required entries.
3. Confirm the entries by clicking "OK".
Alternative operation
Alternatively, the "Properties" dialog can be opened as follows:
Click the "Edit" menu and select the "Info" option or use the corresponding key combination.
See also
How to Protect a Function Against Unauthorized Access (Page 902)
How to Set Different Views (Page 887)
Working with the Toolbars (Page 885)
2.12.7 How to Protect a Function Against Unauthorized Access
Introduction
Functions can be protected with a password against unauthorized read and write access. The
password is a part of the function-related information.
Requirement
The function to be compiled must be opened in the edit window.
WinCC: Scripting (VBS, ANSI-C, VBA)
902 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.12 Creating and Editing Functions
Procedure
1. Click in the "Edit" toolbar. The "Properties" dialog is opened.
2. Select the "Password" check box.
3. Click the "Change" button.
4. Enter the password in the "Password" field.
5. Enter the password again in the "Confirmation" field.
6. Confirm your entries with "OK".
7. Click "OK" to close the dialog.
Alternative operation
Alternatively, the "Properties" dialog can be opened as follows:
Click the "Edit" menu and select the "Info" option or use the corresponding key combination.
Note
A password-protected function can only be opened in the edit window if the correct password
is entered.
To deactivate the password protection, clear the "Password" check box.
See also
How to Set Different Views (Page 887)
Working with the Toolbars (Page 885)
2.12.8 How to Compile and Save a Function
Introduction
In order to use a function, it must first be compiled. Only the function in the active edit window
is compiled.
Errors reported by the compiler are displayed in the lower portion of the window. Each message
is displayed on a separate line. The line includes the line number in the source code where
the error occurred, a hexadecimal encoded error code and a description of the error.
Double-click such a line to select the source code line where the error occurred.
It is recommended that you examine the first message error listed, as subsequent ones could
be errors resulting from the first one. If the first error is corrected, then the others might
disappear after the next compilation.
To make the changes permanent, the function must be saved.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 903
ANSI-C for Creating Functions and Actions
2.12 Creating and Editing Functions
If you save a function that has been compiled with errors, or not at all, the icon is assigned
to this function in the navigation window.
If you save a function that has been compiled without errors, the icon is assigned to this
function in the navigation window.
Requirements
The function to be compiled must be opened in the edit window.
Procedure
1. Use the toolbar to set the language for compilation of the C function.
2. Click on the "Edit" toolbar.
3. Examine the compiler messages in the lower portion of the edit window.
4. If the compiler reported an error, the function code must be corrected. After this has been
done, start again with step 1 in this table.
5. If the compiler generated warnings, the function source code may require correction. After
the code has been corrected, start again with step 1 in this table, otherwise proceed to step
6.
6. Click on the "Default" toolbar.
Alternative operation
Alternatively, the compilation process can be initiated in the following ways:
Select "Compile" from the "Edit" menu, select the "Compile" option from the shortcut menu of
the edit window or use the corresponding key combination.
Saving may also be performed in the following ways:
WinCC: Scripting (VBS, ANSI-C, VBA)
904 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.12 Creating and Editing Functions
Select "Save" from the "File" menu or use the corresponding key combination.
Note
The compiler does not output an error message if tag names are used several times in a C
function. This is also the case if a tag name is used both as transfer parameter and as local
tag definition.
For example, the following faulty script does not trigger an error message in the compiler:
void neue_Funktion(DWORD dwMyVar)
{
DWORD dwMyVar = 0;
}
Message in the output window of the compiler:
Compiling ...
0 Error(s), 0 Warning(s)
See also
Runtime Behavior of Actions (Page 927)
2.12.9 How to Rename a Function
Introduction
It is recommended that you rename the function, when it is created.
The name of the function in the edit window is then changed accordingly. Since this also
changes the code, the function must be recompiled. The old function name, displayed in the
navigation window, is assigned prefix "*" (asterisk).
Afterwards, the modified function must be saved at which time you can change the path and
file name. The old function should then be deleted to avoid accumulating a collection of
obsolete functions.
Note
Please note that only certain characters may be used in function names: characters (with the
exception of national special characters), numbers and the underscore.
Procedure
1. Change the function name in the edit window.
2. Click the button in the editing toolbar. The function is compiled.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 905
ANSI-C for Creating Functions and Actions
2.12 Creating and Editing Functions
3. Click the button in the standard toolbar to save the function.
4. If desired, enter a different path and/or file name.
5. Confirm your entry by clicking "Save".
Alternative operation
Alternatively, the compilation process can be initiated in the following ways:
Select "Compile" from the "Edit" menu, select the "Compile" option from the shortcut menu of
the edit window or use the corresponding keyboard shortcut.
Saving may also be performed in the following ways:
Select "Save" from the "File" menu or use the corresponding key combination.
2.12.10 How to Use Functions from Other Sources
Introduction
Project functions from other WinCC projects and standard functions from other WinCC systems
can also be made useable for the current project. To do so they must be brought into the
current project.
Apart from the location in the file system in which they are saved, there is no difference in the
procedure for project or standard functions.
Procedure
1. Copy the functions. Project functions are copied in the "\library" directory for the WinCC
project. Standard functions are copied in the "\aplib\..." directory in the WinCC path. The
content of the navigation window is updated automatically.
2. Click in the "Standard" toolbar. When the header is regenerated, the copied functions
are registered so that you can use them in your current project.
Alternative operation
Alternatively, you can start a generation process as follows:
Open the "Options" menu and select "Regenerate Header" or use the corresponding key
combination.
Note
In the event that WinCC is reinstalled or upgraded, the standard functions that were modified
are deleted or replaced by the unedited standard functions.
If WinCC is in Runtime, the Runtime system is not influenced by the regeneration of the header.
WinCC: Scripting (VBS, ANSI-C, VBA)
906 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
2.13 Creating and Editing Actions
2.13.1 How To Create and Edit Actions
Introduction
There system distinguishes between global and local actions. In a client-server project, global
actions are carried out on all computers in the project, whereas local ones are carried out only
on the computer to which they are assigned.
A global action can, for instance, be used to perform a calculation on all computers in the
project.
An example of use for a local action might be to output a log file on a server.
The process of creating and editing both action types is identical.
Differences between actions and functions
● Actions, in contrast to functions, can have a trigger. This means that a function, by itself,
cannot be executed in Runtime.
● Actions can be exported and imported.
● Authorizations can be assigned to actions. This authoriation refers to the operational
options for the Global Script Runtime troubleshooting window.
● An action has no parameters.
Finding actions
New actions can be created, and existing actions can be accessed through the Global Script
navigation window.
Actions are stored in the file system as follows:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 907
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
Editing and Compiling Actions
An action is edited and compiled in a separate edit window. The edit window displays
messages from the compiler after a compilation run. These might be warnings or error
messages. In each case, a summary of the number of warnings and error messages is output.
Display of Actions
If a syntactically incorrect action is stored, it is displayed in the Global Script navigation window
with the icon shown to the left.
If a syntactically correct action is stored with no trigger, it is displayed in the Global Script
navigation window with the icon shown to the left.
If a syntactically correct action is stored with a trigger, it is displayed in the Global Script
navigation window with the icon shown to the left.
Please note the following when creating actions:
The CrossReference feature of WinCC allows for the creation of cross-references. When
building the cross-reference list, in order that the tags and images be recognized when function
calls are used as part of actions, the coding rules described further below are to be observed.
Renaming actions
Actions are always displayed with their file names in the navigation window. Renaming an
action means renaming the file containing the action code.
System behavior if actions are changed, deleted and saved at Runtime
If a local action is stored at runtime, then all local and global actions of the computer are reset
on the computer to which the local action belongs.
If a global action is stored in Runtime, then all local and global actions for the entire project –
and thus on all computers – are reset.
WinCC: Scripting (VBS, ANSI-C, VBA)
908 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
Such a reset might reinitialize for examples tags and times that are used as triggers for actions,
triggering the action at that stage.
Static tags used in the reset actions are reinitialized.
Possible causes for an action not being performed in Runtime
Failure of an action to be executed in Runtime might have the following causes:
● The action has no trigger
● The action was not compiled
● Global Script Runtime is not enabled in the project start list
Note
Before creating an action, check whether the relevant functionality can also be implemented
on the automation device.
See also
How to Protect an Action Against Unauthorized Access (Page 914)
How to Use Actions From Other Sources (Page 925)
How to Rename an Action (Page 924)
How to Import an Action (Page 924)
How to Export an Action (Page 923)
How to Assign Authorizations (Page 923)
Triggers (Page 916)
How to Compile and Save an Action (Page 915)
How to add action-related information (Page 912)
How to Edit Actions (Page 912)
How to Create a New Action (Page 911)
WinCC Coding Rule (Page 910)
How to Add Global Script Runtime to a Project's Startup List (Page 875)
Characteristics of Global Actions (Page 874)
Characteristics of Local Actions (Page 873)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 909
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
2.13.2 WinCC Coding Rule
Coding Rules for the Use of CrossReference
The CrossReference feature of WinCC allows for the creation of cross-references. To ensure
that the software can recognize the tags and pictures used in function calls made within actions,
the coding rules given here must be observed.
The action's code begins with two sections. In the first section, you must declare all tags used;
in the second section all picture names used.
Do not enter any other instructions in the sections.
Both sections are already present in the form of comments when an action is created:
// WINCC:TAGNAME_SECTION_START
// syntax: #define TagNameInAction "DMTagName"
// next TagID : 1
// WINCC:TAGNAME_SECTION_END
// WINCC:PICNAME_SECTION_START
// syntax: #define PicNameInAction "PictureName"
// next PicID : 1
// WINCC:PICNAME_SECTION_END
The sections are expanded, for example as follows:
// WINCC:TAGNAME_SECTION_START
// syntax: #define TagNameInAction "DMTagName"
// next TagID : 1
#define ApcTagName1 "TagName1"
// WINCC:TAGNAME_SECTION_END
// WINCC:PICNAME_SECTION_START
// syntax: #define PicNameInAction "PictureName"
// next PicID : 1
#define ApcPicName1 "PicName1"
#define ApcPicName2 "PicName2"
#define ApcPicName3 "PicName3"
// WINCC:PICNAME_SECTION_END
WinCC: Scripting (VBS, ANSI-C, VBA)
910 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
Calls to functions to read and write tags and the utilization of picture names must then be
handled using the defined names:
GetTagDWord(ApcTagName1);
OpenPicture(ApcPicName1);
SetPictureName(ApcPicName2,"PictureWindow1",ApcPicName3);
2.13.3 How to Create a New Action
Introduction
In a client-server project, global actions are carried out on all computers in the project, whereas
local ones are carried out only on the computer to which they are assigned.
The procedure is identical for both global and local actions. By specifying, in the navigation
window, the location in which the action is saved, you specify its type (global or local).
Global Script suggests a default name for the new action.
A newly created action already contains the instruction #include "apdefap.h". Therefore, all
functions are registered within the action. The name of the action is found in the third line. The
first three lines cannot be deleted nor modified. This means that every function can be called
from each action without requiring any special measures. Furthermore every action has a
returned value of type "int" and it is already set to a value of 0.
A returned value of an action can be used in conjunction with GSC Runtime for diagnostic
purposes.
The action code begins with a code framework in the form of comments. If this coding
framework is filled out in accordance with the coding rules, the tags and picture names are
recognized by CrossReference.
Procedure
1. In the navigation window, open the shortcut menu for the desired action type.
2. Select "New".
Alternative operation
Alternatively, you can also create a new action by clicking the associated button in the toolbar,
via the "File" menu or by using the corresponding key combination.
See also
GSC Runtime (Page 928)
WinCC Coding Rule (Page 910)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 911
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
2.13.4 How to Edit Actions
Introduction
An action is edited in its own edit window exactly like a function. Only the first three lines cannot
be edited.
The action must have a return value. The returned value is of the type "int" and is preset to 0.
A returned value of an action can be modified and used in conjunction with GSC Runtime for
diagnostic purposes. The returned value's type cannot be changed.
To execute an action in Runtime, the action must have a trigger.
Procedure
1. Double-click the action in the navigation window to open it in an edit window.
2. Edit the action code.
Alternative operation
You can also open an action as follows:
In the navigation window, open the shortcut menu for the desired action and click "Open" or
"File\Open...". You can also click the button in the standard toolbar or use the corresponding
key combination.
Note
A maximum of 32 Kbytes of memory is available for local tags (tags defined within the braces
of the action code).
See also
GSC Runtime (Page 928)
How to Write Function Code (Page 898)
2.13.5 How to add action-related information
Introduction
Additional information can be assigned to every action.
When a new action is created, the creation date is entered in the action-related information
automatically and is unchangeable. The action is also assigned version number 1.0. The
version numbers can be individually assigned when editing an action. When an action is
changed and saved, the current date of change is entered automatically and is unchangeable.
WinCC: Scripting (VBS, ANSI-C, VBA)
912 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
This dialog can be used to assign a password to protect the action against unauthorized read
and write access.
Requirements
The action to which the information relates must be open in an edit window.
Procedure
1. Click the button in the editing toolbar. The "Properties" dialog is opened.
2. Select the required entries.
3. Confirm your entries with "OK".
Alternative operation
Alternatively, the "Properties" dialog can be opened as follows:
Click the "Edit" menu and select the "Info" option or use the corresponding key combination.
See also
How to Protect an Action Against Unauthorized Access (Page 914)
How to Set Different Views (Page 887)
Working with the Toolbars (Page 885)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 913
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
2.13.6 How to Protect an Action Against Unauthorized Access
Introduction
Actions can be protected with a password against unauthorized read and write access. The
password is a part of the action-related information.
Requirements
The action to be compiled must be opened in the edit window.
Procedure
1. Click the button in the editing toolbar. The "Properties" dialog is opened.
2. Select the "Password" check box.
3. Click the "Change" button.
4. Enter the password in the "Password" field.
5. Enter the password again in the "Confirmation" field.
6. Confirm your entries with "OK".
7. Click "OK" to close the dialog.
Alternative operation
Alternatively, the "Properties" dialog can be opened as follows:
Click the "Edit" menu and select the "Info" option or use the corresponding key combination.
Note
A password-protected action can only be opened in the edit window if the correct password is
entered.
To deactivate the password protection, clear the "Password" check box.
WinCC: Scripting (VBS, ANSI-C, VBA)
914 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
See also
How to Set Different Views (Page 887)
Working with the Toolbars (Page 885)
2.13.7 How to Compile and Save an Action
Introduction
In order to use an action, it must first be compiled. Only the action in the active edit window is
compiled.
Errors reported by the compiler are displayed in the lower portion of the window. Each message
is displayed on a separate line. The line includes the line number in the source code where
the error occurred, a hexadecimal encoded error code and a description of the error.
Double-click such a line to view the source code line where the error occurred.
It is recommended that you examine the first message error listed, because subsequent ones
could be errors resulting from the first one. If the first error is corrected, then the others might
disappear after the next compilation.
Requirement
The action to be compiled must be opened in the edit window.
Procedure
1. Set the language for C compilation using the toolbar.
2. Click on the "Edit" toolbar.
3. Examine the compiler messages in the lower portion of the edit window.
4. If the compiler reported an error, the action source code must be corrected. After this has
been done, start again with step 1 in this table.
5. If the compiler generated warnings, the action source code may require correction. After
the code has been corrected, start again with step 1 in this table, otherwise proceed to step
6.
6. Click on the "Default" toolbar.
Alternative operation
Alternatively, the compilation process can be initiated in the following ways:
Select "Compile" from the "Edit" menu, select the "Compile" option from the shortcut menu of
the edit window or use the corresponding keyboard shortcut.
Saving may also be performed in the following ways:
Select "Save" from the "File" menu or use the corresponding key combination.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 915
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
Display of Actions
If a syntactically incorrect action is stored, it is displayed in the Global Script navigation window
with the icon shown to the left.
If a syntactically correct action is stored with no trigger, it is displayed in the Global Script
navigation window with the icon shown to the left.
If a syntactically correct action is stored with a trigger, it is displayed in the Global Script
navigation window with the icon shown to the left.
See also
Runtime Behavior of Actions (Page 927)
2.13.8 Triggers
2.13.8.1 Triggers
Defining and Using Triggers
Triggers are used to execute actions in Runtime. To do this, a trigger is linked to an action,
forming the triggering event for calling the action. Actions without triggers are not executed.
Trigger Types
The following trigger types are available:
Acyclic Triggers
These consist of a specified date and time. The action specified by such a trigger is performed
once at the date and time specified.
Cyclic Triggers
These consist of a specified time interval and starting point. The following types of cyclic
triggers are available:
● Default cycle. The start of the first time interval coincides with the start of Runtime. The
length of the interval is determined by the cycle.
● Hourly. The start of the interval is specified as minutes and seconds. The length of the
interval is an hour.
WinCC: Scripting (VBS, ANSI-C, VBA)
916 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
● Daily. The start of the interval is specified by the time (hours, minutes and seconds). The
length of the interval is a day.
● Weekly. The start of the interval is specified by the day of the week (Monday, Tuesday,
etc.) and the time. The length of the interval is a week.
● Monthly. The start of the interval is specified by the day and time. The length of the interval
is a month.
● Annually. The start of the interval is specified by the day, month and time. The length of
the interval is a year.
Tag Triggers
These consist of the specification of one or more tags. The action associated with such a trigger
is performed each time a change in the value of one of these tags is detected.
How the tag values are queried may be customized for each tag. Either cyclic polling with a
specified period or a reaction as soon as the system detects a change in the tag value may
be selected.
Depending on the choice of query method, it is possible that the tag changes but the system
does not detect this. In this case the action is not performed.
Effect of Triggers on an Action
If the action is associated with only one trigger, then the action is performed as soon as the
triggering event occurs.
However, an action may be associated with multiple triggers, such as a cyclic trigger and a
tag trigger. In this case, the action is performed whenever one of the two triggering events
occurs. If two events occur simultaneously, the action is executed twice in sequence. If two
tag triggers fire at the same time, the action is performed only once.
The processing of an action should be completed before another call of the action occurs, as
there might otherwise be an overflow of the queue.
Tip:If the action is not to be carried out with each event occurrence, then a condition can be
specified for the action that controls its further course dependent on the event. If the action is
not to be executed any more, it can be terminated with a <value> return.
Rules for the Selection of Triggers
Depending on the system, it cannot be guaranteed that an action with a cyclic trigger is carried
out at exactly the specified time. If this is a requirement, then the task (such as a check, etc.)
must be implemented on the automation device.
For processing, tag triggers have priority over cyclic triggers.
● For a cyclic trigger, the action is always performed when the trigger event occurs, e.g. every
20 seconds. ( = action is performed)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 917
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
● The tag trigger only causes the action to be performed if the value of the trigger tag has
changed. This is done to reduce the system load ( = action is performed).
The values of tags contained in the trigger are already known when the action begins. The
GetTag() call can be used to access the value directly. Processing is much faster than for
trigger tags than for those not contained in the trigger whose values must be obtained via
GetTag() requests.
Display of Actions
If a syntactically incorrect action is stored, it is displayed in the Global Script navigation window
with the icon shown to the left.
If a syntactically correct action is stored with no trigger, it is displayed in the Global Script
navigation window with the icon shown to the left.
If a syntactically correct action is stored with a trigger, it is displayed in the Global Script
navigation window with the icon shown to the left.
See also
How to delete a trigger (Page 922)
How to change a trigger (Page 921)
How to Add a New Trigger of the "Tag" Type (Page 920)
How to Add a New Trigger of the "Timer" Type (Page 919)
WinCC: Scripting (VBS, ANSI-C, VBA)
918 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
2.13.8.2 How to Add a New Trigger of the "Timer" Type
Introduction
Triggers are used to execute actions at runtime. To do this, a trigger is linked to an action,
forming the triggering event for calling the action. Actions without triggers are not executed.
"Timer" type triggers can be cyclic or acyclic triggers.
Acyclic triggers consist of a specified date and time. The action specified by such a trigger is
performed once at the date and time specified.
Cyclic triggers consist of a specified time interval and starting point. The following types of
cyclic triggers are available:
● Default cycle. The start of the first time interval coincides with the start of the Runtime
system. The length of the interval is determined by the cycle.
● Hourly. The start of the interval is specified as minute and second. The length of the interval
is an hour.
● Daily. The start of the interval is specified by the time (hour, minute and second). The length
of the interval is a day.
● Weekly. The start of the interval is specified by the day of the week (Monday, Tuesday,
etc.) and the time. The length of the interval is a week.
● Monthly. The start of the interval is specified by the day and time. The length of the interval
is a month.
● Annual. The start of the interval is specified by the day, month and time. The length of the
interval is a year.
Requirement
The action to be linked with a trigger must be open in the active edit window.
Procedure
1. Click in the "Edit" toolbar. The "Properties" dialog is opened.
2. Select the "Trigger" tab.
3. Select the trigger source "Timer" and click the "Add" button.
4. Select "Single" to add an acyclic trigger or select a cycle to add a cyclical trigger.
5. Complete the required details in the dialog.
6. Confirm the entries by clicking "OK".
7. Close the "Properties" dialog by clicking "OK".
Alternative operation
Alternatively, the "Properties" dialog can be opened as follows:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 919
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
In the "Edit" menu, select "Info", select "Info / Trigger" in the shortcut menu of the edit window,
or use the corresponding key combination.
2.13.8.3 How to Add a New Trigger of the "Tag" Type
Add
Triggers are used to execute actions at runtime. To do this, a trigger is linked to an action,
forming the triggering event for calling the action. Actions without triggers are not executed.
Tag triggers consist of one or more specified tags. The action associated with such a trigger
is performed each time a change in the value of one of these tags is detected.
How the tag values are queried may be customized for each tag. Either cyclic polling with a
specified period or a reaction as soon as the system detects a change in the tag value may
be selected.
Depending on the choice of query method, it is possible that the tag changes while the system
fails to detect this. In this case the action is not performed.
Requirement
The action to be linked with a trigger must be open in the active edit window.
Procedure
1. Click in the "Edit" toolbar. The "Properties" dialog is opened.
2. Select the "Trigger" tab.
3. Select the trigger source "Tag" and click the "Add" button. The "Add Tags" dialog is opened.
4. Click the button to open the tag selection dialog, select a tag and confirm your selection
by clicking "OK".
5. In the "Add Trigger" dialog, open the shortcut menu in the "Standard cycle" column and
then select the desired monitoring cycle. Selecting "After Every Change" results continuous
monitoring.
6. Repeat steps 4 and 5, if you want add more tags.
7. Confirm the entries by clicking "OK".
8. Close the "Properties" dialog by clicking "OK".
Alternative operation
Alternatively, the "Properties" dialog can be opened as follows:
In the "Edit" menu, select "Info", select "Info / Trigger" in the shortcut menu of the edit window,
or use the corresponding key combination.
In the "Add Trigger" dialog, you can also enter a tag name directly and insert the tag in the
"Trigger Name" column by clicking "Add". With this approach, the system does however not
check whether the tag exists.
WinCC: Scripting (VBS, ANSI-C, VBA)
920 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
2.13.8.4 How to change a trigger
Introduction
Triggers that have been defined can be changed at any time. They can also be changed in
Runtime.
Requirements
The relevant action must be opened in the edit window.
Procedure
1. Click the button in the editing toolbar. The "Properties" dialog is opened.
2. Select the "Trigger" tab and select the trigger you wish to change.
3. Click the "Change" button to open the "Change Trigger" dialog.
4. Make the desired changes.
5. Confirm the entries by clicking "OK".
6. Close the "Properties" dialog by clicking "OK".
Alternative operation
Alternatively, the "Properties" dialog can be opened as follows:
In the "Edit" menu, select "Info", select "Info / Trigger" in the shortcut menu of the edit window,
or use the corresponding key combination.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 921
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
2.13.8.5 How to delete a trigger
Introduction
Triggers that have been defined can be deleted at any time. They can also be deleted in
Runtime.
If a trigger is deleted in Runtime, it only takes effect after the action is saved.
Requirements
The relevant action must be opened in the edit window.
Procedure
1. Click the button in the editing toolbar. The "Properties" dialog is opened.
2. Select the "Trigger" tab and select the trigger you wish to delete.
3. Delete the selected trigger by clicking "Delete".
4. Close the "Properties" dialog by clicking "OK".
Alternative operation
Alternatively, the "Properties" dialog can be opened as follows:
In the "Edit" menu, select "Info", select "Info / Trigger" in the shortcut menu of the edit window,
or use the corresponding key combination.
WinCC: Scripting (VBS, ANSI-C, VBA)
922 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
2.13.9 How to Assign Authorizations
Introduction
With the Global Script - Runtime diagnostic tool, you can influence the processing of actions
in Runtime. Each action can be assigned an authorization. This authorization only effects the
operation in the Global Script - Runtime window.
Requirement
The relevant action must be opened in the editing window.
Procedure
1. Click in the toolbar.
The "Authorizations" dialog box is opened.
2. Select an authorization.
3. Confirm your selection with "OK".
See also
GSC Runtime (Page 928)
2.13.10 How to Export an Action
Introduction
Use export and import to move actions between projects. The triggers linked to the actions
are retained in the process.
Requirement
The action to be exported must be opened in the edit window.
Procedure
1. Click in the "Edit" toolbar. The "Save As" dialog is opened.
2. Select the path and file name for the action that you wish to export.
3. Close the dialog by clicking "Save".
Alternative operation
Alternatively, you can start the export as follows:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 923
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
In the "Edit" menu, select "Export", select "Export" in the shortcut menu of the edit window, or
use the corresponding key combination.
2.13.11 How to Import an Action
Introduction
Use export and import to move actions between projects. The triggers linked to the actions
are retained in the process.
The action in the active edit window is replaced by the imported action.
Procedure
1. Click in the "Edit" toolbar. The "Open" dialog is opened.
2. Select the path and file name of the action that you wish to import.
3. Close the dialog by clicking the "Open" button.
Alternative operation
Alternatively, you can start the import as follows:
In the "Edit" menu, select "Import", select "Import" in the shortcut menu of the edit window, or
use the corresponding key combination.
2.13.12 How to Rename an Action
Introduction
You may rename an action at any time. The action is thereby assigned a different file name.
Requirements
The action to be renamed may not be open in the edit window.
Procedure
1. Open the shortcut menu of the action to be renamed.
2. Select "Rename".
WinCC: Scripting (VBS, ANSI-C, VBA)
924 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
3. Enter a new name with the file extension ".pas".
4. Confirm the new name by pressing the <ENTER> key.
Alternative operation
Alternatively, click the action name twice to complete the renaming.
Note
If you do not enter the file extension ".pas", the action name remains unchanged.
2.13.13 How to Use Actions From Other Sources
Introduction
You have two options for using actions from other sources in your project:
● Importing exported actions
● Copy the file with the desired action into the corresponding path in your project. The path
for local actions is <computer name>\Pas in the project path. The path for global actions
is "\Pas" in the project path.
To show the copied actions in the navigation window, you must refresh the display. This can
be accomplished by quitting and then restarting Global Script.
To perform the applied actions in Runtime, proceed as follows:
1. Open the action in the Global Script Editor.
2. Start compilation of the action.
3. Save the action.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 925
ANSI-C for Creating Functions and Actions
2.13 Creating and Editing Actions
Note
Actions can include calls to project and standard functions. These can in turn have calls to
project and standard functions etc. Therefore, when importing actions from other sources, you
must make sure that the current project has all necessary functions.
Particular attention is called for whenever the actions were imported from a different computer.
Since standard functions can be customized by the user, it is possible that the standard
functions called in the action have a different functionality on the source computer than the
ones with the same names on the target computer.
See also
How to Import an Action (Page 924)
How to Export an Action (Page 923)
WinCC: Scripting (VBS, ANSI-C, VBA)
926 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.14 Runtime Behavior of Actions
2.14 Runtime Behavior of Actions
2.14.1 Runtime Behavior of Actions
Analysis of Runtime Behavior
WinCC provides a range of tools with which the Runtime behavior of actions can be analyzed.
These are the application windows GSC Runtime and GSC Diagnose plus the application
apdiag.exe.
To use the application windows GSC Runtime and GSC Diagnose, they must be added to a
process picture. This may be a process picture made especially for diagnostic purposes. This
picture is then called in Runtime.
The application windows are used for the following strategies:
● GSC Runtime supplies information about the dynamic behavior of all (Global Script) actions,
supports the individual start and the Start and End Action for each individual action and
provides an entry point into Global Script Editor, while Runtime is active.
● GSC Diagnose outputs the printf instructions (contained in the actions) in the order in which
they are called. This also applies to the printf instructions in functions that are called in
actions. Through a well thought out use of printf instructions, for example to output the
values of tags, it is possible to follow the action's flow and that of the called functions. Even
error conditions, which result in a call to the OnErrorExecute function, are displayed in the
GSC Diagnose window.
Note
When using dynamic C-scripts with access to picture objects, you should note that
execution of the script is not terminated automatically by closing the picture.
This scenario may to the failure of access to an object that is addressed in the script, e.g.
if properties of the type "Text" are read and the values returned are modified or processed
in subsequent string operations.
See also
GSC Diagnose (Page 933)
GSC Runtime (Page 928)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 927
ANSI-C for Creating Functions and Actions
2.14 Runtime Behavior of Actions
2.14.2 GSC Runtime
2.14.2.1 GSC Runtime
GSC Runtime Window
GSC Runtime is a window showing the dynamic behavior of all (Global Script) actions in
Runtime. Additionally, GSC Runtime, enables you to influence the execution of each individual
action and provides an entry point into Global Script Editor, while Runtime is active.
The following information is output:
● Action: Name of the action
● ID: Action ID. It is used internally to the system and for example is output by the function
OnErrorExecute together with a description of the error in the event that an error occurs in
the action. GSC Runtime supplies the name of the action with this ID. The connection
between the ID and action name ceases to be valid when Runtime is terminated or an action
is saved while Runtime is active.
● Status: Current status of the action. For possible statuses, refer to the table below.
● Activation Interval: The time in the form hours:minutes:seconds that has elapsed between
two calls to the action.
● Return Value: Return value of the action.
● Started On: Date and time at which the current action was started.
● Next Start: Date and time at which the action is started again.
● Error Message: Contains the error text in the case of an error.
Statuses of actions
Possible statuses of actions:
● Action was started.
● Action was ended.
● Action was stopped.
● Action is running.
WinCC: Scripting (VBS, ANSI-C, VBA)
928 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.14 Runtime Behavior of Actions
● Error during start of action!
● Error during execution of action!
Error messages
Possible error messages:
● No error occurred.
● The application is already connected to the script control. No additional connection setup
is possible.
● There is no connection to the script control. Possibly no connection setup took place.
● An error occurred during interprocess communication. The cause of the error is unknown.
● Undefined error.
● The parameter assignment is wrong. Some necessary parameters may be missing.
● Script control is not started. Check has whether WinCC has been started.
● Time-out occurred. Check the connection or increase the monitoring time.
● Script control was terminated.
● The service channel could not be installed.
● An unknown job number was used for the EndAct job.
● The action could not be executed without error. The returned results are invalid.
● An error occurred in the server application.
● The maximum number of connections to the script control has been reached.
● The transaction is unknown. An attempt was made to terminate a transaction that was not
logged on previously.
● A pre-compiled header file cannot be generated from a pre-compiled header file.
● There is no access to the action. The module is being used presently.
● The program is invalid.
● The action is invalid.
● The script control could not set up the file.
● The script interpreter does not have enough memory.
● The file format is invalid for the script control.
● The script control could not open the file.
● The program is presently locked by the script control. No further access is possible.
● The action has already been given to the script control for processing.
● In this action, a conflict has occurred with another action.
● The script control could not find the action.
● The script control could not find the function.
● The specified line information is invalid.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 929
ANSI-C for Creating Functions and Actions
2.14 Runtime Behavior of Actions
● The specified symbol is outside the valid range.
● The provided memory is too small for the script interpreter.
● The script interpreter does not recognize the specified type.
● The specified symbol was not found.
● Load project functions.
● A stack overflow has occurred in the script interpreter during execution. Further execution
of the action is being canceled.
● Division by 0 occurred during execution of an action. The action is being canceled.
● Within the action, a reference was made during execution to a symbol that does not exist.
● Within the action, an attempt was made during execution to access an undefined memory
area.
● The script interpreter ran into a breakpoint.
● The script interpreter was advanced in the debugger by one processing step.
● The action contains no interpreter code.
● The action has the wrong data format.
● The return value of the action cannot be represented as a variant.
● There is insufficient memory to execute this operation.
● An error has occurred within the transaction. For more information, see the AP_ACT_KEYs.
● An error occurred while executing the action. For more information, see the AP_ACT_KEYs.
● An error occurred while executing the action. For more information, see the AP_ACT_KEYs.
● There is no update capability for the existing data format. The action cannot be read.
Shortcut Menu for Actions
The following functions are available for every action in the shortcut menu:
● End Action: The corresponding action is not executed again after the current execution is
completed.
● Start Action: The corresponding action is executed again when the next trigger occurs.
● Start: The relevant action is executed once.
● Edit: The relevant action is opened in the Global Script editor for editing. Runtime remains
active. If the edited action is compiled (if necessary) and saved, the changes are
immediately adopted by the Runtime system.
WinCC: Scripting (VBS, ANSI-C, VBA)
930 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.14 Runtime Behavior of Actions
You can determine for each action individually, whether or not the popup menu can be opened
without a password.
To use GSC Runtime, you must first add an application window of the GSC Runtime type in
a process picture. Using the GSC Runtime attributes, you can determine the appearance of
the GSC Runtime window.
Note
Updating the GSC Runtime window increases the load on the system resources. The system
load depends on how many actions are visible in the window. The system load can be lowered
by reducing the height of the window so that fewer lines are visible.
See also
How to Edit Actions (Page 932)
Attributes of GSC Runtime (Page 932)
How to Place GSC Runtime in a Process Picture (Page 931)
How to Assign Authorizations (Page 923)
2.14.2.2 How to Place GSC Runtime in a Process Picture
Introduction
To use GSC Runtime, you must add GSC Runtime to a process picture. This process picture
can be an existing picture or a picture that just serves diagnostic purposes. GSC Runtime
cannot be added to the process picture directly, rather it must be added as an application in
an application window. The application window is itself part of the process picture. The
measures described must be performed in Graphics Designer.
Requirement
Graphics Designer has been started and the process picture is open.
Procedure
1. In the Object palette, select "Smart Object\Application Window".
2. In the drawing area, open the application window.
3. In the "Window Contents" dialog select "Global Script".
4. Confirm the entries by clicking "OK".
5. In the "Template" dialog, select "GSC Runtime".
6. Click "OK" to confirm your selection.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 931
ANSI-C for Creating Functions and Actions
2.14 Runtime Behavior of Actions
See also
Attributes of GSC Runtime (Page 932)
2.14.2.3 Attributes of GSC Runtime
GSC Runtime Window Layout
GSC Runtime has attributes with which you can determine the appearance of the GSC Runtime
window in Runtime. These include the geometry attribute and in particular the following
attributes:
● Display: With this attribute, you can specify whether the window should be visible or hidden.
The attribute can be made dynamic with the name "Visible".
● Sizeable: Use this attribute to specify whether the window size can be changed in Runtime.
● Moveable: Use this attribute to specify whether the window can be moved in Runtime.
● Border: Use this attribute to specify whether the window has a border. If the window has a
border, its height and width can be changed in Runtime.
● Title: Use this attribute to specify whether the window has a title bar.
● Can be Maximized: Use this attribute to specify whether the window's title bar has a button
to maximize the window in Runtime.
● Can be Closed: Use this attribute to specify whether the window's title bar has a button to
close the window in Runtime.
● Foreground: Use this attribute to specify whether the window is always in the foreground.
The attributes are displayed and can be set in Graphics Designer.
2.14.2.4 How to Edit Actions
Introduction
Each of the actions in your project will be displayed on its own line in the GSC Runtime window.
You can open an action in the GSC Runtime window and then edit it using Global Script Editor.
After the edited action is saved, it is used in Runtime.
Procedure
1. Open the shortcut menu for the desired action.
2. Select "Edit".
See also
How To Create and Edit Actions (Page 907)
WinCC: Scripting (VBS, ANSI-C, VBA)
932 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.14 Runtime Behavior of Actions
2.14.3 GSC Diagnose
2.14.3.1 GSC Diagnose
Description of Functions
GSC Diagnose outputs the printf instructions (contained in the actions) in the order in which
they are called in the Diagnose window. This also applies to the printf instructions in functions
that are called in actions. Through a well thought out use of printf instructions, for example to
output the values of tags, it is possible to follow the action's flow and that of the called functions.
Even error conditions, which result in a call to the OnErrorExecute function, are displayed in
the GSC Diagnose window.
Figure 2-1 Diagnose window of GSC Diagnose
To use GSC Diagnose, you must first add an application window of the GSC Diagnose type
in a process picture. Using the GSC Diagnose attributes, you can determine the appearance
of the GSC Diagnose window.
When the picture is changed, the contents in the GSC Diagnose window is deleted.
Note
A printf() may contain maximum 360 characters.
See also
The Toolbar of GSC Diagnose (Page 935)
Attributes of GSC Runtime (Page 932)
How to Place GSC Diagnose in a Process Picture? (Page 934)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 933
ANSI-C for Creating Functions and Actions
2.14 Runtime Behavior of Actions
2.14.3.2 How to Place GSC Diagnose in a Process Picture?
Introduction
To use GSC Diagnose, you must add GSC Diagnose to a process picture. This process picture
can be an existing picture or a picture that just serves diagnostic purposes. GSC Diagnose
cannot be added as an application to the process picture directly, rather it must be added as
an application in an application window. The application window is itself part of the process
picture. The measures described must be performed in Graphics Designer.
Requirement
Graphics Designer has been started and the process picture is open.
Procedure
1. In the Object palette, select "Smart Object\Application Window".
2. In the drawing area, open the application window.
3. In the "Window Contents" dialog select "Global Script".
4. Confirm the entries by clicking "OK".
5. In the "Template" dialog, select "GSC Diagnose".
6. Click "OK" to confirm your selection.
See also
Attributes of GSC Runtime (Page 932)
The Toolbar of GSC Diagnose (Page 935)
2.14.3.3 Attributes of GSC Diagnose
GSC Diagnose Attributes
GSC Diagnose has attributes with which you can determine the appearance of the GSC
Diagnose window in Runtime. These include the geometry attribute and in particular the
following attributes:
● Display: With this attribute, you can specify whether the window should be visible or hidden.
The attribute can be made dynamic with the name "Visible".
● Sizeable: Use this attribute to specify whether the window size can be changed in Runtime.
● Moveable: Use this attribute to specify whether the window can be moved in Runtime.
● Border: Use this attribute to specify whether the window has a border. If the window has a
border, its height and width can be changed in Runtime.
● Title: Use this attribute to specify whether the window has a title bar.
WinCC: Scripting (VBS, ANSI-C, VBA)
934 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.14 Runtime Behavior of Actions
● Can be Maximized: Use this attribute to specify whether the window's title bar has a button
to maximize the window in Runtime.
● Can be Closed: Use this attribute to specify whether the window's title bar has a button to
close the window in Runtime.
● Foreground: Use this attribute to specify whether the window is always in the foreground.
The attributes are displayed and can be set in Graphics Designer.
2.14.3.4 The Toolbar of GSC Diagnose
Toolbar Functions
The toolbar of GSC Diagnose includes buttons for the control the output in the Diagnose
window as well as for saving, printing and opening the contents of the window.
The toolbar contains buttons with the following functions:
Button Function
Deletes the contents of the window.
Stops the updating of the window.
Resumes the updating of the window.
Opens a text file in the window.
Saves the contents of the window in a text file.
DPrints the contents of the window.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 935
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2.15 ANSI-C function descriptions
2.15.1 lpszPictureName
Overview
"lpszPictureName" is the name of the picture.
If you configure an action on a property or a "Mouse-click" event in WinCC, the name of the
picture is provided as "lpszPictureName" in the action. The picture name has the following
structure:
<BASE PICTURE NAME>.<PICTURE WINDOW NAME>:<PICTURE NAME>. ... .<Picture
window name>:<Picture name>.
The "BASE PICTURE NAME" and the "PICTURE NAME" are provided without the file
extension ".PDL".
This enables you to identify the object's picture path. You can also address specific picture
windows, if a process picture is opened more than once for example.
Note
Do not change the text in "lpszPictureName not even using the function "strcat".
2.15.2 Standard functions
2.15.2.1 Standard functions - short description
The system provides standard functions. You can modify these functions to adapt them to your
personal needs. Furthermore, you can create your own standard functions.
The basic system provides you with standard functions. They are divided into the following
function groups:
● Alarm
● Graphics
● Report
● TagLog
● WinCC
● Windows
The "Obsolete functions" directory contains standard functions that were used to control the
control before WinCC V7.
WinCC: Scripting (VBS, ANSI-C, VBA)
936 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
If the corresponding options have been installed, the following additional function groups are
available:
● Options
● Split Screen Manager
● userarc (user archives)
2.15.2.2 Alarm
AcknowledgeMessage
Function
Acknowledges the message with the number that has been sent as a parameter in the message
system.
Syntax
void AcknowledgeMessage(DWORD MsgNr)
Parameters
MsgNo
Message to be acknowledged
Note
Make sure a configured message exists for the transferred message number.
To use the function on a client with its own project, a standard server for alarms has to be
configured on the client.
GCreateMyOperationMsg
Function
The "GCreateMyOperationMsg" standard function makes it possible to trigger your own
operator input message in the message system. The message with the "dwMsgNum" message
number must have already been configured as the operator input message.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 937
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
int GCreateMyOperationMsg( DWORD dwFlags, DWORD dwMsgNum, char*
lpszPictureName, char* lpszObjectName, DWORD dwMyTextID, double doValueOld, double
doValueNew, char* pszComment)
Parameters
dwFlags
The message form can be selected using the "dwFlags" parameter.
Name Value Description
FLAG_COMMENT_PARAMETER 0x00000001 The text is entered as a comment directly into
the message in Runtime, without its own com‐
ment dialog. The pointer to the comment must
not equal "NULL."
FLAG_COMMENT_DIALOG 0x00000003 A comment dialog appears. The comment en‐
tered there is transferred to the message.
FLAG_TEXTID_PARAMETER 0x00000100 The text ID of a text from the TextLibrary is
provided as the accompanying process value
of the message.
dwMsgNum
WinCC message number of a self-created operator input message.
lpszPictureName
Pointer to the picture name of the picture from which the function is called.
lpszObjectName
Pointer to the WinCC tag name to which the old values and new values belong.
The name is forwarded as the instance name of the operator input message and entered in
the accompanying process value "1".
dwMyTextID
Text ID of a text from the TextLibrary.
When the "FLAG_TEXTID_PARAMETER" is set, the text ID is provided as the numeric
accompanying process value "8" of the message and is displayed as a number in process
value block 8. So that the language-dependent text from the TextLibrary is displayed in the
message, you must enter format statement "@8%s@" in the message text block.
doValueOld
Numeric old value of the WinCC tags with the name specified in "lpszObjectName".
"doValueOld" is entered in the accompanying process value "2" of the message.
The function itself has no option of reading a tag value before the action. For this, use the
provided "GetTag..." feature.
WinCC: Scripting (VBS, ANSI-C, VBA)
938 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
doValueNew
Numeric new value of the WinCC tags with the name specified in "lpszObjectName".
"doValueNew" is entered in the accompanying proces value "3" of the message.
The function itself has no option of reading a tag value after the action. For this, use the
provided "GetTag..." feature.
pszComment
Comment text or empty string.
When "FLAG_COMMENT_PARAMETER" is set, the text is entered directly into the message
in Runtime as a comment. The message does not need a separate comment dialog.
Return value
Value Description
0 The function has been completed without any errors.
-101 The message editing could not be started.
-201 An error occurred when calling the "MSRTGetComment()"
feature.
-301 An error occurred when calling the "MSRTCreateMsgInstan‐
ceWithComment()" feature.
Note
Make sure that only operator input messages are used for the "GCreateMyOperationMsg"
function. The use of messages of different message classes is not permitted.
Please note the role of the standard server when using the function with a Client. For more
information see the chapter "Client configuration".
GMsgFunction
Function
This function provides the message data.
It is a global function for single messages. It is called for each message for which the "Triggers
an action" parameter has been set.
Evaluation of the message data is best made in a project function called from GMsgFunction.
Syntax
BOOL GMsgFunction(char* pszMsgData)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 939
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
pszMsgData
Pointer to a string whose data are mapped with scanf to the MSG_RTDATA_STRUCT
structure.
The "MSG_RTDATA_STRUCT" string contains the following data, which are separated from
each other with "#":
1. Telegram time
2. Process values
3. Instance
4. User
5. Computer
6. Current time in format "yyyy.mm.dd, hh:mm:ss.mmm"
Note
The value "Instance" of string "MSG_RTDATA_STRUCT" is only supplied if an instance
message was triggered.
The values "User" and "Computer" of the string "MSG_RTDATA_STRUCT" are only
supplied if a comment was provided during the creation of the message with the same call.
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
Please note that modified standard functions are overwritten by a WinCC installation so that
the changes will be lost.
SysAckNuisanceMsg
Function
Removes a queued message with message number "dwMsgNr", time stamp "lpstMsgTime"
and instance "lpszInstance". The associated operator message "1003111" with additional
comment is triggered in the message system.
This function is available as of WinCC V7.4 SP1.
WinCC: Scripting (VBS, ANSI-C, VBA)
940 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Notes
Note the role of the standard server when using the function with a client. You can find
additional information under "Configurations > Distributed Systems > Client Configuration".
If no time stamp or an incompatible time stamp is specified for the message with "lpstMsgTime",
the message cannot be removed. The operator message is still currently triggered. This shows
the attempt to remove a corresponding message.
Syntax
int SysAckNuisanceMsg (
DWORD dwFlags,
DWORD dwMsgNr,
SYSTEMTIME* lpstMsgTime,
char* lpszPictureName,
char* lpszInstance,
char* lpszComment );
Parameters
dwFlags
You can select how the operator message is implemented with the "dwFlags" parameter:
Name Value Meaning
FLAG_COMMENT_PA‐ 0x000000 The comment text in "lpszComment" is entered as a comment in the operator
RAMETER 01 message in runtime without a separate comment dialog.
The pointer to the comment must not equal "NULL."
FLAG_COMMENT_DIA‐ 0x000000 A comment dialog is displayed.
LOG 03 An existing comment text in "lpszComment" is displayed.
The comment that is entered or edited in the dialog is applied to the operator
message.
dwMsgNr
WinCC message number that is being removed.
lpstMsgTime
Time stamp of the message that is being removed.
lpszPictureName
Pointer to the picture name of the picture, from which the function is called.
The parameter is not currently used.
lpszInstance
Pointer to the instance name of the message.
The instance name is also used for the operator message.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 941
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszComment
Comment text or empty string.
● When "FLAG_COMMENT_PARAMETER" is set, the text is entered directly into the
message as a comment in runtime without having to use the comment dialog.
● When "FLAG_COMMENT_DIALOG" is set, the procedure is initially the same as for
"FLAG_COMMENT_PARAMETER". The comment dialog is called up afterwards. The
existing comment text in "lpszComment" can be edited in the dialog.
Return value
Value Meaning
0 The function has been completed without any errors.
- 101 The message editing could not be started.
- 201 An error occurred when calling the "MSRTGetComment()" function.
- 302 An error occurred when calling the "MSRTCreateMsgInstanceWithComment(.. QUIT_SYSTEM..)" function.
- 401 Waiting step until comment access to operator message is available, when the "MSRTGetComment()" function
is called in a loop.
2.15.2.3 Graphics
Graphics - short description
The Graphics group contains functions for programming the graphic system.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetLinkedVariable
Function
Provides the name of the variable linked to a certain object property.
Syntax
char* GetLinkedVariable(char* lpszPictureName, char* lpszObjectName, char*
lpszPropertyName);
WinCC: Scripting (VBS, ANSI-C, VBA)
942 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Pointer to the picture
lpszObjectName
Pointer to the object
lpszPropertyName
Pointer to the object property
Return value
Pointer to the name of the tag linked to a certain object property.
GetLocalPicture
Function
Provides a pointer to the name of the picture. The picture name is the file name without the
".PDL" extension.
Syntax
char* GetLocalPicture(char* lpszPictureName);
Parameters
lpszPictureName
Pointer to the picture
Return value
Pointer on the name of the picture.
Note
The passed call parameter lpszPictureName must have the structure provided by the graphics
system for the picture paths:
<Basic picture name>.<Picture window name>:<Picture name>. ... .<Picture window
name>[:<Picture name>]
where <Basic picture name> and <Picture name> go without the ".PDL" file extension.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 943
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Example:
In a basic picture "AAA" there is a picture window "bbb" in which a picture "CCC" is called
which itself contains a picture window "ddd" in which a picture "EEE" is called.
Then the function call
GetLocalPicture(lpszPictureName)
returns the pointer to the picture name:
"EEE" if the functions is called in the picture "EEE";
"CCC" if the functions is called in the picture "CCC";
"AAA" if the functions is called in the picture "AAA".
GetParentPicture
Function
Provides a pointer to the name of the picture. The picture name is the file name without the
".PDL" extension.
Syntax
char* GetParentPicture(char* lpszPictureName);
Parameters
lpszPictureName
Pointer to the picture
Return value
Name of the current picture if the function is called in the basic picture
Name path of the higher-level picture if the function is called in a picture window
Note
The passed call parameter lpszPictureName must have the structure provided by the graphics
system for the picture paths:
<Basic picture name>.<Picture window name>:<Picture name>. ... .<Picture window
name>[:<Picture name>]
where <Basic picture name> and <Picture name> go without the ".PDL" file extension.
WinCC: Scripting (VBS, ANSI-C, VBA)
944 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetParentPictureWindow
Function
Provides a pointer to the name of the picture window.
Syntax
char* GetParentPictureWindow(char* lpszPictureName);
Parameters
lpszPictureName
Pointer to the picture
Return value
Pointer to the name of the picture window if the function is called in a picture displayed in a
picture window of a higher-level picture
Call parameter lpszPictureName unchanged if the function is called in the basic picture
Note
The passed call parameter lpszPictureName must have the structure provided by the graphics
system for the picture paths:
<Basic picture name>.<Picture window name>:<Picture name>. ... .<Picture window
name>[:<Picture name>]
where <Basic picture name> and <Picture name> go without the ".PDL" file extension.
Example:
In a basic picture "Picture_1" there is a picture window "Picture_window_1" in which a picture
"Picture_2" is called.
In the picture "Picture_2" there is a picture window "Picture_window_2" in which a picture
"Picture_3" is called.
Then the function call
GetParentPictureWindow(lpszPictureName)
returns the pointer to the picture window name:
"Picture_2" if the function is called in the picture "Picture_3";
"Picture_window_1" if the function is called in the picture "Picture_2";
"Picture_1" if the function is called in the picture "Picture_1".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 945
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
OpenPicture
Function
Changes the specified basic picture. On the client and in case of a picture name with server
prefix a picture change is performed in the picture window.
If, for example, the picture window is located in a different picture window with a server prefix,
a picture change is not performed in the picture window in which the function was called.
If multiple picture windows with server prefix are integrated in the picture and the
"OpenPicture()" function calls the last picture, the picture change is carried out in the first
picture window. For example,
"screen1.window1(screen2.window2(screen3.window3(screen4.OpenPicture)))" executes a
picture change in "window1".
WinCC Alarm Control: WinCC server or WinCC client with its own project
If you have selected a server package in the WinCC AlarmControl, the picture change takes
place in the picture window of the WinCC Alarm Control when called with "Loop in Alarm".
Picture names in different languages
If you are going to use multiple pictures with names from different code pages, it is
recommended that you use the respective picture names in different "Open Picture" functions.
You must compile the associated "Open Picture" function with the correct language and
configure it for the message.
Syntax
void OpenPicture(Picture PictureName)
Parameters
Picture name
Picture name
Registry2
Function
This function manages a list of string pairs (String0, String1).
It knows the following types of calls controlled by the mode parameter:
● Registry2("set", "String0", "String1");
Includes the passed string pair into the list.
● Registry2("get", "String0", NULL);
WinCC: Scripting (VBS, ANSI-C, VBA)
946 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Returns the first string pair partner String1 which belongs to the passed String0 and then
deletes the string pair from the list.
● Registry2("reset", NULL, NULL);
Deletes all string pairs from the list.
● Registry2("display", NULL, NULL);
Shows the string pairs currently stored in the list in a Global Script diagnostics window.
Syntax
char* Registry2(char* mode, char* String0, char* String1);
Parameters
mode
Defines the working principle of the function.
set Incorporation of the string pair into the list
get Determination of the first sting pair partner for String0 and deletion of the string
pair from the list
reset Deletion of all string pairs
display Display of the string pairs in a Global Script diagnostics window
String0
The parameter supply depends on the working principle of the function.
String1
The parameter supply depends on the working principle of the function.
Return value
In the mode=get mode a pointer to the first string pair partner is returned.
Note
This function is used in conjunction with the picture module technology.
If you work with the "Create faceplate as type" and "Create instance(s) in the process picture"
wizards in the "Faceplates" tab of the Dynamic Wizard, using the "Registry2" function is not
permitted!
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 947
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2.15.2.4 Obsolete functions
Alarm
AXC_OnBtnAlarmHidingList
Function
This function displays the list of hidden messages in a message window.
Syntax
BOOL AXC_OnBtnAlarmHidingList(char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnArcLong
Function
This function displays the messages stored in a long-term archive list in a message window.
WinCC: Scripting (VBS, ANSI-C, VBA)
948 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL AXC_OnBtnArcLong (char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnArcShort
Function
This function displays the messages stored in a short-term archive list in a message window.
Syntax
BOOL AXC_OnBtnArcShort(char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 949
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnComment
Function
External message window operation
This function displays the comment of the previously selected messages.
Syntax
BOOL AXC_OnBtnComment (char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
950 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
AXC_OnBtnEmergAckn
Function
External message window operation
This function opens the acknowledgement dialog (emergency acknowledgement/reset).
Syntax
BOOL AXC_OnBtnEmergAckn(char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnHideDlg
Function
This function opens the display options dialog for defining the messages that are to be
displayed in the message window. The options are "All messages", "Shown messages" or
"Hidden messages".
Syntax
BOOL AXC_OnBtnHideDlg(char* lpszPictureName, char* lpszObjectName)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 951
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnHideUnhideMsg
Function
The function hides the selected message or displays again the hidden message.
Syntax
BOOL AXC_OnBtnHideUnhideMsg(char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
952 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnHit
Function
This function displays the messages stored in the hit list in a message window.
Syntax
BOOL AXC_OnBtnHit (char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 953
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
AXC_OnBtnHornAckn
Function
External message window operation
This function acknowledges the horn signal.
Syntax
BOOL AXC_OnBtnHornAckn (char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnInfo
Function
External message window operation
This function displays the information text.
Syntax
BOOL AXC_OnBtnInfo (char* lpszPictureName, char* lpszObjectName)
WinCC: Scripting (VBS, ANSI-C, VBA)
954 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnLock
Function
External message window operation
This function opens the "Set the Lock List Parameters" dialog.
Syntax
BOOL AXC_OnBtnLock (char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 955
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnLockUnlock
Function
This function locks the selected message in the message window. This message will then no
longer be archived.
This function unlocks the selected message in the lock list.
Syntax
BOOL AXC_OnBtnLockUnlock (char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
956 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
AXC_OnBtnLockWin
Function
External message window operation.
This function calls the lock list.
Syntax
BOOL AXC_OnBtnLockWin (char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnLoop
Function
External message window operation
This function triggers the "LoopInAlarm" function of the selected message.
Syntax
BOOL AXC_OnBtnLoop (char* lpszPictureName, char* lpszObjectName)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 957
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnMsgFirst
Function
External message window operation
This function switches to the beginning of the message list.
Syntax
BOOL AXC_OnBtnMsgFirst (char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
958 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnMsgLast
Function
External message window operation
This function switches to the beginning of the message list.
Syntax
BOOL AXC_OnBtnMsgLast (char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 959
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
AXC_OnBtnMsgNext
Function
External message window operation
This function switches to the next message in the message list.
Syntax
BOOL AXC_OnBtnMsgNext (char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnMsgPrev
Function
External message window operation
This function switches to the previous message in the message list.
Syntax
BOOL AXC_OnBtnMsgPrev (char* lpszPictureName, char* lpszObjectName)
WinCC: Scripting (VBS, ANSI-C, VBA)
960 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnMsgWin
Function
External message window operation
This function calls the message list.
Note
The message list contains the currently pending and unacknowledged messages.
Syntax
BOOL AXC_OnBtnMsgWin (char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 961
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnPrint
Function
External message window operation
All messages fulfilling the selection criterion set in the Alarm Control are output to the printer.
Syntax
BOOL AXC_OnBtnPrint(char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
962 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
AXC_OnBtnProtocol
Function
External message window operation
Printing of the current view of the Alarm Control is started. All messages fulfilling the selection
criterion set in the Alarm Control are output to the printer.
Syntax
BOOL AXC_OnBtnProtocol(char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnScroll
Function
External message window operation
This function activates or deactivates the horizontal and vertical scroll functions.
Syntax
BOOL AXC_OnBtnScroll(char* lpszPictureName, char* lpszObjectName)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 963
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnSelect
Function
External message window operation
This function opens the "Specify Selection" dialog for the displayed list.
Syntax
BOOL AXC_OnBtnSelect(char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
964 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnSinglAckn
Function
External message window operation
This function acknowledges the currently selected message.
Syntax
BOOL AXC_OnBtnSinglAckn(char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 965
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
AXC_OnBtnSortDlg
Function
External operation of the message window
This function opens the dialog for setting a user-defined sorting of the displayed messages for
the displayed list.
Syntax
BOOL AXC_OnBtnSortDlg(char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnTimeBase
Function
External operation of the message window
This function opens the dialog for setting the time base for the times shown in the messages.
Syntax
BOOL AXC_OnBtnTimeBase(char* lpszPictureName, char* lpszObjectName)
WinCC: Scripting (VBS, ANSI-C, VBA)
966 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_OnBtnVisibleAckn
Function
External message window operation
All visible messages in the message window are acknowledged (group acknowledgement).
Syntax
BOOL AXC_OnBtnVisibleAckn(char* lpszPictureName, char* lpszObjectName)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the object name of the WinCC Alarm Control
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 967
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
AXC_SetFilter
Function
External message window operation
This function sets a filter for WinCC Alarm Control to show a portion of the existing messages
according to the filter criterion.
Syntax
BOOL AXC_SetFilter(char* lpszPictureName, char* lpszObjectName,
LPMSG_FILTER_STRUCT lpMsgFilter, LPCMN_ERROR, lpError)
Parameters
lpszPictureName
Pointer to the name of the picture in which the WinCC Alarm Control is located
lpszObjectName
Pointer to the WinCC Alarm Control name
lpMsgFilter
Pointer to the structure containing the filter criterion
lpError
Pointer to the structure of the error description
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
968 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC AlarmControl as of WinCC
V7.0.
Report
ReportJob
Function
Depending on the value of the lpMethod Name parameter a print job or the preview for a print
job is started.
Syntax
void ReportJob(LPSTR lpJobName, LPSTR lpMethodName)
Parameters
lpJobName
Pointer to the name of the print job
lpMethodName
PRINTJOB Print job is started
PREVIEW Preview of the print job is started
Note
This function is replaced by the RPTJobPreview and RPTJobPrint functions and should no
longer be used.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 969
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
TagLog
TOOLBAR_BUTTONS
TlgTableWindowPressEditRecordButton
Function
The editing of the table window is blocked or enabled (toggle function).
If editing is enabled, updating of the table window is stopped at the same time.
The updating of the table window remains to be stopped afterward, even if editing is blocked
by a further function call.
Syntax
BOOL TlgTableWindowPressEditRecordButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Table Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgTableWindowPressFirstButton
Function
Displays the first data records of the display area in the table window.
The number of displayed data records depends on the configured time range.
WinCC: Scripting (VBS, ANSI-C, VBA)
970 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL TlgTableWindowPressFirstButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Table Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgTableWindowPressHelpButton
Function
Displays the online help for the table window.
Syntax
BOOL TlgTableWindowPressHelpButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Table Control
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 971
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgTableWindowPressInsertRecordButton
Syntax
BOOL TlgTableWindowPressInsertRecordButton(char* lpszWindowName)
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgTableWindowPressLastButton
Function
Displays the last data records of the display area in the table window.
The number of displayed data records depends on the configured time range.
Syntax
BOOL TlgTableWindowPressLastButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Table Control
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
972 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgTableWindowPressNextButton
Function
The data records following the current display area are displayed in the table window.
The number of displayed data records depends on the configured time range.
Syntax
BOOL TlgTableWindowPressNextButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Table Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 973
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
TlgTableWindowPressNextItemButton
Function
The columns of the table window are moved one column to the left, the left column taking the
position of the right column.
Syntax
BOOL TlgTableWindowPressNextItemButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Table Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgTableWindowPressOpenArchiveVariableSelectionDlgButton
Function
Opens the dialog for connecting table columns to archives and tags.
Syntax
BOOL TlgTableWindowPressOpenArchiveVariableSelectionDlgButton(char*
lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Table Control
WinCC: Scripting (VBS, ANSI-C, VBA)
974 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgTableWindowPressOpenDlgButton
Function
Opens the dialog for online configuration of the table window.
Syntax
BOOL TlgTableWindowPressOpenDlgButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Table Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 975
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
TlgTableWindowPressOpenItemSelectDlgButton
Function
Opens the dialog for selecting the visible columns and the first column of the table window.
Syntax
BOOL TlgTableWindowPressOpenItemSelectDlgButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Table Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgTableWindowPressOpenTimeSelectDlgButton
Function
Opens the dialog for setting the time range to be displayed in the table columns.
Syntax
BOOL TlgTableWindowPressOpenTimeSelectDlgButton(char* lpszWindowNumber)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Table Control
WinCC: Scripting (VBS, ANSI-C, VBA)
976 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgTableWindowPressPrevButton
Function
The data records preceding the current display area are displayed in the table window.
The number of displayed data records depends on the configured time range.
Syntax
BOOL TlgTableWindowPressPrevButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Table Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 977
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
TlgTableWindowPressPrevItemButton
Function
The columns of the table window are moved one column to the right, the right column taking
the position of the left column.
Syntax
BOOL TlgTableWindowPressPrevItemButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Table Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgTableWindowPressRemoveRecordButton
Syntax
BOOL TlgTableWindowPressRemoveRecordButton(char* lpszWindowName)
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
978 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
TlgTableWindowPressStartStopButton
Function
Updating of the table window is switched on or off (toggle function).
Syntax
BOOL TlgTableWindowPressStartStopButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Table Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgTrendWindowPressFirstButton
Function
Displays the first data records of the display area in the trend window.
The number of displayed data records depends on the configured time range.
Syntax
BOOL TlgTrendWindowPressFirstButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 979
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressHelpButton
Function
Displays the online help for the trend window.
Syntax
BOOL TlgTableWindowPressNextButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
980 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
TlgTrendWindowPressLastButton
Function
Displays the last data records of the display area in the trend window.
The number of displayed data records depends on the configured time range.
Syntax
BOOL TlgTrendWindowPressLastButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressLinealButton
Function
The ruler of the trend window is shown or hidden (toggle function).
The ruler can be moved by means of the "cursor left" and "cursor right" buttons.
Syntax
BOOL TlgTableWindowPressNextButton(char* lpszWindowName)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 981
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressNextButton
Function
The data records following the current display area are displayed in the trend window.
The number of displayed data records depends on the configured time range.
Syntax
BOOL TlgTrendWindowPressNextButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
982 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressNextItemButton
Function
Brings all trends in the trend window one layer to the front.
The trend in the foreground is moved into the background.
Syntax
BOOL TlgTrendWindowPressNextItemButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressOneToOneButton
Function
Restores the standard size (1:1) in the trend window.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 983
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL TlgTrendWindowPressOneToOneButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressOpenArchiveVariableSelectionDlgButton
Function
Opens the dialog for connecting trends to archives and tags.
Syntax
BOOL TlgTrendWindowPressOpenArchiveVariableSelectionDlgButton(char*
lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
984 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressOpenDlgButton
Function
Opens the dialog for online configuration of the trend window.
Syntax
BOOL TlgTrendWindowPressOpenDlgButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressOpenItemSelectDlgButton
Function
Opens the dialog for selecting the visible trends and the trend which is to be in the foreground.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 985
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL TlgTrendWindowPressOpenItemSelectDlgButton(char* lpszWindowNumber)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressOpenTimeSelectDlgButton
Function
Opens the dialog for setting the time range to be displayed.
Syntax
BOOL TlgTrendWindowPressOpenTimeSelectDlgButton(char* lpszWindowNumber)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
986 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressPrevButton
Function
The data records preceding the current display area are displayed in the trend window.
The number of displayed data records depends on the configured time range.
Syntax
BOOL TlgTrendWindowPressPrevButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressPrevItemButton
Function
Brings all trends in the trend window one layer to the back.
The trend in the background is moved to the foreground.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 987
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL TlgTrendWindowPressPrevItemButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressPrintButton
Function
The current view of the trends is output in accordance with the display configured for the WinCC
Trend Control.
Syntax
BOOL TlgTrendWindowPressPrintButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
988 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressReportSaveButton
Function
The displayed trend window data is saved in a text file.
Syntax
BOOL TlgTrendWindowPressReportSaveButton (char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressStartStopButton
Function
Updating of the trend window is switched on or off (toggle function).
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 989
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL TlgTrendWindowPressStartStopButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressStatsResultButton
Function
Starts the evaluation of data in the selected time area.
The statistic values minimum, maximum, average and standard deviation are calculated.
Syntax
BOOL TlgTrendWindowPressStatsResultButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
990 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressStatsSelectRangeButton
Function
To select the time range for the statistics function, the rulers for start and end time are displayed.
Syntax
BOOL TlgTrendWindowPressStatsSelectRangeButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressZoomInButton
Function
The zoom in the trend window is activated. The zoom range can only be selected with the
mouse.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 991
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL TlgTrendWindowPressZoomInButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgTrendWindowPressZoomOutButton
Function
The trend window is restored to the state in which it was before the zoom was activated. The
zoom is deactivated.
The zoom range can only be selected with the mouse (also see
TlgTrendWindowPressZoomInButton).
Syntax
BOOL TlgTrendWindowPressZoomOutButton(char* lpszWindowName)
Parameter
lpszWindowName
Pointer to the window title of the WinCC Online Trend Control
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
992 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
Template
TlgGetNumberOfColumns
Function
Provides the number of columns in the table window.
The window title of the corresponding WinCC Online Table Control is passed with the
lpszTemplate parameter.
Syntax
int TlgGetNumberOfColumns(char* lpszTemplate)
Parameter
lpszTemplate
Pointer to the window title of the WinCC Online Table Control
Return value
Number of colums in a table window
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgGetNumberOfRows
Function
Provides the number of lines in the table window.
The window title of the corresponding WinCC Online Table Control is passed with the
lpszTemplate parameter.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 993
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
int TlgGetNumberOfRows(char* lpszTemplate)
Parameter
lpszTemplate
Pointer to the window title of the WinCC Online Table Control
Return value
Number of lines in the table window
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgGetNumberOfTrends
Function
Provides the number of trends in the trend window.
The window title of the corresponding WinCC Online Trend Control is passed with the
lpszTemplate parameter.
Syntax
int TlgGetNumberOfTrends(char* lpszTemplate)
Parameter
lpszTemplate
Pointer to the window title of the WinCC Online Trend Control
Return value
Number of trends in the trend window
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
994 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
TlgGetRowPosition
Function
Provides the current position of the line pointer in the table window.
The window title of the corresponding WinCC Online Table Control is passed with the
lpszTemplate parameter.
Syntax
int TlgGetRowPosition(char* lpszTemplate)
Parameter
lpszTemplate
Pointer to the window title of the WinCC Online Table Control
Return value
Current position of the line pointer in the table window
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgGetRulerArchivNameTrend
Function
Provides the archive name of the trend with the nTrend number in the trend window at the
ruler position.
The window title of the corresponding WinCC Online Trend Control is passed with the
lpszTemplate parameter.
Syntax
char* TlgGetRulerArchivNameTrend(char* lpszTemplate, int nTrend)
Parameter
lpszTemplate
Pointer to the window title of the WinCC Online Trend Control
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 995
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
nTrend
Number of the trend
(0 <= nTrend <= Number of visible trends - 1)
Return value
Archive name of the trend with the nTrend number in the trend window at the ruler position
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgGetRulerTimeTrend
Function
Provides the time of the trend with the nTrend number in the trend window at the ruler position.
The window title of the corresponding WinCC Online Trend Control is passed with the
lpszTemplate parameter.
Syntax
SYSTEMTIME TlgGetRulerTimeTrend(char* lpszTemplate, int nTrend)
Parameter
lpszTemplate
Pointer to the window title of the WinCC Online Trend Control
nTrend
Number of the trend
(0 <= nTrend <= Number of visible trends - 1)
Return value
Time of the trend with the nTrend number in the trend window at the ruler position
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
WinCC: Scripting (VBS, ANSI-C, VBA)
996 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
TlgGetRulerTimeTrend example (Page 1592)
TlgGetRulerValueTrend
Function
Provides the value of the trend with the nTrend number in the trend window at the ruler position.
The window title of the corresponding WinCC Online Trend Control is passed with the
lpszTemplate parameter.
Syntax
double TlgGetRulerValueTrend(char* lpszTemplate, int nTrend)
Parameter
lpszTemplate
Pointer to the window title of the WinCC Online Trend Control
nTrend
Number of the trend
(0 <= nTrend <= Number of visible trends - 1)
Return value
Value of the trend with the nTrend number in the trend window at the ruler position
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgGetRulerVariableNameTrend
Function
Provides the tag name of the trend with the nTrend number in the trend window.
The window title of the corresponding WinCC Online Trend Control is passed with the
lpszTemplate parameter.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 997
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
char* TlgGetRulerVariableNameTrend(char* lpszTemplate, int nTrend)
Parameter
lpszTemplate
Pointer to the window title of the WinCC Online Trend Control
nTrend
Number of the trend
(0 <= nTrend <= Number of visible trends - 1)
Return value
The tag name of the trend with the nTrend number in the trend window.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
TlgGetTextAtPos
Function
Provides the content of a cell of the table window as text for process value archives and user
archives.
The cell is specified by nColumn and nLine.
The window title of the corresponding WinCC Online Table Control is passed with the
lpszTemplate parameter.
Syntax
char* TlgGetTextAtPos(char* lpszTemplate, int nColumn, int nLine)
Parameter
lpszTemplate
Pointer to the window title of the WinCC Online Table Control
nColumn
Number of the column
WinCC: Scripting (VBS, ANSI-C, VBA)
998 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
nLine
Number of the line
Return value
Content of the cell of a table window as text
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgGetColumnPosition
Function
Provides the current position of the column pointer in the table window as column index.
Syntax
int TlgGetColumnPosition(char* lpszTemplate)
Parameter
lpszTemplate
Pointer to the window title of the WinCC Online Table Control
Return value
Current position of the column pointer in a table window
Note
The standard function is no longer supported for the new WinCC OnlineTableControl as of
WinCC V7.0.
TlgTrendWindowActivateCurve
Function
Activates a certain trend in WinCC Online Trend Control via the configured name of the trend.
This function is executed independently of the visibility or foreground position of the trend.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 999
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL TlgTrendWindowActivateCurve(char* lpszPictureName, char* lpszObjectName, char*
szValue)
Parameter
lpszPictureName
Picture name
lpszObjectName
Name of Trend Control
szValue
Name of the curve
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The standard function is no longer supported for the new WinCC OnlineTrendControl as of
WinCC V7.0.
2.15.2.5 Report
Report - short description
The Report group contains functions with which to start the print preview of a print job or the
printout itself.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
WinCC: Scripting (VBS, ANSI-C, VBA)
1000 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
RPTJobPreview
Function
The preview of a print job is started.
Syntax
BOOL RPTJobPreview(LPSTR lpJobName)
Parameters
lpJobName
Pointer to the name of the print job
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
RPTJobPrint
Function
A print job is started.
Syntax
BOOL RPTJobPrint(LPSTR lpJobName)
Parameters
lpJobName
Pointer to the name of the print job
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1001
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
RptShowError
Function
This function provides an error decription for a failed print job.
The function is already integrated into the RptJobPrint and RptJobPreview standard functions
and does not have to be called separately.
The error description is displayed in a Global Script diagnostics window.
Note
As RptShowError is a standard function the output type and form can be changed if required.
Please note that modified standard functions are overwritten by a WinCC installation so that
the changes will be lost.
Syntax
void RptShowError ( LPCSTR pszFailedFunction, CMN_ERRORA* pCmnErrorA )
Parameters
pszFailedFunction
Pointer to the name of the failed function.
If this pointer is NULL there will be no output of the function name.
pCmnErrorA
Pointer to the error structure of the failed function.
If this pointer is NULL there will be no output of the error structure.
STRUCTURES_TABLES_ERROR_STRUCTURE
WinCC: Scripting (VBS, ANSI-C, VBA)
1002 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2.15.2.6 WinCC
WinCC - short description
The WinCC group contains functions which affect the entire WinCC system.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetHWDiag
Function
This function realizes the direct start of diagnosis at runtime triggered by an event, which must
be configured, exercised on an object.
If the event occurs, the hardware diagnostics function is started from STEP7 for the associated
PLC.
The following conditions must be fulfilled in order to use the function:
● The WinCC project, with the picture from which access should occur, and the STEP7 project
must be on the same computer.
● The WinCC project must be stored as a subdirectory of the STEP7 project (STEP7 Projekt
\wincproj\WinCC Projekt).
● The S7 tags have been mapped to WinCC.
Syntax
BOOL GetHWDiag(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpProperties)
Parameters
lpszPictureName
Name of the picture (PDL file) that contains the tag that will be used for the entry point for the
hardware diagnostics
Since the name "lpszPictureName" stands for the current picture, entries are only required
here in cases where it is necessary to access an object tag in a different picture.
lpszObjectName
Name of the object in the picture that connected with the tag that will be used for the entry
point for the hardware diagnostics
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1003
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Since the name "lpszObjectName" stands for the current object entries are only required here
in cases where it is necessary to access a tag in a different object.
lpProperties
Name of the attribute that is connected with the tag that will be used for the entry point for the
hardware diagnostics
If multiple attribute are entered, they must be separated by semicolons (";").
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
GetHWDiagLevel
Function
Checks the logged-in user's authorization on the basis of the User Administrator function
number in dwLevel.
Then, diagnostics is started directly during runtime and is triggered by an event, which has to
be configured, occurring on an object.
If the event occurs, the hardware diagnostics function is started from STEP7 for the associated
PLC.
The following conditions must be fulfilled in order to use the function:
● The WinCC project, with the picture from which access should occur, and the STEP7 project
must be on the same computer.
● The WinCC project must be stored as a subdirectory of the STEP7 project (STEP7 Projekt
\wincproj\WinCC Projekt).
● The S7 tags have been mapped to WinCC.
● In order for the user logged into WinCC to edit the hardware diagnostics dialog, the user
must have a WinCC user authorization matching the number passed by the function call in
the parameter "dwLevel".
Syntax
BOOL GetHWDiagLevel(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpProperties, DWORD dwLevel)
WinCC: Scripting (VBS, ANSI-C, VBA)
1004 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Name of the picture (PDL file) that contains the tag that will be used for the entry point for the
hardware diagnostics
Since the name "lpszPictureName" stands for the current picture, entries are only required
here in cases where it is necessary to access an object tag in a different picture.
lpszObjectName
Name of the object in the picture that connected with the tag that will be used for the entry
point for the hardware diagnostics
Since the name "lpszObjectName" stands for the current object entries are only required here
in cases where it is necessary to access a tag in a different object.
lpProperties
Name of the attribute that is connected with the tag that will be used for the entry point for the
hardware diagnostics
If multiple attribute are entered, they must be separated by semicolons (";").
dwLevel
Level number for STEP7 write permissions.
This can be defined in User Administrator.
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
GetKopFupAwl
Function
This function performs the network entry jump of WinCC into the STEP7 Editor "KFA".
When executing this function two tasks are performed:
● Determination of the required date for the network entry jump from WinCC.
● Transfer of the data to Step7 and finding the places of use of the operand in a STEP7
program by means of AUTAPI.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1005
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL GetKopFupAwl(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpProperties)
Parameters
lpszPictureName
Name of the picture (PDL file) that contains the tag that will be used for the network entry jump
Since the name "lpszPictureName" stands for the current picture, entries are only required
here in cases where it is necessary to access an object tag in a different picture.
lpszObjectName
Name of the object in the picture that connected with the tag that will be used for the network
entry jump
Since the name "lpszObjectName" stands for the current object entries are only required here
in cases where it is necessary to access a tag in a different object.
lpProperties
Name of the attrribute that is connected with the tag that will be used for the network entry
jump
If multiple attribute are entered, they must be separated by semicolons (";").
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
GetKopFupAwlLevel
Function
Checks the active user's authorization on the basis of the User Administrator function number
in dwLevel and then performs the entry jump into the STEP7 Editor "KFA".
WinCC: Scripting (VBS, ANSI-C, VBA)
1006 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
When executing this function three tasks are performed:
● Determination of the required date for the network entry jump from WinCC.
● Authorization check for the active user within WinCC.
● Transfer of the data to STEP7 and finding the places of use of the operand in a STEP7
program by means of AUTAPI.
Note
Depending on the result of the authorization check in WinCC the user has either only
reading rights in STEP7 or is authorized to change S7 data.
Syntax
BOOL GetKopFupAwlLevel(LPCTSTR lpszPictureName, LPCTSTR
lpszObjectName,LPCTSTR lpProperties, DWORD dwLevel)
Parameters
lpszPictureName
Name of the picture (PDL file) that contains the tag that will be used for the network entry jump
Since the name "lpszPictureName" stands for the current picture, entries are only required
here in cases where it is necessary to access an object tag in a different picture.
lpszObjectName
Name of the object in the picture that connected with the tag that will be used for the network
entry jump
Since the name "lpszObjectName" stands for the current object entries are only required here
in cases where it is necessary to access a tag in a different object.
lpProperties
Name of the attrribute that is connected with the tag that will be used for the network entry
jump
If multiple attribute are entered, they must be separated by semicolons (";").
dwLevel
Level number for STEP7 write permissions.
This can be defined in User Administrator.
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1007
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
OnDeactivateExecute
Function
This function is called when terminating WinCC Runtime.
As this is a standard function, you can insert instructions which are then executed.
Note
Concerning the instructions it must be taken into account that the Runtime is terminating and
therefore not all functionalities are available.
Please note that modified standard functions are overwritten by a WinCC installation so that
the changes will be lost.
Syntax
void OnDeactivateExecute()
OnErrorExecute
Function
OnErrorExecute is called by the system when an error occurred upon executing an action or
a function.
This allows you to determine the precise error cause.
The function is called by the system and does not require an additional call.
As this function is available as a standard function the output type and form can be changed
if required.
Note
Please note that modified standard functions are overwritten by a new installation so that the
changes will be lost.
Syntax
void OnErrorExecute(CCAPErrorExecute ErrorExecute)
WinCC: Scripting (VBS, ANSI-C, VBA)
1008 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
ErrorExecute
Structure informing about the error that has occurred
Diagnostic information
These information are displayed in a Global Script diagnostics window.
SystemTime Time (UTC) at which the error occurred
dwErrorCode1 The error codes and their meaning are to be found in the structure
definition
dwErrorCode2 The error codes and their meaning are to be found in the structure
definition
szErrorText Text description of the error cause
bCycle Cycle type
szApplicationName Error-triggering application
szFunctionName FunctionID
szTagName Tag name
dwCycle Cycle type
szErrorTextTagName Text description of the tag status
status Tag status
lpszPictureName Picture in which the error occurred
lpszObjectName Object in which the error occurred
lpszPropertyName Object property in which the error occurred
dwParamSize only used internally
szErrorText Text description of the error cause returned by the error structure
"pError"
OnTime
Function
OnTime is exclusively called by the system. The function returns the runtime of all actions or
determines the actions running longer than the specified time. Time measurement can be
enabled/disabled via APDIAG.
As this function is available as a standard function the output type can be influenced by
changing the function code.
Note
Please note that modified standard functions are overwritten by a WinCC installation so that
the changes will be lost.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1009
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
void OnTime(CCAPTime time)
Parameters
time
Result structure
STRUCTURES_TABLES_CCAPTIME
2.15.2.7 Windows
Windows - short description
The Windows group contains the ProgramExecute function.
This function can be used to execute any program.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
ProgramExecute
Function
Starts the program with the specified name.
Syntax
unsigned int ProgramExecute(char* Program_Name)
Parameters
Program_Name
Pointer to the program name
Return value
If the return value is greater than 31, the function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
1010 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
In case of an error, the return value contains one of the following error codes:
0 out of memory
2 Specified file could not be found.
3 Specified path could not be found.
11 Program could not be started.
2.15.3 Internal functions
2.15.3.1 Internal functions - short description
Internal functions are used to make graphic objects and archives dynamic and in project
functions, standard functions and global script actions.
Internal funtions are recognized throughout a project.
They can be neither be newly created nor can existing internal functions be modified.
Internal functions are divided into the following groups:
allocate
Functions to reserve and release working memory space
c_bib
Functions from the standard C-library
graphics
Functions to read and set properties of graphical objects
tag
Functions to read and write tags
wincc
Functions for changing languages, deactivating Runtime and ending WinCC
2.15.3.2 allocate
SysFree
Function
Releases the memory area previously reserved with the SysMalloc function.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1011
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
void SysFree(void* lpFree);
Parameters
lpFree
Pointer to the memory area reserved with the SysMalloc function
SysMalloc
Function
Reserves memory space for an action. The memory area is assigned to the action. When the
action has been completed and the result transferred, the system releases the memory again.
The SysFree function can be used to release reserved memory space.
Syntax
void* SysMalloc(unsigned long int size);
Parameters
size
Size of the memory area in bytes.
2.15.3.3 c_bib
c_bib - short description
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
1012 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
ctype
isalnum
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1013
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
isalpha
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1014 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
isdigit
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
isgraph
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1015
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
islower
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1016 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
isprint
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1017
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
ispunct
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
isspace
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
1018 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
isupper
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1019
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
isxdigit
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1020 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
tolower
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
toupper
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1021
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
math
acos
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1022 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
asin
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1023
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
atan
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
atan2
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
1024 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
ceil
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1025
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
cos
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1026 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
cosh
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
exp
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1027
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
fabs
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1028 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
floor
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1029
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
fmod
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
frexp
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
1030 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
ldexp
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1031
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
log
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1032 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
log10
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
modf
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1033
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
pow
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1034 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
sin
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1035
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
sinh
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
sqrt
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
1036 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
tan
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1037
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
tanh
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1038 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
memory
memchr
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
memcmp
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1039
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
memcpy
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1040 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
memmove
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1041
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
memset
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
stdio
char_io
fgetc
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
WinCC: Scripting (VBS, ANSI-C, VBA)
1042 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
fgets
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1043
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
fputc
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1044 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
fputs
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
getc
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1045
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
putc
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1046 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
ungetc
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1047
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Directio
fread
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
fwrite
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
1048 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
Error
clearerr
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1049
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
feof
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1050 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
ferror
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
File
fclose
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1051
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
fflush
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1052 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
fopen
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1053
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
freopen
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
remove
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
1054 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
rename
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1055
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
setbuf
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1056 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
setvbuf
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
tmpfile
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1057
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
tmpnam
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1058 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
File_pos
fgetpos
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1059
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
fseek
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
fsetpos
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
1060 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
ftell
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1061
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
rewind
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1062 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Output
vfprintf
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
vsprintf
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1063
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
stdlib
abs
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1064 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
atof
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1065
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
atoi
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
atol
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
1066 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
bsearch
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1067
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
calloc
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1068 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
div
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
free
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1069
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
getenv
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1070 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
labs
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1071
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
ldiv
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
malloc
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
1072 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
qsort
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1073
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
rand
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1074 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
realloc
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
srand
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1075
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strtod
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1076 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strtol
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1077
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
strtoul
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
string
strcat
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
1078 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strchr
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1079
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strcmp
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1080 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
strcpy
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strcspn
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1081
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strerror
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1082 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strlen
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1083
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
strncat
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strncmp
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
1084 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strncpy
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1085
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strpbrk
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1086 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
strrchr
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strspn
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1087
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strstr
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1088 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strtok
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1089
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
time
asctime
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
clock
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
1090 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
ctime
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1091
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
difftime
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
1092 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
gmtime
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
localtime
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1093
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
mktime
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
WinCC: Scripting (VBS, ANSI-C, VBA)
1094 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
strftime
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1095
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
time
The function group c_bib contains C functions from the C library and is divided into:
● ctype
● math
● memory
● stdio
● stdlib
● string
● time
stdio itself is further divided into:
● char_io
● directio
● error
● file
● file_pos
● output
You can find a description of this function in related technical literature.
Note
The function localtime reacts as follows in respect of date output:
Numbering of the months begins with 0.
The years are counted from 1900, beginning with 0.
The C-library functions printf(), sprintf(), fprintf() can only process 360 characters in WinCC.
2.15.3.4 graphics
Graphics - short description
The functions of the Graphics group allow to modify or query graphical properties of WinCC
objects.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
WinCC: Scripting (VBS, ANSI-C, VBA)
1096 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Note
If the function is called for the picture object, set the parameter lpszObjectName = ZERO.
get
axes
GetAlignment
Function
When using bar objects, it indicates whether the text is to the right or left of the bar.
Syntax
BOOL GetAlignment(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Text is to the right of the bar
FALSE
Text is to the left of the bar
See also
Beispiel GetScaling (Page 1540)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1097
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetAxisSection
Function
When using bar objects, it specifies the difference between the values of two neighboring axis
labels.
Syntax
double GetAxisSection(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Difference between the values of two neighboring axis labels
GetExponent
Function
When using bar objects, it specifies whether the axis label corresponds to the decimal or
exponential form.
Syntax
BOOL GetExponent(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1098 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
Axis label in exponential form
FALSE
Axis label in decimal form
See also
Beispiel GetScaling (Page 1540)
GetLeftComma
Function
When using bar objects, it specifies the number of integers in the axis label.
Syntax
long int GetLeftComma(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
The number of integers in the axis label
GetLongStrokesBold
Function
When using bar objects, it specifies whether the main division lines on the scale are bold or
regular.
Syntax
BOOL GetLongStrokesBold(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1099
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
The main division lines on the graph scale are bold
FALSE
The main division lines on the graph scale are regular
See also
Beispiel GetScaling (Page 1540)
GetLongStrokesOnly
Function
When using bar objects, it specifies whether intermediate division lines are used on the scale.
Syntax
BOOL GetLongStrokesOnly(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Only main division lines are used on the bar graph scale.
WinCC: Scripting (VBS, ANSI-C, VBA)
1100 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
Both main and intermediate division lines are used on the bar graph scale.
See also
Beispiel GetScaling (Page 1540)
GetLongStrokesSize
Function
When using bar objects, it specifies the length of the main division lines.
Syntax
long int GetLongStrokesSize(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Length of the main division lines as numeric value
GetLongStrokesTextEach
Function
When using bar objects, it specifies the interval between the main division lines being assigned
a label.
Syntax
long int GetLongStrokesTextEach(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1101
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
Return value
Label of the main division lines as numeric value
Example:
Return value = 1 -> Every main division line is assigned a label.
Return value = 2 -> Every 2nd main division line is assigned a label.
etc.
GetRightComma
Function
When using bar objects, it specifies the number of decimal places in the axis label.
Syntax
long int GetRightComma(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
The number of decimal places in the axis label
GetScaleTicks
Function
When using bar objects, it specifies the scale marks as number of scale sections. A scale
section is a part of the scale bounded by two main tick marks.
WinCC: Scripting (VBS, ANSI-C, VBA)
1102 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
long int GetScaleTicks(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Scale marks as number of scale sections
Note
The number of scale sections is given as 0, if the bar object itself calculates a suitable scale
unit.
GetScaling
Function
When using bar objects, it specifies whether the scale is activated or deactivated.
Syntax
BOOL GetScaling(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Display with scale
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1103
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
Display without scale
See also
Beispiel GetScaling (Page 1540)
GetScalingType
Function
When using bar objects, it specifies the type of bar scaling.
Syntax
long int GetScalingType(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Type of bar scaling as numeric value
See also
Bar Scaling (Page 1595)
WinCC: Scripting (VBS, ANSI-C, VBA)
1104 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
color
Color - short description
The various color properties of objects can be modified or queried using the functions in the
Color group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetBackColor
Function
Specifies the background color of the object as a numeric value.
Syntax
long int GetBackColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Background color of the object as a numeric value
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1105
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetBackColor2
Function
When using bar objects, it specifies the color of the bar as a numeric value.
Syntax
long int GetBackColor2(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the bar color
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetBackColor3
Function
When using bar objects, it specifies the background color of the bar as a numeric value.
Syntax
long int GetBackColor3(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1106 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Numeric value defining the bar background color
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetBackColorBottom
Function
Specifies the background color of the slider objects at the bottom right.
Syntax
long int GetBackColorBottom(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the background color of the slider objects at the bottom right
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetBackColorTop
Function
Specifies the background color of the slider objects at the top left.
Syntax
long int GetBackColorTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1107
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the background color of the slider objects at the top left
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetBorderBackColor
Function
Specifies the background color of the lines or borders.
Syntax
long int GetBorderBackColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the background color of the lines or borders
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
WinCC: Scripting (VBS, ANSI-C, VBA)
1108 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetBorderColor
Function
Specifies the line or border color as a numeric value.
Syntax
long int GetBorderColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the color of lines or borders
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetBorderColorBottom
Function
Specifies the 3D border color at the bottom.
Syntax
long int GetBorderColorBottom(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1109
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Numeric value defining the 3D border color at the bottom
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetBorderColorTop
Function
Specifies the 3D border color at the top.
Syntax
long int GetBorderColorTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the 3D border color at the top
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetButtonColor
Function
Specifies the button color of slider objects.
Syntax
long int GetButtonColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
1110 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the button color of slider objects
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetColorBottom
Function
When using slider objects, it specifies the color of the bottom limit.
Syntax
long int GetColorBottom(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the color of the bottom limit of slider objects
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1111
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetColorTop
Function
When using slider objects, it specifies the color of the top limit.
Syntax
long int GetColorTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the color of the top limit of slider objects
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetFillColor
Function
Specifies the color of the fill pattern.
Syntax
long int GetFillColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1112 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Numeric value of the fill color
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetForeColor
Function
Specifies the color of the font.
Syntax
long int GetForeColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the font color
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1113
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetGridColor
Function
Specifies the grid color of Graphics Designer.
Syntax
long int GetGridColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the grid color of Graphics Designer
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetItemBorderBackColor
Function
Specifies the background color of the dividing line for the "text list" object.
Syntax
long int GetItemBorderBackColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1114 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Numeric value defining the background color of the dividing line for the "text list" object
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetItemBorderColor
Function
Specifies the color of the dividing line for the "text list" object.
Syntax
long int GetItemBorderColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the dividing line color for the "text list" object
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetScaleColor
Function
Specifies the scale color for bar objects.
Syntax
long int GetScaleColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1115
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value of the scale color for bar objects
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetSelBGColor
Function
Specifies the background color of the selected entry for the "text list" object.
Syntax
long int GetSelBGColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the background color of the selected entry
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
WinCC: Scripting (VBS, ANSI-C, VBA)
1116 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetSelTextColor
Function
Specifies the font color of the selected entry for the "text list" object.
Syntax
long int GetSelTextColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the font color of the selected entry
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetTrendColor
Function
Specifies the trend color of bar objects.
Syntax
long int GetTrendColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1117
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Numeric value defining the trend color of bar objects
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetUnselBGColor
Function
Specifies the background color of the non-selected entries for the "text list" object.
Syntax
long int GetUnselBGColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the background color of the non-selected entries
See also
Color chart (Page 1597)
GetBackColor example (Page 1522)
GetUnselTextColor
Function
Specifies the font color of the non-selected entries for the "text list" object.
Syntax
long int GetUnselTextColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
1118 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the font color of the non-selected entries
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
fill
Fill - short description
The functions in the Fill group control the dynamic filling of objects.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetFilling
Function
Specifies whether dynamic filling with background color is activated.
Syntax
BOOL GetFilling(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1119
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
Return value
TRUE
Dynamic filling with background color is activated.
FALSE
Dynamic filling with background color is not activated.
See also
GetFilling example (Page 1523)
GetFillingIndex
Function
Specifies the current fill level.
Syntax
long int GetFillingIndex(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Current fill level as a numeric value (0 - 100)
See also
GetFillingIndex example (Page 1523)
WinCC: Scripting (VBS, ANSI-C, VBA)
1120 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
flash
Flash - short description
The various flashing properties can be modified or called in using the functions in the Flash
group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetBackFlashColorOff
Function
Specifies the background flash color for the deactivated status.
Syntax
long int GetBackFlashColorOff(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Background flash color for the deactivated status as a numeric value
See also
Color chart (Page 1597)
GetFlashBackColorOn example (Page 1525)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1121
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetBackFlashColorOn
Function
Specifies the background flash color for the activated status.
Syntax
long int GetBackFlashColorOn(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Background flash color for the activated status as a numeric value
See also
GetFlashBackColorOn example (Page 1525)
Color chart (Page 1597)
GetBorderFlashColorOff
Function
Specifies the border or line flashing color for the deactivated status.
Syntax
long int GetBorderFlashColorOff(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1122 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Border or line flashing color for the deactivated status as a numeric value
See also
GetFlashBackColorOn example (Page 1525)
Color chart (Page 1597)
GetBorderFlashColorOn
Function
Specifies the border or line flashing color for the activated status.
Syntax
long int GetBorderFlashColorOn(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Border or line flashing color for the activated status as a numeric value
See also
GetFlashBackColorOn example (Page 1525)
Color chart (Page 1597)
GetFlashBackColor
Function
Specifies whether flashing of the background is activated or not.
Syntax
BOOL GetFlashBackColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1123
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Flashing background is activated.
FALSE
Flashing background is not activated.
See also
GetFlashBackColor example (Page 1525)
GetFlashBorderColor
Function
Specifies whether flashing of the border or line is activated or not.
Syntax
BOOL GetFlashBorderColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Flashing of the border or line is activated.
WinCC: Scripting (VBS, ANSI-C, VBA)
1124 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
Flashing of the border or line is not activated.
See also
GetFlashBackColor example (Page 1525)
GetFlashForeColor
Function
Specifies whether flashing of the font is activated or not.
Syntax
BOOL GetFlashForeColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Flashing of the font is activated.
FALSE
Flashing of the font is not activated.
See also
GetFlashBackColor example (Page 1525)
GetFlashRateBackColor
Function
Specifies the flash frequency of the background.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1125
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
long int GetFlashRateBackColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Flash frequency of the background
See also
GetFlashBackColorOn example (Page 1525)
Flash frequencies (Page 1595)
GetFlashRateBorderColor
Function
Specifies the flash frequency of the line or border.
Syntax
long int GetFlashRateBorderColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Flash frequency of the line or border
WinCC: Scripting (VBS, ANSI-C, VBA)
1126 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
GetFlashBackColorOn example (Page 1525)
Flash frequencies (Page 1595)
GetFlashRateForeColor
Function
Specifies the flash frequency of the font.
Syntax
long int GetFlashRateForeColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Flash frequency of the font
See also
GetFlashBackColorOn example (Page 1525)
Flash frequencies (Page 1595)
GetForeFlashColorOff
Function
Specifies the font flash color for the deactivated status.
Syntax
long int GetForeFlashColorOff(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1127
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Font flash color for the deactivated status as a numeric value
See also
GetFlashBackColorOn example (Page 1525)
Color chart (Page 1597)
GetForeFlashColorOn
Function
Specifies the font flash color for the activated status.
Syntax
long int GetForeFlashColorOn(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Font flash color for the activated status as a numeric value
See also
GetFlashBackColorOn example (Page 1525)
Color chart (Page 1597)
WinCC: Scripting (VBS, ANSI-C, VBA)
1128 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
focus
Focus - short description
Using the functions in the Focus group, it is possible to set the focus or poll which object has
the focus.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
Get_Focus
Function
Specifies the name of the object currently or last focussed.
Syntax
char *Get_Focus();
Return value
Name of the object currently or last focussed.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
See also
GetFocus example (Page 1526)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1129
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
font
Font - short description
The various properties affecting text can be modified or called in using the functions in the
Font group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetAlignmentLeft
Function
Specifies the horizontal text alignment (left, centered, right).
Syntax
long int GetAlignmentLeft(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Horizontal text alignment as a numeric value
See also
Text alignment (Page 1602)
GetFontSize example (Page 1527)
WinCC: Scripting (VBS, ANSI-C, VBA)
1130 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetAlignmentTop
Function
Specifies the vertical text alignment (top, centered, bottom).
Syntax
long int GetAlignmentTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Vertical text alignment as a numeric value
See also
GetFontSize example (Page 1527)
Text alignment (Page 1602)
GetFontBold
Function
Specifies whether the font is bold or not.
Syntax
BOOL GetFontBold(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1131
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
Bold font on
FALSE
Bold font off
See also
GetFontBold example (Page 1527)
GetFontItalic
Function
Specifies whether the font is italic or not.
Syntax
BOOL GetFontItalic(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Italic font on
FALSE
Italic font off
See also
GetFontBold example (Page 1527)
WinCC: Scripting (VBS, ANSI-C, VBA)
1132 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetFontName
Function
Indicates the current font name.
Syntax
char* GetFontName(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Pointer to the name of the font currently selected.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
See also
GetText example (Page 1560)
GetFontSize
Function
Specifies the font size.
Syntax
long int GetFontSize(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1133
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Current font size
See also
GetFontSize example (Page 1527)
GetFontUnderline
Function
Specifies whether the font is underlined or not.
Syntax
BOOL GetFontUnderline(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Underlined font on
FALSE
Underlined font off
See also
GetFontBold example (Page 1527)
WinCC: Scripting (VBS, ANSI-C, VBA)
1134 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetOrientation
Function
Specifies the text orientation (vertical/horizontal).
Syntax
BOOL GetOrientation(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Vertical text orientation
FALSE
Horizontal text orientation
See also
GetFontBold example (Page 1527)
GetText
Function
Specifies the value of the "text" property for objects like static text, check box or radio box.
Syntax
char* GetText(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1135
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
Return value
Pointer to a text.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
Note
In case of check and radio boxes, the element to be determined must be defined with the
"SetIndex" function before actually activating this function.
See also
GetText example (Page 1560)
general
GetLayer
Function
Specifies the picture layer in which the object is located.
Syntax
long int GetLayer(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1136 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Picture layer in which the object is located
geometry
Geometry - short description
The size, position and other geometrical properties of objects can be modified or called in using
the functions in the Geometry group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetActualPointLeft
Function
Specifies the X value of the current position in a polygon or polygon line.
Syntax
long int GetActualPointLeft(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
X value for the current point of a polygon or polygon line
Note
The current point of the polygon can be set using the SetIndex function.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1137
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
GetLeft example (Page 1530)
GetActualPointTop
Function
Specifies the Y value of the current position in a polygon or polygon line.
Syntax
long int GetActualPointTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Y value for the current point of a polygon or polygon line
Note
The current point of the polygon can be set using the SetIndex function.
See also
GetTop example (Page 1560)
GetBoxCount
Function
Specifies the number of fields for check boxes and radio boxes.
Syntax
long int GetBoxCount(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
1138 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Number of fields in a check box or radio box.
GetDirection
Function
Specifies the bar direction for bar objects.
Syntax
long int GetDirection(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Bar direction of bar objects as numeric value
See also
Bar direction (Page 1595)
GetEndAngle
Function
Specifies the end angle of circle and ellipse segments and circle and elliptical arcs.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1139
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
long int GetEndAngle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
End angle of circle and ellipse segments as well as circle and ellipse arcs
GetGrid
Function
Specifies whether the grid is activated in the graphics area of Graphics Designer.
Syntax
BOOL GetGrid(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Grid in Graphics Designer is activated.
FALSE
Grid in Graphics Designer is deactivated.
WinCC: Scripting (VBS, ANSI-C, VBA)
1140 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetGridHeight
Function
Specifies the height of the grid in the graphics area of Graphics Designer.
Syntax
long int GetGridHeight(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Height of the grid in Graphics Designer
GetGridWidth
Function
Specifies the width of the grid in the graphics area of Graphics Designer.
Syntax
long int GetGridWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Width of the grid in Graphics Designer
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1141
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetHeight
Function
Specifies the height of the rectangle framing an object.
Syntax
long int GetHeight(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Height of the rectangle framing an object
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
See also
GetHeight example (Page 1528)
GetLeft
Function
Specifies the X position of the upper left corner of the rectangle framing an object.
Syntax
long int GetLeft(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
1142 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Current X value of the upper left corner of the rectangle framing an object
See also
GetLeft example (Page 1530)
GetPointCount
Function
Specifies the number of corners of a polygon or in a polygon line.
Syntax
long int GetPointCount(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Number of corners of a polygon or in a polyline
GetRadius
Function
Specifies the radius of a circle, circle segment or arc.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1143
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
long int GetRadius(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Radius of a circle, circle segment or arc
See also
GetHeight example (Page 1528)
GetRadiusHeight
Function
Specifies the radius of an ellipse, ellipse segment or elliptical arc in a vertical direction.
Syntax
long int GetRadiusHeight(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Radius of an ellipse, ellipse segment or elliptical arc in a vertical direction
See also
GetHeight example (Page 1528)
WinCC: Scripting (VBS, ANSI-C, VBA)
1144 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetRadiusWidth
Function
Specifies the radius of an ellipse, ellipse segment or elliptical arc in a horizontal direction.
Syntax
long int GetRadiusWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Radius of an ellipse, ellipse segment or elliptical arc in a horizontal direction
See also
GetHeight example (Page 1528)
GetReferenceRotationLeft
Function
Specifies the X value of the rotation reference (central axis about which the object can be
rotated) for lines, polygons and polylines.
Syntax
long int GetReferenceRotationLeft(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1145
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
X value of the rotation reference for lines, polygons and polygon lines
See also
GetLeft example (Page 1530)
GetReferenceRotationTop
Function
Specifies the Y value of the rotation reference (central axis about which the object can be
rotated) for lines, polygons and polylines.
Syntax
long int GetReferenceRotationTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Y value of the rotation reference for lines, polygons and polygon lines
See also
GetTop example (Page 1560)
GetRotationAngle
Function
Specifies the angle of rotation about the central axis for lines, polygons and polylines.
Syntax
long int GetRotationAngle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
1146 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Angle of rotation about the central axis
See also
GetHeight example (Page 1528)
GetRoundCornerHeight
Function
Specifies the radius of the rounded corner of a rectangle vertically.
Syntax
long int GetRoundCornerHeight(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Vertical radius of the rounded corner of a rectangle
See also
GetHeight example (Page 1528)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1147
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetRoundCornerWidth
Function
Specifies the radius of the rounded corner of a rectangle horizontally.
Syntax
long int GetRoundCornerWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Horizontal radius of the corner of the rounded corner of a rectangle
See also
GetWidth example (Page 1562)
GetStartAngle
Function
Specifies the start angle of circle and ellipse segments and circle and elliptical arcs.
Syntax
long int GetStartAngle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1148 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Start angle of circle and ellipse segments as well as circle and elliptical arcs
See also
GetHeight example (Page 1528)
GetTop
Function
Specifies the Y position of the upper left corner of the rectangle framing an object.
Syntax
long int GetTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Current Y value of the upper left corner of the rectangle framing an object
See also
GetTop example (Page 1560)
GetWidth
Function
Specifies the width of the rectangle framing an object.
Syntax
long int GetWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1149
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Width of the rectangle framing an object
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
See also
GetWidth example (Page 1562)
GetZeroPoint
Function
When using bar objects, it indicates the zero point.
Syntax
long int GetZeroPoint(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Zero point for bar objects
WinCC: Scripting (VBS, ANSI-C, VBA)
1150 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
GetHeight example (Page 1528)
i_o
i_o - short description
The various properties affecting input and output values can be modified or called in using the
functions in the i_o group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetAssignments
Function
Assignment of text to the value range of lists
Syntax
char* GetAssignments(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
The assignment of text to the value range depends on the list type.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1151
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
List types (Page 1601)
GetAssumeOnExit
Function
Specifies for I/O fields whether the entered value is assumed upon exiting the field.
Syntax
BOOL GetAssumeOnExit(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Value application upon exiting the field.
FALSE
No value application upon exiting the field.
GetAssumeOnFull
Function
Specifies for I/O fields whether the entered value is assumed on completion of input.
Syntax
BOOL GetAssumeOnFull(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
1152 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
Return value
TRUE
Value application on completion of input.
FALSE
No value application on completion of input.
GetBitNumber
Function
Specifies the relevant bit in the output value for the "bit" list type.
Syntax
long int GetBitNumber(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Indication of the relevant bit in the output value for the "bit" list type
See also
GetHiddenInput example (Page 1529)
List types (Page 1601)
GetClearOnError
Function
Specifies for I/O fields whether deletion of the content in case of input errors is activated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1153
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL GetClearOnError(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Deletion of the content in case of input errors is activated
FALSE
Deletion of the content in case of input errors is not activated
GetClearOnNew
Function
Specifies for I/O fields whether deletion of the content on new input is activated.
Syntax
BOOL GetClearOnNew(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Deletion of the content on new input is activated.
WinCC: Scripting (VBS, ANSI-C, VBA)
1154 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
Deletion of the content on new input is not activated.
GetDataFormat
Function
Specifies the data type of the field content for I/O fields.
Syntax
long int GetDataFormat(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Data type of the field content as numeric value
See also
GetHiddenInput example (Page 1529)
I/O field, data type of the field content (Page 1597)
GetHiddenInput
Function
Specifies whether hidden input is activated for I/O fields.
Syntax
BOOL GetHiddenInput(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1155
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Hidden input is activated
FALSE
Hidden input is not activated
See also
GetHiddenInput example (Page 1529)
GetInputValueChar
Function
Specifies the input value in the data type "char" for I/O fields.
Syntax
char* GetInputValueChar(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Pointer to the input value in the data type "char".
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
WinCC: Scripting (VBS, ANSI-C, VBA)
1156 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
{
.......
}
GetInputValueDouble
Function
Specifies the input value in the data type "double" for I/O fields.
Syntax
double GetInputValueDouble(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Input value in the data type "double"
GetListType
Function
Specifies the list type for the "text list" object.
Syntax
long int GetListType(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1157
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
List type for the "text list" object
See also
GetHiddenInput example (Page 1529)
List types (Page 1601)
GetNumberLines
Function
Specifies the number of visible lines for the "text list" object.
Syntax
long int GetNumberLines(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Number of visible lines for the "text list" object
Note
If the amount of configured text is larger than the number of visible lines, the "text list" object
receives a vertical scroll bar.
See also
GetHiddenInput example (Page 1529)
GetOutputFormat
Function
Specifies the output format for I/O fields.
WinCC: Scripting (VBS, ANSI-C, VBA)
1158 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
char* GetOutputFormat(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Pointer to the output format.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
See also
I/O field, data type of the field content (Page 1597)
I/O field, output format (Page 1596)
GetOutputValueChar
Function
Determines the output value in the data type "char" for I/O fields. This function should only be
used if the field content of the I/O field is of the "string" data type.
Syntax
char* GetOutputValueChar(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1159
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
Return value
Pointer to the output value in the data type "char".
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
GetOutputValueDouble
Function
Determines the output value in the data type "double" for I/O fields. This function should only
be used if the field content of the I/O field is not of the "string" data type.
Syntax
double GetOutputValueDouble(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Output value in the data type "double"
See also
GetOutputValueDouble example (Page 1533)
WinCC: Scripting (VBS, ANSI-C, VBA)
1160 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Limits
Limits - short description
The various properties affecting limit values can be modified or called in using the functions
in the Limits group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetAlarmHigh
Function
Specifies the upper alarm limit for bar objects.
Syntax
double GetAlarmHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Upper alarm limit for bar objects
See also
GetAlarmHigh example (Page 1521)
GetAlarmLow
Function
Specifies the lower alarm limit for bar objects.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1161
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
double GetAlarmLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Lower alarm limit for bar objects
See also
GetAlarmHigh example (Page 1521)
GetCheckAlarmHigh
Function
When using bar objects, it specifies whether the upper alarm limit is monitored.
Syntax
BOOL GetCheckAlarmHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the upper alarm limit is monitored.
FALSE
In case of bar objects the upper alarm limit is not monitored.
WinCC: Scripting (VBS, ANSI-C, VBA)
1162 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
GetMarker example (Page 1532)
GetCheckAlarmLow
Function
When using bar objects, it specifies whether the lower alarm limit is monitored.
Syntax
BOOL GetCheckAlarmLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the lower alarm limit is monitored.
FALSE
In case of bar objects the lower alarm limit is not monitored.
See also
GetMarker example (Page 1532)
GetCheckLimitHigh4
Function
When using bar objects, it specifies whether the upper limit value reserve 4 is monitored.
Syntax
BOOL GetCheckLimitHigh4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1163
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the upper limt value reserve 4 is monitored.
FALSE
In case of bar objects the upper limt value reserve 4 is not monitored.
See also
GetMarker example (Page 1532)
GetCheckLimitHigh5
Function
When using bar objects, it specifies whether the upper limit value reserve 5 is monitored.
Syntax
BOOL GetCheckLimitHigh5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the upper limt value reserve 5 is monitored.
WinCC: Scripting (VBS, ANSI-C, VBA)
1164 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
In case of bar objects the upper limt value reserve 5 is not monitored.
See also
GetMarker example (Page 1532)
GetCheckLimitLow4
Function
When using bar objects, it specifies whether the lower limit value reserve 4 is monitored.
Syntax
BOOL GetCheckLimitLow4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the lower limt value reserve 4 is monitored.
FALSE
In case of bar objects the lower limt value reserve 4 is not monitored.
See also
GetMarker example (Page 1532)
GetCheckLimitLow5
Function
When using bar objects, it specifies whether the lower limit value reserve 5 is monitored.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1165
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL GetCheckLimitLow5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the lower limt value reserve 5 is monitored.
FALSE
In case of bar objects the lower limt value reserve 5 is not monitored.
See also
GetMarker example (Page 1532)
GetCheckToleranceHigh
Function
When using bar objects, it specifies whether the upper tolerance limit is monitored.
Syntax
BOOL GetCheckToleranceHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1166 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
In case of bar objects the upper tolerance limit is monitored.
FALSE
In case of bar objects the upper tolerance limit is not monitored.
See also
GetMarker example (Page 1532)
GetCheckToleranceLow
Function
When using bar objects, it specifies whether the lower tolerance limit is monitored.
Syntax
BOOL GetCheckToleranceLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the lower tolerance limit is monitored.
FALSE
In case of bar objects the lower tolerance limit is not monitored.
See also
GetMarker example (Page 1532)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1167
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetCheckWarningHigh
Function
When using bar objects, it specifies whether the upper warning limit is monitored.
Syntax
BOOL GetCheckWarningHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the upper warning limit is monitored.
FALSE
In case of bar objects the upper warning limit is not monitored.
See also
GetMarker example (Page 1532)
GetCheckWarningLow
Function
When using bar objects, it specifies whether the lower warning limit is monitored.
Syntax
BOOL GetCheckWarningLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
1168 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the lower warning limit is monitored.
FALSE
In case of bar objects the lower warning limit is not monitored.
See also
GetMarker example (Page 1532)
GetColorAlarmHigh
Function
Specifies the bar color for bar objects upon reaching the upper alarm limit.
Syntax
long int GetColorAlarmHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the bar color upon reaching the upper alarm limit
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1169
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetColorAlarmLow
Function
Specifies the bar color for bar objects upon reaching the lower alarm limit.
Syntax
long int GetColorAlarmLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the bar color upon reaching the lower alarm limit
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetColorLimitHigh4
Function
Specifies the bar color for bar objects upon reaching the upper limit reserve 4.
Syntax
long int GetColorLimitHigh4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1170 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Numeric value defining the bar color upon reaching the upper limit reserve 4
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetColorLimitHigh5
Function
Specifies the bar color for bar objects upon reaching the upper limit reserve 5.
Syntax
long int GetColorLimitHigh5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the bar color upon reaching the upper limit reserve 5
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetColorLimitLow4
Function
Specifies the bar color for bar objects upon reaching the lower limit reserve 4.
Syntax
long int GetColorLimitLow4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1171
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the bar color upon reaching the lower limit reserve 4
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetColorLimitLow5
Function
Specifies the bar color for bar objects upon reaching the lower limit reserve 5.
Syntax
long int GetColorLimitLow5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the bar color upon reaching the lower limit reserve 5
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
WinCC: Scripting (VBS, ANSI-C, VBA)
1172 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetColorToleranceHigh
Function
Specifies the bar color for bar objects upon reaching the upper tolerance limit.
Syntax
long int GetColorToleranceHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the bar color upon reaching the upper tolerance limit
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetColorToleranceLow
Function
Specifies the bar color for bar objects upon reaching the lower tolerance limit.
Syntax
long int GetColorToleranceLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1173
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Numeric value defining the bar color upon reaching the lower tolerance limit
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetColorWarningHigh
Function
Specifies the bar color for bar objects upon reaching the upper warning limit limit.
Syntax
long int GetColorWarningHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the bar color upon reaching the upper warning limit
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetColorWarningLow
Function
Specifies the bar color for bar objects upon reaching the lower warning limit.
Syntax
long int GetColorWarningLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
1174 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the bar color upon reaching the lower warning limit
See also
GetBackColor example (Page 1522)
Color chart (Page 1597)
GetLimitHigh4
Function
Specifies the upper limit value for reserve 4 for bar objects.
Syntax
double GetLimitHigh4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
High limit value for reserve 4 for bar objects
See also
GetAlarmHigh example (Page 1521)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1175
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetLimitHigh5
Function
Specifies the upper limit value for reserve 5 for bar objects.
Syntax
double GetLimitHigh5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
High limit value for reserve 5 for bar objects
See also
GetAlarmHigh example (Page 1521)
GetLimitLow4
Function
Specifies the low limit value for reserve 4 for bar objects.
Syntax
double GetLimitLow4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1176 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Low limit value for reserve 4 for bar objects
See also
GetAlarmHigh example (Page 1521)
GetLimitLow5
Function
Specifies the low limit value for reserve 5 for bar objects.
Syntax
double GetLimitLow5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Low limit value for reserve 5 for bar objects
See also
GetAlarmHigh example (Page 1521)
GetLimitMax
Function
Specifies the upper limit value for I/O fields.
Syntax
double GetLimitMax(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1177
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
High limit value for I/O fields
See also
GetAlarmHigh example (Page 1521)
GetLimitMin
Function
Specifies the low limit value for I/O fields.
Syntax
double GetLimitMin(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Low limit value for I/O fields
See also
GetAlarmHigh example (Page 1521)
WinCC: Scripting (VBS, ANSI-C, VBA)
1178 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetMarker
Function
When using bar objects, it specifies whether the limit marker is displayed.
Syntax
BOOL GetMarker(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Limit marker for bar objects is displayed.
FALSE
Limit marker for bar objects is not displayed.
See also
GetMarker example (Page 1532)
GetToleranceHigh
Function
Specifies the upper tolerance limit for bar objects.
Syntax
double GetToleranceHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1179
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
Return value
Upper tolerance limit for bar objects
See also
GetAlarmHigh example (Page 1521)
GetToleranceLow
Function
Specifies the lower tolerance limit for bar objects.
Syntax
double GetToleranceLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Lower tolerance limit for bar objects
See also
GetAlarmHigh example (Page 1521)
GetTypeAlarmHigh
Function
Specifies for bar objects whether the upper alarm limit is given in percentages or absolute
terms.
WinCC: Scripting (VBS, ANSI-C, VBA)
1180 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL GetTypeAlarmHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the upper alarm limit is given in percentages.
FALSE
In case of bar objects the upper alarm limit is given in absolute terms.
See also
GetMarker example (Page 1532)
GetTypeAlarmLow
Function
Specifies for bar objects whether the lower alarm limit is given in percentages or absolute terms.
Syntax
BOOL GetTypeAlarmLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1181
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
In case of bar objects the lower alarm limit is given in percentages.
FALSE
In case of bar objects the lower alarm limit is given in absolute terms.
See also
GetMarker example (Page 1532)
GetTypeLimitHigh4
Function
Specifies for bar objects whether the upper limit reserve 4 is given in percentages or absolute
terms.
Syntax
BOOL GetTypeLimitHigh4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the upper limit reserve 4 is given in percentages.
FALSE
In case of bar objects the upper limit reserve 4 is given in absolute terms.
See also
GetMarker example (Page 1532)
WinCC: Scripting (VBS, ANSI-C, VBA)
1182 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTypeLimitHigh5
Function
Specifies for bar objects whether the upper limit reserve 5 is given in percentages or absolute
terms.
Syntax
BOOL GetTypeLimitHigh5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the upper limit reserve 5 is given in percentages.
FALSE
In case of bar objects the upper limit reserve 5 is given in absolute terms.
See also
GetMarker example (Page 1532)
GetTypeLimitLow4
Function
Specifies for bar objects whether the lower limit reserve 4 is given in percentages or absolute
terms.
Syntax
BOOL GetTypeLimitLow4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1183
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the lower limit reserve 4 is given in percentages.
FALSE
In case of bar objects the lower limit reserve 4 is given in absolute terms.
See also
GetMarker example (Page 1532)
GetTypeLimitLow5
Function
Specifies for bar objects whether the lower limit reserve 5 is given in percentages or absolute
terms.
Syntax
BOOL GetTypeLimitLow5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the lower limit reserve 5 is given in percentages.
WinCC: Scripting (VBS, ANSI-C, VBA)
1184 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
In case of bar objects the lower limit reserve 5 is given in absolute terms.
See also
GetMarker example (Page 1532)
GetTypeToleranceHigh
Function
Specifies for bar objects whether the upper tolerance limit is given in percentages or absolute
terms.
Syntax
BOOL GetTypeToleranceHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the upper tolerance limit is given in percentages.
FALSE
In case of bar objects the upper tolerance limit is given in absolute terms.
See also
GetMarker example (Page 1532)
GetTypeToleranceLow
Function
Specifies for bar objects whether the lower tolerance limit is given in percentages or absolute
terms.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1185
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL GetTypeToleranceLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the lower tolerance limit is given in percentages.
FALSE
In case of bar objects the lower tolerance limit is given in absolute terms.
See also
GetMarker example (Page 1532)
GetTypeWarningHigh
Function
Specifies for bar objects whether the upper warning limit is given in percentages or absolute
terms.
Syntax
BOOL GetTypeWarningHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1186 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
In case of bar objects the upper warning limit is given in percentages.
FALSE
In case of bar objects the upper warning limit is given in absolute terms.
See also
GetMarker example (Page 1532)
GetTypeWarningLow
Function
Specifies for bar objects whether the lower warning limit is given in percentages or absolute
terms.
Syntax
BOOL GetTypeWarningLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
In case of bar objects the lower warning limit is given in percentages.
FALSE
In case of bar objects the lower warning limit is given in absolute terms.
See also
GetMarker example (Page 1532)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1187
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetWarningHigh
Function
Specifies the upper warning limit for bar objects.
Syntax
double GetWarningHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Upper warning limit for bar objects
See also
GetAlarmHigh example (Page 1521)
GetWarningLow
Function
Specifies the lower warning limit for bar objects.
Syntax
double GetWarningLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1188 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Lower warning limit for bar objects
See also
GetAlarmHigh example (Page 1521)
link
Link - short description
A tag link property can be created or called in using the functions in the Link group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetLink
Function
Specifies the current tag connection of object properties.
Syntax
BOOL GetLink(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpszPropertyName, LPLINKINFO *pLink);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lpszPropertyName
Object property
pLink
Pointer to a structure of the type: LINKINFO
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1189
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Structure definition LINKINFO (Page 1610)
GetLink example (Page 1530)
miscs
Miscs - short description
The properties of objects can be modified or called in using the functions in the Miscs group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetAdaptBorder
Function
Specifies for static texts, I/O fields, check boxes and radio boxes whether the border of the
field is to be dynamically adapted to the text size.
Syntax
BOOL GetAdaptBorder(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1190 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
Border is adapted
FALSE
Border is not adapted
See also
GetVisible example (Page 1561)
GetAdaptPicture
Function
Specifies for picture windows whether the picture is to be adapted to the window size.
Syntax
BOOL GetAdaptPicture(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Picture is adapted
FALSE
Picture is not adapted
See also
GetVisible example (Page 1561)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1191
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetAdaptSize
Function
Specifies for picture windows whether the window is to be adapted.
Syntax
BOOL GetAdaptSize(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Window is adapted
FALSE
Window is not adapted
See also
GetVisible example (Page 1561)
GetAverage
Function
When using bar objects, it specifies whether value averaging is activated.
Syntax
BOOL GetAverage(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
1192 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
Return value
TRUE
Averaging is activated for bar objects
FALSE
Averaging is not activated for bar objects
See also
GetVisible example (Page 1561)
GetBoxType
Function
Specifies the field type (input field, output field, input/output field) for I/O fields.
Syntax
long int GetBoxType(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Field type of an I/O field
See also
I/O field, field type (Page 1597)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1193
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetCaption
Function
Specifies whether a picture or application window has a title.
Syntax
BOOL GetCaption(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Picture/application window has a title
FALSE
Picture/application window has no title
See also
GetVisible example (Page 1561)
GetCloseButton
Function
When using a picture window, it specifies whether the window can be closed.
Syntax
BOOL GetCloseButton(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
1194 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
Return value
TRUE
Picture window can be closed
FALSE
Picture window cannot be closed
See also
GetVisible example (Page 1561)
GetColorChangeType
Function
When using bar objects, it specifies whether the color change upon reaching a limit value only
affects a bar segment or the entire bar.
Syntax
BOOL GetColorChangeType(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Color change applies to the bar sagment
FALSE
Color change applies to the entire bar
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1195
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
GetVisible example (Page 1561)
GetCursorControl
Function
Specifies whether cursor control is activated for I/O fields.
Syntax
BOOL GetCursorControl(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Cursor control for I/O fields is enabled.
FALSE
Cursor control for I/O fields is disabled.
See also
GetVisible example (Page 1561)
GetCursorMode
Function
Specifies whether the cursor mode for the picture is alpha cursor or tab order cursor.
Syntax
BOOL GetCursorMode(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
1196 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Cursor mode for the picture is "Alpha-cursor"
FALSE
Cursor mode for the picture is "tab order cursor"
See also
GetVisible example (Page 1561)
GetEditAtOnce
Function
Specifies whether the "Immediate input" property is activated for I/O fields.
Syntax
BOOL GetEditAtOnce(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
"Immediate input" property is activated
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1197
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
"Immediate input" property is deactivated
See also
GetVisible example (Page 1561)
GetExtendedOperation
Function
Specifies whether the "Extended operation" property is activated for slider objects.
Syntax
BOOL GetExtendedOperation(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
"Extended operation" property is activated
FALSE
"Extended operation" property is deactivated
See also
GetVisible example (Page 1561)
GetHotkey
Function
Specifies the key combination for check boxes.
WinCC: Scripting (VBS, ANSI-C, VBA)
1198 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
long int GetHotkey(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Key code for key combinations for check boxes
GetHysteresis
Function
When using bar objects, it specifies whether the display appears with or without hysteresis.
Syntax
BOOL GetHysteresis(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Display with hysteresis for bar objects
FALSE
Display without hysteresis for bar objects
See also
GetVisible example (Page 1561)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1199
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetHysteresisRange
Function
Specifies the hysteresis value in the display for bar objects.
Syntax
double GetHysteresisRange(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Hysteresis in the display for bar objects
GetLanguageSwitch
Function
Specifies fot the "Text list" object whether the assignment texts are to be stored in the text
library or in the object itself.
Syntax
BOOL GetLanguageSwitch(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1200 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
Assignment texts are stored in the text library
FALSE
Assignment texts are stored in the text list object
See also
GetVisible example (Page 1561)
GetLastChange
Function
Specifies the date when the picture was last changed.
Syntax
char* GetLastChange(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Date of the last change of the picture.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
See also
GetPictureName example (Page 1535)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1201
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetMax
Function
Specifies the maximum value for bar and slider objects.
Syntax
double GetMax(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Maximum value for bar and slider objects.
GetMaximizeButton
Function
Specifies for picture or application windows whether the window can be maximized.
Syntax
BOOL GetMaximizeButton(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Picture or application window can be maximized
WinCC: Scripting (VBS, ANSI-C, VBA)
1202 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
Picture or application window cannot be maximized
See also
GetVisible example (Page 1561)
GetMin
Function
Specifies the minimum value for bar and slider objects.
Syntax
double GetMin(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Minimum value for bar and slider objects
GetMoveable
Function
Specifies for picture or application windows whether the window can be moved.
Syntax
BOOL GetMoveable(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1203
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
Return value
TRUE
Picture or application window is movable
FALSE
Picture or application window is not movable
See also
GetVisible example (Page 1561)
GetOffsetLeft
Function
Specifies the horizontal picture distance from the left window border for picture windows.
Syntax
long int GetOffsetLeft(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Horizontal picture distance from the left window border for picture windows
GetOffsetTop
Function
Specifies the vertical picture distance from the upper window border for picture windows.
WinCC: Scripting (VBS, ANSI-C, VBA)
1204 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
long int GetOffsetTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Vertical picture distance from the upper window border for picture windows
GetOnTop
Function
Specifies for picture or application windows whether the window is always in the foreground.
Syntax
BOOL GetOnTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Picture or application window is always in the foreground
FALSE
Picture or application window can be overlapped by other windows.
See also
GetVisible example (Page 1561)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1205
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetOperation
Function
Specifies whether the object can be operated.
Syntax
BOOL GetOperation(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Object is operable
FALSE
Object is not operable
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
See also
GetVisible example (Page 1561)
GetOperationMessage
Function
Specifies for I/O fields, check boxes, radio boxes or sliders whether a message is output
following operation.
Syntax
BOOL GetOperationMessage(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
1206 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Upon operation a message is issued
FALSE
Upon operation no message is issued
See also
GetVisible example (Page 1561)
GetOperationReport
Function
Specifies for all objects except application and picture windows and OLE control whether the
reason for the operation is logged.
Syntax
BOOL GetOperationReport(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Reason for the operation is logged.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1207
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
Reason for the operation is not logged.
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
See also
GetVisible example (Page 1561)
GetPasswordLevel
Function
Specifies the authorization level for the operation of the object for all objects except application
and picture windows and OLE control.
Syntax
long int GetPasswordLevel(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Authorization level for the operation of the object
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
WinCC: Scripting (VBS, ANSI-C, VBA)
1208 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetPictureName
Function
Returns the name of the picture currently displayed in the picture window.
Syntax
char* GetPictureName(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Name of the picture window
Return value
Pointer to the name of the currently displayed picture
Note
If both parameters are NULL, a pointer appears indicating the name of the basic screen.
See also
GetPictureName example (Page 1535)
GetProcess
Function
Specifies the default setting value for the process value to be displayed for bar and slider
objects.
Specifies the selected fields for check boxes and radio boxes.
Syntax
double GetProcess(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1209
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
● For bar and slider objects: Default setting value for the process value to be displayed
● For check and radio boxes: In a 32-bit word each field is represented by a bit (field 1
corrsponds to the bit value 0). Selected fields are marked by a set bit. Non-existing are
assigned 0.
GetScrollBars
Function
Specifies for picture windows whether the window has a scroll bar.
Syntax
BOOL GetScrollBars(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Picture window has a scroll bar
FALSE
Picture window has no scroll bar
See also
GetVisible example (Page 1561)
WinCC: Scripting (VBS, ANSI-C, VBA)
1210 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetServerName
Function
Specifies the default setting for the process value to be displayed for OLE control and OLE
object.
Syntax
char* GetServerName(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Name of the object (OLE control and OLE object) under which it is registered in WINDOWS.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
See also
GetPictureName example (Page 1535)
GetSizeable
Function
Specifies for application or picture windows whether the window size can be changed.
Syntax
BOOL GetSizeable(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1211
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Application or picture window is sizeable
FALSE
Application or picture window is not sizeable
See also
GetVisible example (Page 1561)
GetSmallChange
Function
Specifies the number of steps for slider objects by which the slider is shifted by a mouse click.
Syntax
long int GetSmallChange(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Number of steps by which the slider is shifted by a mouse click
WinCC: Scripting (VBS, ANSI-C, VBA)
1212 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagPrefix
Function
Returns the tag prefix of a picture window.
Syntax
char* GetTagPrefix(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Tag prefix of the picture window.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
See also
GetTagPrefix example (Page 1554)
GetTrend
Function
When using bar objects, it specifies whether the trend display is activated.
Syntax
BOOL GetTrend(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1213
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Trend display is activated for a bar object
FALSE
Trend display is not activated for a bar object
See also
GetVisible example (Page 1561)
GetUpdateCycle
Function
Specifies the update cycle for the entire picture.
Syntax
long int GetUpdateCycle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the update cycle
See also
Structure definition LINKINFO (Page 1610)
WinCC: Scripting (VBS, ANSI-C, VBA)
1214 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetVisible
Function
Specifies whether the object is displayed.
Syntax
BOOL GetVisible(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Object is displayed
FALSE
Object is not displayed
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
See also
GetVisible example (Page 1561)
GetWindowBorder
Function
Specifies for application or picture windows whether the object is displayed with a border.
Syntax
BOOL GetWindowBorder(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1215
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Application or picture window is displayed with a border.
FALSE
Application or picture window is displayed without a border.
See also
GetVisible example (Page 1561)
GetZeroPointValue
Function
Specifies the absolute value of the zero point for bar objects.
Syntax
double GetZeroPointValue(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Absolute value of the zero point for the bar display
WinCC: Scripting (VBS, ANSI-C, VBA)
1216 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetZoom
Function
Specifies the scaling factor for picture windos.
Syntax
long int GetZoom(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Scaling factor of a picture window
ole_control
OLE_control - short description
The functions in the ole_Control group can only be used with OCX slider objects.
Various OCX slider object properties and settings can be modified or called in using these
functions.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetPosition
Function
Specifies the position of the slider for OCX slider objects.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1217
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
long int GetPosition(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Slider position of the OCX slider object as numeric value
See also
GetPosition example (Page 1536)
GetRangeMax
Function
Specifies the adjustment range "Max" for OCX slider objects.
Syntax
long int GetRangeMax(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Adjustment range "Max" of the OCX slider object as numeric value
See also
GetRangeMax example (Page 1538)
WinCC: Scripting (VBS, ANSI-C, VBA)
1218 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetRangeMin
Function
Specifies the adjustment range "Min" for OCX slider objects.
Syntax
long int GetRangeMin(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Adjustment range "Min" of the OCX slider object as numeric value
See also
GetRangeMin example (Page 1539)
pictures
Pictures - short description
Various properties of pictures of graphic objects and round buttons can be modified or called
in using the functions in the Pictures group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetPicDeactReferenced
Function
Specifies whether the picture for the "deactivated" status is referenced for round buttons.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1219
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL GetPicDeactReferenced(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
The picture assigned to the "deactivated" status was not stored in the object.
FALSE
The picture assigned to the "deactivated" status was stored in the object.
GetPicDeactTransparent
Function
Specifies the transparent color for the "deactivated" status of round buttons.
Syntax
long int GetPicDeactTransparent(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1220 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Numeric value defining the transparent color for the "deactivated" status
Note
This function only applies to Bitmap graphics (*.bmp).
See also
Color chart (Page 1597)
GetBackColor example (Page 1522)
GetPicDeactUseTransColor
Function
Specifies whether the transparent color for the "deactivated" status is used for round buttons.
Syntax
BOOL GetPicDeactUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Transparent color for "deactivated" status is used
FALSE
Transparent color for "deactivated" status is not used
GetPicDownReferenced
Function
Specifies whether the picture for the "On/pressed" status is referenced for round buttons.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1221
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL GetPicDownReferenced(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
The picture assigned to the "On/pressed" status was not stored in the object.
FALSE
The picture assigned to the "On/pressed" status was stored in the object.
GetPicDownTransparent
Function
Specifies the transparent color for the "On/pressed" status of round buttons.
Syntax
long int GetPicDownTransparent(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1222 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Numeric value defining the transparent color for the "On/pressed" status
Note
This function only applies to Bitmap graphics (*.bmp).
See also
Color chart (Page 1597)
GetPictureDown example (Page 1534)
GetPicDownUseTransColor
Function
Specifies whether the transparent color for the "On/pressed" status is used for round buttons.
Syntax
BOOL GetPicDownUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Transparent color for "On/pressed" status is used
FALSE
Transparent color for "On/pressed" status is not used
GetPicReferenced
Function
When using graphic objects, it specifies whether the picture is referenced.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1223
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL GetPicReferenced(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
The assigned picture was not stored in the object.
FALSE
The assigned picture was stored in the object.
GetPicTransColor
Function
Specifies the transparent color for a background picture for graphic objects.
Syntax
long int GetPicTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1224 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Numeric value defining the background picture of a graphic object
Note
This function only applies to Bitmap graphics (*.bmp).
See also
Color chart (Page 1597)
GetBackColor example (Page 1522)
GetPictureDeactivated
Function
Specifies the picture name for the "deactivated" status of round buttons.
Syntax
char* GetPictureDeactivated(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Picture name for "deactivated" status.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
Note
Bitmap files (*.bmp, *.dib) as well as metafiles (*.emf, *.wmf) can be integrated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1225
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetPictureDown
Function
Specifies the picture name for the "On/pressed" status of round buttons.
Syntax
char* GetPictureDown(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Picture name for the "On/pressed" status.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
Note
Bitmap files (*.bmp, *.dib) as well as metafiles (*.emf, *.wmf) can be integrated.
See also
GetPictureDown example (Page 1534)
GetPictureUp
Function
Specifies the picture name for the "Off/not pressed" status of round buttons.
WinCC: Scripting (VBS, ANSI-C, VBA)
1226 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
char* GetPictureUp(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Picture name for the "Off/not pressed" status.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
Note
Bitmap files (*.bmp, *.dib) as well as metafiles (*.emf, *.wmf) can be integrated.
See also
GetPictureUp example (Page 1536)
GetPicUpReferenced
Function
Specifies whether the picture for the "Off/not pressed" status is referenced for round buttons.
Syntax
BOOL GetPicUpReferenced(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1227
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
Return value
TRUE
The picture assigned to the "Off/not pressed" status was not stored in the object.
FALSE
The picture assigned to the "Off/not pressed" status was stored in the object.
GetPicUpTransparent
Function
Specifies the transparent color for the "Off/not pressed" status of round buttons.
Syntax
long int GetPicUpTransparent(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the transparent color for the "Off/not pressed" status
Note
This function only applies to Bitmap graphics (*.bmp).
See also
Color chart (Page 1597)
GetBackColor example (Page 1522)
WinCC: Scripting (VBS, ANSI-C, VBA)
1228 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetPicUpUseTransColor
Function
Specifies whether the transparent color for the "Off/not pressed" status is used for round
buttons.
Syntax
BOOL GetPicUpUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Transparent color for "Off/not pressed" status is used
FALSE
Transparent color for "Off/not pressed" status is not used
GetPicUseTransColor
Function
When using graphic objects, it specifies whether the transparent color is used for a background
picture.
Syntax
BOOL GetPicUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1229
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
Return value
TRUE
Transparent color is used for a background picture.
FALSE
Transparent color is not used for a background picture.
property
Property - short description
The properties of objects for which there are no direct functions can be modified or called in
using the functions in the Property group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetPropBOOL
Function
Specifies the current status of a property of the data type "BOOL".
Syntax
BOOL GetPropBOOL(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpszPropertyName)
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1230 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszPropertyName
Name of the object property
Return value
Value of the attribute in the data type "BOOL"
See also
GetPropBOOL example (Page 1537)
GetPropChar
Function
Specifies the current status of a property of the data type "char".
Syntax
char* GetPropChar(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpszPropertyName)
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lpszPropertyName
Name of the object property
Return value
Pointer to a character string containing the value of the object property.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1231
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
GetPropChar example (Page 1538)
GetPropDouble
Function
Specifies the current status of a property of the data type "double".
Syntax
double GetPropDouble(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpszPropertyName)
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lpszPropertyName
Name of the object property
Return value
Value of the attribute in the data type "double"
GetPropWord
Function
Specifies the current status of a property of the data type "long".
Syntax
long GetPropWord(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpszPropertyName)
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
1232 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
lpszPropertyName
Name of the object property
Return value
Value of the attribute in the type "long"
state
State - short description
The properties of status displays can be modified or called in using the functions in the State
group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
GetBasePicReferenced
Function
Specifies whether the basic picture is referenced for the status display.
Syntax
BOOL GetBasePicReferenced(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1233
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The basic picture was not stored in the object.
FALSE
The basic picture was stored in the object.
GetBasePicTransColor
Function
Specifies the transparent color of the basic picture for the status display.
Syntax
long int GetBasePicTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Transparent color of the basic picture as numeric value
Note
This function only applies to Bitmap graphics (*.bmp).
See also
Color chart (Page 1597)
GetBackColor example (Page 1522)
GetBasePicture
Function
Specifies the basic picture name fur the status display.
WinCC: Scripting (VBS, ANSI-C, VBA)
1234 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
char* GetBasePicture(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Basic picture name for the status display.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
GetBasePicUseTransColor
Function
When using the status display, it specifies whether the transparent color is used for the basic
picture.
Syntax
BOOL GetBasePicUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1235
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
Transparent color is used for the basic picture.
FALSE
Transparent color is not used for the basic picture.
GetFlashFlashPicture
Function
Specifies whether the flash picture of the status display is animated dynamically or statically.
Syntax
BOOL GetFlashFlashPicture(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
The flash picture is animated dynamically.
FALSE
The flash picture is animated statically.
GetFlashPicReferenced
Function
Specifies whether the flash picture is referenced for the status display.
Syntax
BOOL GetFlashPicReferenced(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
1236 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
The flash picture was not stored in the object.
FALSE
The flash picture was stored in the object.
GetFlashPicTransColor
Function
Specifies the transparent color of the flash picture for the status display.
Syntax
long int GetFlashPicTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Transparent color of the flash picture as numeric value
Note
This function only applies to Bitmap graphics (*.bmp).
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1237
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Color chart (Page 1597)
GetBackColor example (Page 1522)
GetFlashPicture
Function
Specifies the flash picture name for the status display.
Syntax
char* GetFlashPicture(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Flash picture name (file name of the graphic).
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
GetFlashPicUseTransColor
Function
When using the status display, it specifies whether the transparent color is used for the flash
picture.
Syntax
BOOL GetFlashPicUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
1238 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Transparent color is used for the flash picture.
FALSE
Transparent color is not used for the flash picture.
GetFlashRateFlashPic
Function
Specifies the flash frequency of the flash picture for the status display.
Syntax
long int GetFlashRateFlashPic(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Flash frequency of a flash picture as numeric value
Note
Since the flashing is performed by means of software engineering, the precise frequency is
both system-dependent and hardware-bound (number of objects, processor speed, RAM size,
update time etc.).
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1239
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Flash frequencies (Page 1595)
GetFlashRateFlashPic example (Page 1526)
GetIndex
Function
Specifies the index of the current position in a polygon or polygon line.
Specifies the index of the current field for check boxes and radio boxes.
Syntax
long int GetIndex(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Index of the current point or field
style
Style - short description
Various properties affecting the appearance of objects can be modified or called in using the
functions in the Style group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
WinCC: Scripting (VBS, ANSI-C, VBA)
1240 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetBackBorderWidth
Function
Specifies the frame width of 3D frames and slider objects.
Syntax
long int GetBackBorderWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value for the frame width of 3D frames and slider objects
See also
GetBorderStyle example (Page 1522)
GetBorderEndStyle
Function
Specifies the type of line end.
Syntax
long int GetBorderEndStyle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1241
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Type of line end as numeric value
See also
GetBorderStyle example (Page 1522)
Line end style (Page 1600)
GetBorderStyle
Function
Specifies the line or border style.
Syntax
long int GetBorderStyle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the line or border style
See also
GetBorderStyle example (Page 1522)
Line styles (Page 1600)
GetBorderWidth
Function
Specifies the line or border line width.
Syntax
long int GetBorderWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
1242 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Line or border line width as numeric value
See also
GetBorderStyle example (Page 1522)
GetBoxAlignment
Function
Specifies the arrangement of controls (left or right justified) in check boxes or radio boxes.
Syntax
long int GetBoxAlignment(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the arrangement of controls in check boxes or radio boxes
See also
GetBorderStyle example (Page 1522)
Text alignment (Page 1602)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1243
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetFillStyle
Function
Specifies the type of fill pattern.
Syntax
long int GetFillStyle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Type of fill pattern as numeric value
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
See also
Fill pattern (Page 1599)
GetFillStyle example (Page 1524)
GetFillStyle2
Function
Specifies the bar fill pattern for a bar graph.
Syntax
long int GetFillStyle2(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
1244 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Bar fill pattern as numeric value
See also
Fill pattern (Page 1599)
GetFillStyle example (Page 1524)
GetItemBorderStyle
Function
Specifies the dividing line style for the "text list" object.
Syntax
long int GetItemBorderStyle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Dividing line style for the "text list" object
See also
GetBorderStyle example (Page 1522)
Line styles (Page 1600)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1245
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetItemBorderWidth
Function
Specifies the dividing line width for the "text list" object.
Syntax
long int GetItemBorderWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
Numeric value defining the dividing line width for the "text list" object
See also
GetBorderStyle example (Page 1522)
GetPressed
Function
Specifies for buttons or round buttons whether the switch setting is "pressed" or "not pressed".
Syntax
BOOL GetPressed(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1246 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
Switch setting is "pressed"
FALSE
Switch setting is "not pressed"
GetToggle
Function
Specifies for buttons or round buttons whether the switch is latchable or not.
Syntax
BOOL GetToggle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Switch is latchable
FALSE
Switch is not latchable
GetWindowsStyle
Function
Specifies whether buttons are to be displayed in Windows style.
Syntax
BOOL GetWindowsStyle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1247
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
Button is displayed in the usual Windows fashion.
FALSE
The apperance of the button is defined by the user.
set
axes
Axes - short description
The functions in the Axes group can only be used with bar graph objects.
This function can be used to modify or query various bar graph object properties.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
SetAlignment
Function
When using bar objects, it indicates whether the text is to the right or left of the bar.
Syntax
BOOL SetAlignment(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bAlignment);
WinCC: Scripting (VBS, ANSI-C, VBA)
1248 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bAlignment
Text alignment
TRUE Text is to the right of the bar
FALSE Text is to the left of the bar
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetScaling example (Page 1574)
SetAxisSection
Function
When using bar objects, it specifies the axis section, i.e. the difference between the values of
two neighboring axis labels.
Syntax
BOOL SetAxisSection(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dAxisSection);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1249
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
dAxisSection
Axis section
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetScaling example (Page 1574)
SetExponent
Function
Sets the axis label display for bar objects (exponential/decimal).
Syntax
BOOL SetExponent(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bExponent);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bExponent
Axis labeling
TRUE Axis label in exponential form
FALSE Axis label in decimal form
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
1250 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
See also
SetScaling example (Page 1574)
SetLeftComma
Function
When using bar objects, it specifies the number of integers in the axis label.
Syntax
BOOL SetLeftComma(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lLeftComma);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lLeftComma
Number of integers
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetScaling example (Page 1574)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1251
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetLongStrokesBold
Function
When using bar objects, it specifies whether the main division lines are bold or regular.
Syntax
BOOL SetLongStrokesBold(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bLongStrokesBold);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bLongStrokesBold
Main division lines on the bar graph scale
TRUE bold
FALSE normal
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetScaling example (Page 1574)
SetLongStrokesOnly
Function
When using bar objects, it specifies whether intermediate or only main division lines are used
on the scale.
WinCC: Scripting (VBS, ANSI-C, VBA)
1252 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetLongStrokesOnly(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bLongStrokesOnly);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bLongStrokesOnly
Only main division lines yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetScaling example (Page 1574)
SetLongStrokesSize
Function
When using bar objects, it specifies the length of the main division lines on the bar graph scale.
Syntax
BOOL SetLongStrokesSize(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lLongStrokesSize);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1253
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
lLongStrokesSize
Length of the main division marks in pixels
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetScaling example (Page 1574)
SetRightComma
Function
When using bar objects, it specifies the number of decimal places in the axis label.
Syntax
BOOL SetRightComma(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lRightComma);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lRightComma
Number of decimal places
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
1254 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
See also
SetScaling example (Page 1574)
SetScaleTicks
Function
When using bar objects, it specifies the scale marks as number of scale sections. A scale
section is a part of the scale bounded by two main tick marks.
Syntax
BOOL SetScaleTicks(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lScaleTicks);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lScaleTicks
Number of scale sections
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
If the number of scale sections is given as 0, the bar object itself calculates a suitable scale
unit.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1255
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
SetScaling example (Page 1574)
SetScaling
Function
Switches the bar graph scale of bar objects on or off.
Syntax
BOOL SetScaling(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL bScaling);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bScaling
Scale on/off.
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetScaling example (Page 1574)
SetScalingType
Function
When using bar objects, it specifies the type of bar scaling.
WinCC: Scripting (VBS, ANSI-C, VBA)
1256 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetScalingType(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lScalingType);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lScalingType
Type of bar scaling as numeric value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Bar Scaling (Page 1595)
SetScaling example (Page 1574)
color
Color - short description
The various color properties of objects can be modified or queried using the functions in the
Color group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1257
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetBackColor
Function
Sets the background color of the object.
Syntax
BOOL SetBackColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBackColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBackColor
Background color of the object as a numeric value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
WinCC: Scripting (VBS, ANSI-C, VBA)
1258 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetBackColor2
Function
Sets the bar color for bar objects.
Syntax
BOOL SetBackColor2(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBackColor2);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBackColor2
Numeric value defining the bar color
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetBackColor3
Function
Sets the bar background color for bar objects.
Syntax
BOOL SetBackColor3(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBackColor3);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1259
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBackColor3
Numeric value defining the bar background color
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetBackColorBottom
Function
Sets the background color of the slider objects at the bottom right.
Syntax
BOOL SetBackColorBottom(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lBackColorBottom);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBackColorBottom
Numeric value defining the background color of slider objects
WinCC: Scripting (VBS, ANSI-C, VBA)
1260 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetBackColorTop
Function
Sets the background color of the slider objects at the top left.
Syntax
BOOL SetBackColorTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBackColorTop);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBackColorTop
Numeric value defining the background color of slider objects
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1261
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetBorderBackColor
Function
Sets the background color of the lines or borders.
Syntax
BOOL SetBorderBackColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBorderBackColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBorderBackColor
Background color of the lines or borders
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
WinCC: Scripting (VBS, ANSI-C, VBA)
1262 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetBorderColor
Function
Sets the color of the lines or borders.
Syntax
BOOL SetBorderColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBorderColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBorderColor
Numeric value defining the color of lines or borders
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetBorderColorBottom
Function
Sets the 3D border color at the bottom.
Syntax
BOOL SetBorderColorBottom(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lBorderColorBottom);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1263
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBorderColorBottom
Numeric value defining the 3-D border color at the bottom
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetBorderColorTop
Function
Sets the 3D border color at the top.
Syntax
BOOL SetBorderColorTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBorderColorTop);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBorderColorTop
Numeric value defining the 3-D border color at the top
WinCC: Scripting (VBS, ANSI-C, VBA)
1264 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetButtonColor
Function
Sets the button color of slider objects.
Syntax
BOOL SetButtonColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lButtonColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lButtonColor
Numeric value defining the button color of slider objects
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1265
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetColorBottom
Function
When using slider objects, it sets the color of the bottom limit.
Syntax
BOOL SetColorBottom(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lColorBottom);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lColorBottom
Numeric value defining the color of the bottom limit of slider objects
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
WinCC: Scripting (VBS, ANSI-C, VBA)
1266 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetColorTop
Function
When using slider objects, it sets the color of the top limit.
Syntax
BOOL SetColorTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lColorTop);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lColorTop
Numeric value defining the color of the top limit of slider objects
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetFillColor
Function
Sets the color of the fill pattern.
Syntax
BOOL SetFillColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lFillColor);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1267
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lFillColor
Numeric value of the fill color
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetForeColor
Function
Sets the font color.
Syntax
BOOL SetForeColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lForeColor);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
1268 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
lForeColor
Numeric value defining the font color
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetItemBorderBackColor
Function
Sets the background color of the separating line for the "text list" object.
Syntax
BOOL SetItemBorderBackColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
long int lItemBorderBackColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lItemBorderBackColor
Background color of the dividing line as a numeric value
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1269
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetItemBorderColor
Function
Sets the color of the dividing line for the "text list" object.
Syntax
BOOL SetItemBorderColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lItemBorderColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lItemBorderColor
Numeric value defining the dividing line color
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1270 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetScaleColor
Function
Sets the scale color for bar objects.
Syntax
BOOL SetScaleColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lScaleColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lScaleColor
Numeric value of the scale color for bar objects
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1271
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetSelBGColor
Function
Sets the background color of the selected entry for the "text list" object.
Syntax
BOOL SetSelBGColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lSelBGColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lSelBGColor
Numeric value defining the background color in the selected entry
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetSelTextColor
Function
Sets the font color of a selected entry for the "text list" object.
Syntax
BOOL SetSelTextColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lSelTextColor);
WinCC: Scripting (VBS, ANSI-C, VBA)
1272 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lSelTextColor
Numeric value defining the font color in the selected entry
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetTrendColor
Function
Sets the trend color for bar objects.
Syntax
BOOL SetTrendColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lTrendColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lTrendColor
Numeric value defining the trend color
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1273
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetUnselBGColor
Function
Sets the background color of non-selected entries for the "text list" object.
Syntax
BOOL SetUnselBGColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lUnselBGColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lUnselBGColor
Numeric value defining the background color for non-selected entries
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1274 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetUnselTextColor
Function
Sets the font color of non-selected entries for the "text list" object.
Syntax
BOOL SetUnselTextColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lUnselTextColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lUnselTextColor
Numeric value defining the font color for non-selected entries
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1275
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
fill
Fill - short description
The functions in the Fill group control the dynamic filling of objects.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
SetFilling
Function
Activates or deactivates dynamic filling with background color.
Syntax
BOOL SetFilling(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL bFilling);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bFilling
Dynamic filling with background color on/off
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetFilling example (Page 1566)
WinCC: Scripting (VBS, ANSI-C, VBA)
1276 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetFillingIndex
Function
Sets the fill level.
Syntax
BOOL SetFillingIndex(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lFillingIndex);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lFillingIndex
Fill level as a numeric value (0 - 100)
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetFillingIndex example (Page 1566)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1277
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
flash
Flash - short description
The various flashing properties can be modified or called in using the functions in the Flash
group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
SetBackFlashColorOff
Function
Sets the background flash color for the deactivated status.
Syntax
BOOL SetBackFlashColorOff(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lBackFlashColorOff);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBackFlashColorOff
Background flash color for the deactivated status as a numeric value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1278 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Color chart (Page 1597)
SetFlashBackColorOn example (Page 1567)
SetBackFlashColorOn
Function
Sets the background flash color for the activated status.
Syntax
BOOL SetBackFlashColorOn(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lBackFlashColorOn);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBackFlashColorOn
Background flash color for the activated status as a numeric value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetFlashBackColorOn example (Page 1567)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1279
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetBorderFlashColorOff
Function
Sets the border or line flashing color for the deactivated status.
Syntax
BOOL SetBorderFlashColorOff(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
long int lBorderFlashColorOff);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBorderFlashColorOff
Border or line flashing color for the deactivated status as a numeric value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetFlashBackColorOn example (Page 1567)
Color chart (Page 1597)
SetBorderFlashColorOn
Function
Sets the border or line flashing color for the activated status.
Syntax
BOOL SetBorderFlashColorOn(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
long int lBorderFlashColorOn);
WinCC: Scripting (VBS, ANSI-C, VBA)
1280 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBorderFlashColorOn
Border or line flashing color for the activated status as a numeric value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetFlashBackColorOn example (Page 1567)
SetFlashBackColor
Function
Activates or deactivates background flashing.
Syntax
BOOL SetFlashBackColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bFlashBackColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bFlashBackColor
Flashing background on/off
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1281
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetFlashBackColor example (Page 1567)
SetFlashBorderColor
Function
Activates or deactivates flashing of the border or line.
Syntax
BOOL SetFlashBorderColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bFlashBorderColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bFlashBorderColor
Flashing of the border or line on/off
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetFlashBackColor example (Page 1567)
WinCC: Scripting (VBS, ANSI-C, VBA)
1282 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetFlashForeColor
Function
Activates or deactivates font flashing.
Syntax
BOOL SetFlashForeColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bFlashForeColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bFlashForeColor
Flashing of the font on/off
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetFlashBackColor example (Page 1567)
SetFlashRateBackColor
Function
Sets the flash frequency of the background.
Syntax
BOOL SetFlashRateBackColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
long int lFlashRateBackColor);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1283
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lFlashRateBackColor
Flash frequency of the background
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Flash frequencies (Page 1595)
SetFlashBackColor example (Page 1567)
SetFlashRateBorderColor
Function
Sets the flash frequency of the line or border.
Syntax
BOOL SetFlashRateBorderColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
long int lFlashRateBorderColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lFlashRateBorderColor
Flash frequency of the line or border
WinCC: Scripting (VBS, ANSI-C, VBA)
1284 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Flash frequencies (Page 1595)
SetFlashBackColor example (Page 1567)
SetFlashRateForeColor
Function
Sets the flash frequency of the font.
Syntax
BOOL SetFlashRateForeColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
long int lFlashRateForeColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lFlashRateForeColor
Flash frequency of the font
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1285
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Flash frequencies (Page 1595)
SetFlashBackColor example (Page 1567)
SetForeFlashColorOff
Function
Sets the font flash color for the deactivated status.
Syntax
BOOL SetForeFlashColorOff(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lForeFlashColorOff);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lForeFlashColorOff
Font flash color for the deactivated status as a numeric value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetFlashBackColorOn example (Page 1567)
WinCC: Scripting (VBS, ANSI-C, VBA)
1286 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetForeFlashColorOn
Function
Sets the font flash color for the activated status.
Syntax
BOOL SetForeFlashColorOn(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lForeFlashColorOn);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lForeFlashColorOn
Font flash color for the activated status as a numeric value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetFlashBackColorOn example (Page 1567)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1287
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
focus
Focus - short description
Using the functions in the Focus group, it is possible to set the focus or poll which object has
the focus.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
Set_Focus
Function
Sets the focus on the specified object.
Syntax
BOOL Set_Focus(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetFocus example (Page 1568)
WinCC: Scripting (VBS, ANSI-C, VBA)
1288 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
font
Font - short description
The various properties affecting text can be modified or called in using the functions in the
Font group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
SetAlignmentLeft
Function
Sets the horizontal text alignment (left, centered, right).
Syntax
BOOL SetAlignmentLeft(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lAlignmentLeft);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lAlignmentLeft
Horizontal text alignment as a numeric value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1289
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Text alignment (Page 1602)
SetFontSize example (Page 1569)
SetAlignmentTop
Function
Sets the vertical text alignment (top, centered, bottom).
Syntax
BOOL SetAlignmentTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lAlignmentTop);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lAlignmentTop
Vertical text alignment as a numeric value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Text alignment (Page 1602)
SetFontSize example (Page 1569)
WinCC: Scripting (VBS, ANSI-C, VBA)
1290 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetFontBold
Function
Switches the bold font on or off.
Syntax
BOOL SetFontBold(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bFontBold);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bFontBold
Bold font on/off
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetFontBold example (Page 1568)
SetFontItalic
Function
Switches the italic font on or off.
Syntax
BOOL SetFontItalic(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bFontItalic);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1291
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bFontItalic
Italic font on/off
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetFontBold example (Page 1568)
SetFontName
Function
Sets a font.
Syntax
BOOL SetFontName(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, char*
szFontName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
szFontName
Pointer to name of font
WinCC: Scripting (VBS, ANSI-C, VBA)
1292 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetText example (Page 1583)
SetFontSize
Function
Sets the font size.
Syntax
BOOL SetFontSize(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lFontSize);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lFontSize
Font Size
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetFontSize example (Page 1569)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1293
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetFontUnderline
Function
Switches the underlined font on or off.
Syntax
BOOL SetFontUnderline(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bFontUnderline);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bFontUnderline
Underlined font on/off
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetFontBold example (Page 1568)
SetOrientation
Function
Defines the text orientation (vertical/horizontal).
Syntax
BOOL SetOrientation(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bOrientation);
WinCC: Scripting (VBS, ANSI-C, VBA)
1294 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bOrientation
Text orientation
TRUE vertical
FALSE Horizontal
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetFontBold example (Page 1568)
SetText
Function
Sets the value of the "text" property for objects like static text, check box or radio box.
Syntax
BOOL SetText(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, char* szText);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1295
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
szText
Pointer to a text
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
In case of check and radio boxes the element to be changed must be defined with the SetIndex
function before actually activating this function.
See also
SetText example (Page 1583)
geometry
Geometry - short description
The size, position and other geometrical properties of objects can be modified or called in using
the functions in the Geometry group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
SetActualPointLeft
Function
Sets the X value for the current point of a polygon or polygon line.
Syntax
BOOL SetActualPointLeft(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lActualPointLeft);
WinCC: Scripting (VBS, ANSI-C, VBA)
1296 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lActualPointLeft
X value for the current point of a polygon or polygon line
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The current point of the polygon can be set using the SetIndex function.
See also
SetLeft example (Page 1570)
SetActualPointTop
Function
Sets the Y value for the current point of a polygon or polygon line.
Syntax
BOOL SetActualPointTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lActualPointTop);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1297
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lActualPointTop
Y value for the current point of a polygon or polygon line
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
The current point of the polygon can be set using the SetIndex function.
See also
SetTop example (Page 1584)
SetBoxCount
Function
Sets the number of fields in a check box or radio box.
Syntax
BOOL SetBoxCount(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBoxCount);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBoxCount
Number of fields in a check box or radio box.
WinCC: Scripting (VBS, ANSI-C, VBA)
1298 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
SetDirection
Function
Sets the bar direction for bar objects.
Syntax
BOOL SetDirection(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lDirection);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lDirection
Numeric value defining the bar direction
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Bar direction (Page 1595)
SetTop example (Page 1584)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1299
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetEndAngle
Function
Sets the end angle of circle and ellipse segments and circle and elliptical arcs.
Syntax
BOOL SetEndAngle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lEndAngle);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lEndAngle
End angle of circle and ellipse segments as well as circle and ellipse arcs
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetTop example (Page 1584)
SetHeight
Function
Sets the height of the rectangle framing an object.
Syntax
BOOL SetHeight(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int lHeight);
WinCC: Scripting (VBS, ANSI-C, VBA)
1300 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lHeight
Height of the framing rectangle
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
See also
SetHeight example (Page 1569)
SetLeft
Function
Sets the X value of the upper left corner of the rectangle framing an object
Syntax
BOOL SetLeft(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int lLeft);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1301
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lLeft
X value of the upper left corner of the framing rectangle
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetLeft example (Page 1570)
SetPointCount
Function
Sets the number of corners of a polygon or in a polygon line.
Syntax
BOOL SetPointCount(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lPointCount);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lPointCount
Number of corner points
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1302 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
SetLeft example (Page 1570)
SetRadius
Function
Sets the radius of a circle, circle segment or arc.
Syntax
BOOL SetRadius(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int lRadius);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lRadius
Radius
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetHeight example (Page 1569)
SetRadiusHeight
Function
Sets the radius of an ellipse, ellipse segment or elliptical arc in vertical direction.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1303
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetRadiusHeight(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lRadiusHeight);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lRadiusHeight
Radius in vertical direction
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetHeight example (Page 1569)
SetRadiusWidth
Function
Sets the radius of an ellipse, ellipse segment or elliptical arc in horizontal direction.
Syntax
BOOL SetRadiusWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lRadiusWidth);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
1304 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
lRadiusWidth
Radius in horizontal direction
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetWidth example (Page 1584)
SetReferenceRotationLeft
Function
Sets the X value of the rotation reference (central axis about which the object can be rotated)
for lines, polygons and polylines.
Syntax
BOOL SetReferenceRotationLeft(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
long int lReferenceRotationLeft);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lReferenceRotationLeft
X value of the rotation reference
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1305
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetLeft example (Page 1570)
SetReferenceRotationTop
Function
Sets the Y value of the rotation reference (central axis about which the object can be rotated)
for lines, polygons and polylines.
Syntax
BOOL SetReferenceRotationTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
long int lReferenceRotationTop);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lReferenceRotationTop
Y value of the rotation reference
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1306 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
SetTop example (Page 1584)
SetRotationAngle
Function
Sets the angle of rotation about the central axis for lines, polygons and polylines.
Syntax
BOOL SetRotationAngle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lRotationAngle);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lRotationAngle
Angle of rotation
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetLeft example (Page 1570)
SetRoundCornerHeight
Function
Specifies the radius of the rounded corner of a rectangle vertically.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1307
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetRoundCornerHeight(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lRoundCornerHeight);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lRoundCornerHeight
Vertical radius
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetHeight example (Page 1569)
SetRoundCornerWidth
Function
Specifies the radius of the rounded corner of a rectangle horizontally.
Syntax
BOOL SetRoundCornerWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lRoundCornerWidth);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
1308 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
lRoundCornerWidth
Horizontal radius
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetWidth example (Page 1584)
SetStartAngle
Function
Sets the start angle of circle and ellipse segments and circle and elliptical arcs.
Syntax
BOOL SetStartAngle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lStartAngle);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lStartAngle
Starting angle
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1309
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
See also
SetHeight example (Page 1569)
SetTop
Function
Sets the Y value of the upper left corner of the rectangle framing an object.
Syntax
BOOL SetTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int lTop);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lTop
Y value of the upper left corner of the framing rectangle
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetTop example (Page 1584)
WinCC: Scripting (VBS, ANSI-C, VBA)
1310 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetWidth
Function
Sets the width of the rectangle framing an object.
Syntax
BOOL SetWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int lWidth);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lWidth
Width of the framing rectangle
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
See also
SetWidth example (Page 1584)
SetZeroPoint
Function
Sets the zero point for bar objects.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1311
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetZeroPoint(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lZeroPoint);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lZeroPoint
Zero point
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetTop example (Page 1584)
i_o
i_o - short description
The various properties affecting input and output values can be modified or called in using the
functions in the i_o group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
WinCC: Scripting (VBS, ANSI-C, VBA)
1312 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetAssumeOnExit
Function
Specifies for I/O fields whether the entered value is assumed upon exiting the field.
Syntax
BOOL SetAssumeOnExit(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bAssumeOnExit);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bAssumeOnExit
Value application upon exiting the field yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetHiddenInput example (Page 1569)
SetAssumeOnFull
Function
Specifies for I/O fields whether the entered value is assumed on completion of input.
Syntax
BOOL SetAssumeOnFull(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bAssumeOnFull);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1313
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bAssumeOnFull
Value application on completion of input yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetHiddenInput example (Page 1569)
SetBitNumber
Function
Sets the relevant bit in the output value for the "bit" list type.
Syntax
BOOL SetBitNumber(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBitNumber);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBitNumber
Relevant bit in the output value for the "bit" list type
WinCC: Scripting (VBS, ANSI-C, VBA)
1314 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
List types (Page 1601)
SetClearOnError
Function
Specifies for I/O fields whether deletion of the content in case of input errors is activated.
Syntax
BOOL SetClearOnError(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bClearOnError);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bClearOnError
Deletion of the entry in case of input errors yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetHiddenInput example (Page 1569)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1315
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetClearOnNew
Function
Specifies the deletion of the content in case of new inputs for I/O fields.
Syntax
BOOL SetClearOnNew(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bClearOnNew);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bClearOnNew
Deletion of content in case of new input yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetHiddenInput example (Page 1569)
SetHiddenInput
Function
Controls the hidden input for I/O fields.
Syntax
BOOL SetHiddenInput(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bHiddenInput);
WinCC: Scripting (VBS, ANSI-C, VBA)
1316 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bHiddenInput
Hidden input yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetHiddenInput example (Page 1569)
SetNumberLines
Function
Sets the number of visible lines lines for the "text list" object.
Syntax
BOOL SetNumberLines(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lNumberLines);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lNumberLines
Number of visible lines
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1317
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
If the amount of configured text is larger than the number of visible lines, the "text list" object
receives a vertical scroll bar.
SetOutputValueChar
Function
Sets a pointer to the output value for I/O fields
Syntax
BOOL SetOutputValueChar(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, char*
szOutputValueChar);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
szOutputValueChar
Pointer to the output value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1318 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetOutputValueDouble
Function
Sets the output value for I/O fields.
Syntax
BOOL SetOutputValueDouble(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
double dOutputValueDouble);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dOutputValueDouble
Output value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetOutputValueDouble example (Page 1571)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1319
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Limits
Limits - short description
The various properties affecting limit values can be modified or called in using the functions
in the Limits group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
SetAlarmHigh
Function
Sets the upper alarm limit for bar objects.
Syntax
BOOL SetAlarmHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dAlarmHigh);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dAlarmHigh
Upper alarm limit
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1320 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
SetAlarmHigh example (Page 1564)
SetAlarmLow
Function
Sets the lower alarm limit for bar objects.
Syntax
BOOL SetAlarmLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dAlarmLow);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dAlarmLow
Lower alarm limit
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetAlarmHigh example (Page 1564)
SetCheckAlarmHigh
Function
Controls the monitoring of the upper alarm limit for bar objects.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1321
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetCheckAlarmHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bCheckAlarmHigh);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bCheckAlarmHigh
Monitoring yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetCheckAlarmLow
Function
Controls the monitoring of the lower alarm limit for bar objects.
Syntax
BOOL SetCheckAlarmLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bCheckAlarmLow);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
1322 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
bCheckAlarmLow
Monitoring yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetCheckLimitHigh4
Function
Controls the monitoring of the upper limit value reserve 4 for bar objects.
Syntax
BOOL SetCheckLimitHigh4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bCheckLimitHigh4);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bCheckLimitHigh4
Monitoring yes/no
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1323
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetCheckLimitHigh5
Function
Controls the monitoring of the upper limit value reserve 5 for bar objects.
Syntax
BOOL SetCheckLimitHigh5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bCheckLimitHigh5);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bCheckLimitHigh5
Monitoring yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
WinCC: Scripting (VBS, ANSI-C, VBA)
1324 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetCheckLimitLow4
Function
Controls the monitoring of the lower limit value reserve 4 for bar objects.
Syntax
BOOL SetCheckLimitLow4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bCheckLimitLow4);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bCheckLimitLow4
Monitoring yes/no.
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetCheckLimitLow5
Function
Controls the monitoring of the lower limit value reserve 5 for bar objects.
Syntax
BOOL SetCheckLimitLow5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bCheckLimitLow5);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1325
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bCheckLimitLow5
Monitoring yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetCheckToleranceHigh
Function
Controls the monitoring of the upper tolerance limit for bar objects.
Syntax
BOOL SetCheckToleranceHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bCheckToleranceHigh);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bCheckToleranceHigh
Monitoring yes/no
WinCC: Scripting (VBS, ANSI-C, VBA)
1326 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetCheckToleranceLow
Function
Controls the monitoring of the lower tolerance limit for bar objects.
Syntax
BOOL SetCheckToleranceLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bCheckToleranceLow);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bCheckToleranceLow
Monitoring yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1327
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetCheckWarningHigh
Function
Controls the monitoring of the upper warning limit for bar objects.
Syntax
BOOL SetCheckWarningHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bCheckWarningHigh);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bCheckWarningHigh
Monitoring yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetCheckWarningLow
Function
Controls the monitoring of the lower warning limit for bar objects.
Syntax
BOOL SetCheckWarningLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bCheckWarningLow);
WinCC: Scripting (VBS, ANSI-C, VBA)
1328 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bCheckWarningLow
Monitoring yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetColorAlarmHigh
Function
Sets the bar color for bar objects upon reaching the upper alarm limit.
Syntax
BOOL SetColorAlarmHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lColorAlarmHigh);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lColorAlarmHigh
Numeric value defining the bar color
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1329
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetColorAlarmLow
Function
Sets the bar color for bar objects upon reaching the lower alarm limit.
Syntax
BOOL SetColorAlarmLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lColorAlarmLow);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lColorAlarmLow
Numeric value defining the bar color
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1330 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetColorLimitHigh4
Function
Sets the bar color for bar objects upon reaching the upper limit reserve 4.
Syntax
BOOL SetColorLimitHigh4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lColorLimitHigh4);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lColorLimitHigh4
Numeric value defining the bar color
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1331
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetColorLimitHigh5
Function
Sets the bar color for bar objects upon reaching the upper limit reserve 5.
Syntax
BOOL SetColorLimitHigh5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lColorLimitHigh5);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lColorLimitHigh5
Numeric value defining the bar color
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetColorLimitLow4
Function
Sets the bar color for bar objects upon reaching the lower limit reserve 4.
Syntax
BOOL SetColorLimitLow4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lColorLimitLow4);
WinCC: Scripting (VBS, ANSI-C, VBA)
1332 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lColorLimitLow4
Numeric value defining the bar color
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetColorLimitLow5
Function
Sets the bar color for bar objects upon reaching the lower limit reserve 5.
Syntax
BOOL SetColorLimitLow5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lColorLimitLow5);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lColorLimitLow5
Numeric value defining the bar color
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1333
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetColorToleranceHigh
Function
Sets the bar color for bar objects upon reaching the upper tolerance limit.
Syntax
BOOL SetColorToleranceHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lColorToleranceHigh);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lColorToleranceHigh
Numeric value defining the bar color
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1334 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetColorToleranceLow
Function
Sets the bar color for bar objects upon reaching the lower tolerance limit.
Syntax
BOOL SetColorToleranceLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lColorToleranceLow);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lColorToleranceLow
Numeric value defining the bar color
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1335
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetColorWarningHigh
Function
Sets the bar color for bar objects upon reaching the upper warning limit.
Syntax
BOOL SetColorWarningHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lColorWarningHigh);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lColorWarningHigh
Numeric value defining the bar color
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetColorWarningLow
Function
Sets the bar color for bar objects upon reaching the lower warning limit.
Syntax
BOOL SetColorWarningLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lColorWarningLow);
WinCC: Scripting (VBS, ANSI-C, VBA)
1336 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lColorWarningLow
Numeric value defining the bar color
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetLimitHigh4
Function
Sets the high limit value for reserve 4 for bar objects.
Syntax
BOOL SetLimitHigh4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dLimitHigh4);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dLimitHigh4
High limit value for reserve 4
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1337
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetAlarmHigh example (Page 1564)
SetLimitHigh5
Function
Sets the high limit value for reserve 5 for bar objects.
Syntax
BOOL SetLimitHigh5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dLimitHigh5);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dLimitHigh5
High limit value for reserve 5
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetAlarmHigh example (Page 1564)
WinCC: Scripting (VBS, ANSI-C, VBA)
1338 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetLimitLow4
Function
Sets the low limit value for reserve 4 for bar objects.
Syntax
BOOL SetLimitLow4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dLimitLow4);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dLimitLow4
Low limit value for reserve 4
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetAlarmHigh example (Page 1564)
SetLimitLow5
Function
Sets the low limit value for reserve 5 for bar objects.
Syntax
BOOL SetLimitLow5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dLimitLow5);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1339
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dLimitLow5
Low limit value for reserve 5
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetAlarmHigh example (Page 1564)
SetLimitMax
Function
Sets the high limit value for I/O fields.
Syntax
BOOL SetLimitMax(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dLimitMax);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dLimitMax
High limit value
WinCC: Scripting (VBS, ANSI-C, VBA)
1340 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetAlarmHigh example (Page 1564)
SetLimitMin
Function
Sets the low limit value for I/O fields.
Syntax
BOOL SetLimitMin(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dLimitMin);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dLimitMin
Lower limit
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetAlarmHigh example (Page 1564)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1341
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetMarker
Function
Controls the limit marker display for bar objects.
Syntax
BOOL SetMarker(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL bMarker);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bMarker
Limit marker on/off
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetToleranceHigh
Function
Sets the upper tolerance limit for bar objects.
Syntax
BOOL SetToleranceHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dToleranceHigh);
WinCC: Scripting (VBS, ANSI-C, VBA)
1342 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dToleranceHigh
Upper tolerance limit
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetAlarmHigh example (Page 1564)
SetToleranceLow
Function
Sets the lower tolerance limit for bar objects.
Syntax
BOOL SetToleranceLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dToleranceLow);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dToleranceLow
Lower tolerance limit
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1343
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetAlarmHigh example (Page 1564)
SetTypeAlarmHigh
Function
Specifies for bar objects whether the upper alarm limit is given in percentages or absolute
terms.
Syntax
BOOL SetTypeAlarmHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bTypeAlarmHigh);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bTypeAlarmHigh
Upper alarm limit
TRUE Specification in percent
FALSE Absolute specification
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1344 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
SetMarker example (Page 1571)
SetTypeAlarmLow
Function
Specifies for bar objects whether the lower alarm limit is given in percentages or absolute terms.
Syntax
BOOL SetTypeAlarmLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bTypeAlarmLow);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bTypeAlarmLow
Lower alarm limit
TRUE Specification in percent
FALSE Absolute specification
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1345
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetTypeLimitHigh4
Function
Specifies for bar objects whether the upper limit for reserve 4 is given in percentages or
absolute terms.
Syntax
BOOL SetTypeLimitHigh4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bTypeLimitHigh4);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bTypeLimitHigh4
High limit
TRUE Specification in percent
FALSE Absolute specification
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetTypeLimitHigh5
Function
Specifies for bar objects whether the upper limit for reserve 5 is given in percentages or
absolute terms.
WinCC: Scripting (VBS, ANSI-C, VBA)
1346 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetTypeLimitHigh5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bTypeLimitHigh5);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bTypeLimitHigh5
High limit
TRUE Specification in percent
FALSE Absolute specification
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetTypeLimitLow4
Function
Specifies for bar objects whether the lower limit for reserve 4 is given in percentages or absolute
terms.
Syntax
BOOL SetTypeLimitLow4(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bTypeLimitLow4);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1347
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bTypeLimitLow4
Low limit
TRUE Specification in percent
FALSE Absolute specification
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetTypeLimitLow5
Function
Specifies for bar objects whether the lower limit for reserve 5 is given in percentages or absolute
terms.
Syntax
BOOL SetTypeLimitLow5(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bTypeLimitLow5);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1348 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
bTypeLimitLow5
Low limit
TRUE Specification in percent
FALSE Absolute specification
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetTypeToleranceHigh
Function
Specifies for bar objects whether the high tolerance limit is given in percentages or absolute
terms.
Syntax
BOOL SetTypeToleranceHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bTypeToleranceHigh);
Parameter
lpszPictureName
Picture name
lpszObjectName
Object name
bTypeToleranceHigh
High tolerance limit
TRUE Specification in percent
FALSE Absolute specification
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1349
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetTypeToleranceLow
Function
Specifies for bar objects whether the lower tolerance limit is given in percentages or absolute
terms.
Syntax
BOOL SetTypeToleranceLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bTypeToleranceLow);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bTypeToleranceLow
Lower tolerance limit
TRUE Specification in percent
FALSE Absolute specification
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1350 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
SetMarker example (Page 1571)
SetTypeWarningHigh
Function
Specifies for bar objects whether the upper warning limit is given in percentages or absolute
terms.
Syntax
BOOL SetTypeWarningHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bTypeWarningHigh);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bTypeWarningHigh
Upper warning limit
TRUE Specification in percent
FALSE Absolute specification
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1351
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetTypeWarningLow
Function
Specifies for bar objects whether the lower warning limit is given in percentages or absolute
terms.
Syntax
BOOL SetTypeWarningLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bTypeWarningLow);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bTypeWarningLow
Lower warning limit
TRUE Specification in percent
FALSE Absolute specification
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetWarningHigh
Function
Sets the upper warning limit for bar objects.
WinCC: Scripting (VBS, ANSI-C, VBA)
1352 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetWarningHigh(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dWarningHigh);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dWarningHigh
Upper warning limit
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
SetWarningLow
Function
Sets the lower warning limit for bar objects.
Syntax
BOOL SetWarningLow(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dWarningLow);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1353
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
dWarningLow
Lower warning limit
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetMarker example (Page 1571)
link
Link - short description
A tag link property can be created or called in using the functions in the Link group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
SetLink
Function
Creating a tag connection of object properties
Syntax
BOOL SetLink(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpszPropertyName, LPLINKINFO *pLink);
WinCC: Scripting (VBS, ANSI-C, VBA)
1354 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lpszPropertyName
Name of the object property
pLink
Pointer to a structure of the type: LINKINFO
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Structure definition LINKINFO (Page 1610)
SetLink example (Page 1570)
miscs
Miscs - short description
The properties of objects can be modified or called in using the functions in the Miscs group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
SetAverage
Function
Controls the averaging of bar objects.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1355
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetAverage(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bAverage);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bAverage
Averaging yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetVisible example (Page 1584)
SetBoxType
Function
Specifies the field type (input field, output field, input/output field) for an I/O object.
Syntax
BOOL SetBoxType(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBoxType);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
1356 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
lBoxType
Field type
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
I/O field, field type (Page 1597)
SetColorChangeType
Function
When using bar objects, it defines whether the color change upon reaching a limit value only
affects a bar segment or the entire bar.
Syntax
BOOL SetColorChangeType(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bColorChangeType);
Parameter
lpszPictureName
Picture name
lpszObjectName
Object name
bColorChangeType
Type of color change
TRUE Color change applies to a segment
FALSE Color change applies to the entire bar
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1357
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetVisible example (Page 1584)
SetCursorControl
Function
Sets the cursor control for I/O fields.
Syntax
BOOL SetCursorControl(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bCursorControl);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bCursorControl
Cursor control on/off
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1358 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
SetVisible example (Page 1584)
SetCursorMode
Function
Sets the cursor control for pictures.
Syntax
BOOL SetCursorMode(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bCursorMode);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bCursorMode
Cursor Mode
TRUE Tab order cursor
FALSE Alpha-Cursor
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Example - SetCursorMode (Page 1566)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1359
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetEditAtOnce
Function
Specifies whether the "Immediate input" property is activated for I/O fields.
Syntax
BOOL SetEditAtOnce(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bEditAtOnce);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bEditAtOnce
Immediate input yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetVisible example (Page 1584)
SetExtendedOperation
Function
Controls the "Extended operation" property of slider objects.
Syntax
BOOL SetExtendedOperation(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bExtendedOperation);
WinCC: Scripting (VBS, ANSI-C, VBA)
1360 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bExtendedOperation
Extended operation yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetVisible example (Page 1584)
SetHysteresis
Function
When using bar objects, it specifies whether the display appears with or without hysteresis.
Syntax
BOOL SetHysteresis(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bHysteresis);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bHysteresis
Display with/without hysteresis
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1361
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetVisible example (Page 1584)
SetHysteresisRange
Function
Sets the hysteresis value in the display for bar objects.
Syntax
BOOL SetHysteresisRange(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dHysteresisRange);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dHysteresisRange
Hysteresis value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1362 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetMax
Function
Sets the maximum value for bar and slider objects.
Syntax
BOOL SetMax(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double dMax);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dMax
Maximum value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
SetMin
Function
Sets the minimum value for bar and slider objects.
Syntax
BOOL SetMin(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double dMin);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1363
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
dMin
Minimum value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
SetOffsetLeft
Function
Sets the horizontal picture distance from the left window border for picture windows.
Syntax
BOOL SetOffsetLeft(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lOffsetLeft);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lOffsetLeft
Picture distance
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1364 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetOffsetTop
Function
Sets the vertical picture distance from the upper window border for picture windows.
Syntax
BOOL SetOffsetTop(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lOffsetTop);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lOffsetTop
Picture distance
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
SetOperation
Function
Controls the operability of the objects.
Syntax
BOOL SetOperation(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bOperation);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1365
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bOperation
Object operable, yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
If the function is called for the picture object, set the parameter lpszObjectName = NULL.
See also
SetVisible example (Page 1584)
SetOperationMessage
Function
Controls the output of a message when operating the objects "I/O field", "Check box", "Radio
box" and "Slider".
Syntax
BOOL SetOperationMessage(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bOperationMessage);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
1366 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
bOperationMessage
Message output for yes/no operation
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetVisible example (Page 1584)
SetOperationReport
Function
Controls the logging of the operating reason for all objects except application and picture
windows and OLE control.
Syntax
BOOL SetOperationReport(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bOperationReport);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bOperationReport
Logging operating reason yes/no
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1367
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
If the function is called for the picture object, set the parameter lpszObjectName = NULL.
See also
SetVisible example (Page 1584)
SetPasswordLevel
Function
Defines the authorization level for operating objects for all objects except application and
picture windows and OLE control.
Syntax
BOOL SetPasswordLevel(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lPasswordLevel);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lPasswordLevel
Authorization level
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
1368 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
SetPictureName
Function
Sets the name of the picture, which should be shown in a picture window or in a graphic object.
Syntax
BOOL SetPictureName(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, char*
szPictureName);
Parameters
lpszPictureName
Picture name
lpszObjectName
Name of the picture window or graphic object
szPictureName
Pointer to the picture name
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetPictureName example (Page 1572)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1369
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetProcess
Function
Specifies the default setting of the value to be displayed for bar and slider objects.
Sets the selected fields for check boxes and radio boxes.
Syntax
BOOL SetProcess(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dProcess);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dProcess
● In case of bar and slider objects, this value is used in Runtime when the associated tag
cannot be connected or updated when a picture is started.
● For check boxes and radio boxes the selected fields are specified. In the 32-bit word each
field is represented by a bit (field 1 corrsponds to the bit value 0). Selected fields are marked
by a set bit. Non-existing are assigned 0.
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
SetSmallChange
Function
Sets the number of steps for slider objects by which the slider is shifted by a mouse click.
Syntax
BOOL SetSmallChange(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lSmallChange);
WinCC: Scripting (VBS, ANSI-C, VBA)
1370 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lSmallChange
Number of setting steps
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
SetTagPrefix
Function
This function sets the tag prefix of a picture window:
In a picture window the "temperature" tag is requested on an object. If a "Motor1." tag prefix
is assigned to the picture window, the tag "Motor1.Temperature" is requested.
The setting of the tag prefix only becomes effective when newly supplying the picture name.
This means you must either set the prefix before picture selection or newly supply the picture
name if the picture is not changed.
Syntax
BOOL SetTagPrefix(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,char*
szTagPrefix);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1371
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
szTagPrefix
Tag prefix to be set
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
If the tag prefix is set for a picture window, the tag prefix is added to all tags contained in the
picture to be displayed. This also applies if the request takes place in a function. If a tag needs
to be read without the tag prefix, you must add "@NOTP::" to the tag name.
Using a tag prefix greatly simplifies the picture module technology.
See also
SetTagPrefix example (Page 1579)
SetTrend
Function
Controls the trend display for bar objects.
Syntax
BOOL SetTrend(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL bTrend);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bTrend
Trend display yes/no
WinCC: Scripting (VBS, ANSI-C, VBA)
1372 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetVisible example (Page 1584)
SetVisible
Function
Controls the display of an object.
Syntax
BOOL SetVisible(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL bVisible);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bVisible
Object display yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
NULL.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1373
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
SetVisible example (Page 1584)
SetZeroPointValue
Function
Sets the absolute value of the zero point for bar objects.
Syntax
BOOL SetZeroPointValue(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, double
dZeroPointValue);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
dZeroPointValue
Absolute value of the zero point
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
SetZoom
Function
Sets the scaling factor for a picture window.
Syntax
BOOL SetZoom(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int lZoom);
WinCC: Scripting (VBS, ANSI-C, VBA)
1374 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lZoom
Scaling factor
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
ole_control
OLE_control - short description
The functions in the ole_Control group can only be used with OCX slider objects.
Various OCX slider object properties and settings can be modified or called in using these
functions.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
SetPosition
Function
Sets the slider position of the OCX slider object.
Syntax
BOOL SetPosition(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lPosition);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1375
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lPosition
Slider position of the OCX slider object
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetPosition example (Page 1573)
SetRangeMax
Function
Defines the adjustment range "Max" of the OCX slider object.
Syntax
BOOL SetRangeMax(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lRangeMax);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lRangeMax
Adjustment range "Max" of the OCX slider object
WinCC: Scripting (VBS, ANSI-C, VBA)
1376 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetRangeMax example (Page 1574)
SetRangeMin
Function
Defines the adjustment range "Min" of the OCX slider object.
Syntax
BOOL SetRangeMin(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lRangeMin);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lRangeMin
Adjustment range "Min" of the OCX slider object
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetRangeMin example (Page 1574)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1377
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
pictures
Pictures - short description
Various properties of pictures of graphic objects and round buttons can be modified or called
in using the functions in the Pictures group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
SetPicDeactTransparent
Function
Sets the transparent color for the "deactivated" status of a round button.
Syntax
BOOL SetPicDeactTransparent(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
long int lPicDeactTransparent);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lPicDeactTransparent
Transparent color for "deactivated" status
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
1378 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
This function only applies to Bitmap graphics (*.bmp).
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetPicDeactUseTransColor
Function
Controls the transparent color for the "deactivated" status of a round button.
Syntax
BOOL SetPicDeactUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bPicDeactUseTransColor);
Parameter
lpszPictureName
Picture name
lpszObjectName
Object name
bPicDeactUseTransColor
Transparent color yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1379
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetPicDownTransparent
Function
Sets the transparent color for the "On/pressed" status of a round button.
Syntax
BOOL SetPicDownTransparent(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
long int lPicDownTransparent);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lPicDownTransparent
Transparent color for "On/pressed" status
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
This function only applies to Bitmap graphics (*.bmp).
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetPicDownUseTransColor
Function
Controls the transparent color for the "On/pressed" status of a round button.
WinCC: Scripting (VBS, ANSI-C, VBA)
1380 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetPicDownUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bPicDownUseTransColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bPicDownUseTransColor
Transparent color yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
SetPicTransColor
Function
Sets the transparent color of the background picture of a graphic object.
Syntax
BOOL SetPicTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lPicTransColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lPicTransColor
Transparent color of the background picture
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1381
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
This function only applies to Bitmap graphics (*.bmp).
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetPictureDeactivated
Function
Specifies the picture name for the "deactivated" status of a round button.
Syntax
BOOL SetPictureDeactivated(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, char*
szPictureDeactivated);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
szPictureDeactivated
Picture name for "deactivated" status
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
1382 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
Bitmap files (*.bmp, *.dib) as well as metafiles (*.emf, *.wmf) can be integrated.
See also
SetPictureDown example (Page 1572)
SetPictureDown
Function
Specifies the picture name for the "On/pressed" status of a round button.
Syntax
BOOL SetPictureDown(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, char*
szPictureDown);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
szPictureDown
Picture name for "On/pressed" status
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
Bitmap files (*.bmp, *.dib) as well as metafiles (*.emf, *.wmf) can be integrated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1383
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
SetPictureDown example (Page 1572)
SetPictureUp
Function
Specifies the picture name for the "Off/not pressed" status of a round button.
Syntax
BOOL SetPictureUp(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, char*
szPictureUp);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
szPictureUp
Picture name for "Off/not pressed" status
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
Bitmap files (*.bmp, *.dib) as well as metafiles (*.emf, *.wmf) can be integrated.
See also
SetPictureUp example (Page 1572)
WinCC: Scripting (VBS, ANSI-C, VBA)
1384 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetPicUpTransparent
Function
Sets the transparent color for the "Off/not pressed" status of a round button.
Syntax
BOOL SetPicUpTransparent(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lPicUpTransparent);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lPicUpTransparent
Transparent color for "Off/not pressed" status
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
This function only applies to Bitmap graphics (*.bmp).
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetPicUpUseTransColor
Function
Controls the transparent color for the "Off/not pressed" status of a round button.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1385
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetPicUpUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bPicUpUseTransColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bPicUpUseTransColor
Transparent color yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
SetPicUseTransColor
Function
Controls the transparent color of the background picture of a graphic object.
Syntax
BOOL SetPicUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bPicUseTransColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bPicUseTransColor
Transparent color yes/no
WinCC: Scripting (VBS, ANSI-C, VBA)
1386 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
property
Property - short description
The properties of objects for which there are no direct functions can be modified or called in
using the functions in the Property group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
SetPropBOOL
Function
Sets a property with the value "bValue".
Syntax
BOOL SetPropBOOL(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpszPropertyName, BOOL bValue)
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lpszPropertyName
Name of the object property
bValue
Value in BOOL data format
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1387
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
If the function is called for the picture object, set the parameter lpszObjectName = NULL.
See also
SetPropBOOL example (Page 1573)
SetPropChar
Function
Sets a property with the value the pointer "szValue" points to.
Syntax
BOOL SetPropChar(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpszPropertyName, char* szValue)
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lpszPropertyName
Name of the object property
szValue
Pointer to the value
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
1388 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
If the function is called for the picture object, set the parameter lpszObjectName = NULL.
See also
GetPropChar example (Page 1538)
SetPropDouble
Function
Sets a property with the value "dValue".
Syntax
BOOL SetPropDouble(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpszPropertyName, double dValue)
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lpszPropertyName
Name of the object property
dValue
Value in "double" data format
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1389
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
If the function is called for the picture object, set the parameter lpszObjectName = NULL.
SetPropWord
Function
Sets a property with the value "IValue".
Syntax
BOOL SetPropWord(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, LPCTSTR
lpszPropertyName, long lValue)
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lpszPropertyName
Name of the object property
lValue
Value in "long" data format
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
If the function is called for the picture object, set the parameter lpszObjectName = NULL.
WinCC: Scripting (VBS, ANSI-C, VBA)
1390 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
state
State - short description
The properties of status displays can be modified or called in using the functions in the State
group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
SetBasePicTransColor
Function
Sets the transparent color of the basic picture for the status display.
Syntax
BOOL SetBasePicTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lBasePicTransColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBasePicTransColor
Transparent color of the basic picture
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1391
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
This function only applies to Bitmap graphics (*.bmp).
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetBasePicUseTransColor
Function
Controls the transparent color of the basic picture for the status display.
Syntax
BOOL SetBasePicUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bBasePicUseTransColor);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bBasePicUseTransColor
Transparent color yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1392 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetFlashFlashPicture
Function
Specifies whether the flash picture of the status display is animated dynamically or statically.
Syntax
BOOL SetFlashFlashPicture(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bFlashFlashPicture);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bFlashFlashPicture
Type of flash picture
TRUE dynamically animated flash picture
FALSE statically animated flash picture
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
SetFlashPicTransColor
Function
Sets the transparent color of the flash picture for a status display.
Syntax
BOOL SetFlashPicTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lFlashPicTransColor);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1393
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lFlashPicTransColor
Transparent color of the flash picture
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
This function only applies to Bitmap graphics (*.bmp).
See also
Color chart (Page 1597)
SetBackColor example (Page 1564)
SetFlashPicUseTransColor
Function
Controls the transparent color of the flash picture for a status display.
Syntax
BOOL SetFlashPicUseTransColor(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName,
BOOL bFlashPicUseTransColor);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
1394 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
bFlashPicUseTransColor
Transparent color yes/no
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
SetFlashRateFlashPic
Function
Sets the flash frequency of the flash picture for a status display.
Syntax
BOOL SetFlashRateFlashPic(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lFlashRateFlashPic);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lFlashRateFlashPic
Flash frequency of the flash picture
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1395
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
Note
Since the flashing is performed by means of software engineering, the precise frequency is
both system-dependent and hardware-bound (number of objects, processor speed, RAM size,
update time etc.).
See also
Flash frequencies (Page 1595)
SetFlashRateFlashPic example (Page 1568)
SetIndex
Function
Sets the index of a polygon or polyline thus defining the current object point.
Syntax
BOOL SetIndex(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int lIndex);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lIndex
Index value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1396 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
style
Style - short description
Various properties affecting the appearance of objects can be modified or called in using the
functions in the Style group.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
SetBackBorderWidth
Function
Sets the frame width of 3D frames and slider objects.
Syntax
BOOL SetBackBorderWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long
int lBackBorderWidth);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBackBorderWidth
Frame width in pixels
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1397
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
SetBorderStyle example (Page 1565)
SetBorderEndStyle
Function
Sets the type of line end.
Syntax
BOOL SetBorderEndStyle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBorderEndStyle);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBorderEndStyle
Type of line end as numeric value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Line end style (Page 1600)
SetBorderEndStyle example (Page 1564)
SetBorderStyle
Function
Sets the line or border style.
WinCC: Scripting (VBS, ANSI-C, VBA)
1398 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetBorderStyle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBorderStyle);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBorderStyle
Numeric value defining the line or border style
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Line styles (Page 1600)
SetBorderStyle example (Page 1565)
SetBorderWidth
Function
Sets the line or border line width.
Syntax
BOOL SetBorderWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBorderWidth);
Parameters
lpszPictureName
Picture name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1399
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lpszObjectName
Object name
lBorderWidth
Line width or border line width
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetBorderStyle example (Page 1565)
SetBoxAlignment
Function
Defines the arrangement of controls (left or right justified) in check boxes or radio boxes.
Syntax
BOOL SetBoxAlignment(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lBoxAlignment);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lBoxAlignment
Arrangement of controls
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
1400 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
See also
Element alignment in check boxes and radio boxes (Page 1597)
SetBorderStyle example (Page 1565)
SetFillStyle
Function
Sets the type of fill pattern.
Syntax
BOOL SetFillStyle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lFillStyle);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lFillStyle
Type of fill pattern as numeric value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
Note
If the function is called in relation to the entire picture, set the parameter lpszObjectName =
ZERO.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1401
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Fill pattern (Page 1599)
SetFillStyle example (Page 1567)
SetFillStyle2
Function
Sets the bar fill pattern for a bar graph.
Syntax
BOOL SetFillStyle2(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lFillStyle2);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lFillStyle2
Bar fill pattern as numeric value
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Fill pattern (Page 1599)
SetFillStyle example (Page 1567)
WinCC: Scripting (VBS, ANSI-C, VBA)
1402 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetItemBorderStyle
Function
Sets the dividing line style for the "text list" object.
Syntax
BOOL SetItemBorderStyle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lItemBorderStyle);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lItemBorderStyle
Numeric value defining the dividing line style
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Line styles (Page 1600)
SetBorderStyle example (Page 1565)
SetItemBorderWidth
Function
Sets the dividing line width for the "text list" object.
Syntax
BOOL SetItemBorderWidth(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, long int
lItemBorderWidth);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1403
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
lItemBorderWidth
Numeric value defining the dividing line width
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
SetBorderStyle example (Page 1565)
SetPressed
Function
Specifies for buttons or round buttons whether the switch setting is "pressed" or "not pressed".
Syntax
BOOL SetPressed(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bPressed);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
WinCC: Scripting (VBS, ANSI-C, VBA)
1404 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
bPressed
Switch setting of the button
TRUE Switch setting "pressed"
FALSE Switch setting "not pressed"
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
SetToggle
Function
Specifies for buttons or round buttons whether the switch is latchable or not.
Syntax
BOOL SetToggle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL bToggle);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bToggle
Switch latchable/not latchable
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1405
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetWindowsStyle
Function
Specifies whether buttons are to be displayed in Windows style.
Syntax
BOOL SetWindowsStyle(LPCTSTR lpszPictureName, LPCTSTR lpszObjectName, BOOL
bWindowStyle);
Parameters
lpszPictureName
Picture name
lpszObjectName
Object name
bWindowStyle
"Windows style" on/off
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
OpenHomePicture
Function
Opens the entered start picture.
Syntax
BOOL OpenHomePicture();
Return value
TRUE
The function has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
1406 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
OpenNextPicture
Function
WinCC saves the names of the pictures opened by the user during runtime as well as the
sequence in which these pictures were opened.
The maximum number of picture names saved this way can be set in the WinCC Explorer in
the computer properties on the "Graphics Runtime" tab under "picture buffer size".
The OpenNextPicture function now opens the picture which was opened before the last call
of OpenPrevPicture.
Syntax
BOOL OpenNextPicture();
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
OpenPrevPicture
Function
WinCC saves the names of the pictures opened by the user during runtime as well as the
sequence in which these pictures were opened.
The maximum number of picture names saved this way can be set in the WinCC Explorer in
the computer properties on the "Graphics Runtime" tab under "picture buffer size".
The OpenPrevPicture function now opens the picture which was opened before the currently
open picture.
Syntax
BOOL OpenPrevPicture();
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1407
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
OpenStoredPicture
Function
Opens the picture saved with the StorePicture function.
Syntax
BOOL OpenStoredPicture();
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
StorePicture
Function
Saves the current picture which can then be opened with the OpenStoredPicture function.
Syntax
BOOL StorePicture();
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1408 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2.15.3.5 tag
tag - short description
Tags can be set or called in using the functions from the tag group.
GetTag or GetTagWait?
Process tags that are called with GetTag are put in an image. Since updating and reading the
image is done in two separate procedures, the GetTag call is not directly influenced by the
coupling. It can therefore be executed quicker and more independently than a GetTagWait
retrieval.
With GetTagWait, process tags that have been requested are not accepted in the image. A
GetTagWait retrieval reads the value explicitly from the AS. This always includes the send and
return path through the coupling and the response time of the AS. During this runtime, the
processing of the C actions is blocked and the time required for the retrieval cannot be
estimated. If multiple tags are read, the time is added.
A GetTagWait call is required if
● fast write/read procedures are to be synchronized
● a value is read explicitly from the AS
● or a registration is to be avoided in the image deliberately.
The GetTagWait call is to be avoided in cyclic C-Actions, this is the main reason for
performance problems.
SetTag or SetTagWait?
The SetTag retrieval distributes a write job without waiting for confirmation from the AS.
The SetTagWait retrieval distributes a write job and waits for confirmation from the AS. This
always includes the send and return path through the coupling and the response time of the
AS. During this runtime, the processing of the C actions is blocked and the time required for
the retrieval cannot be estimated. If multiple tags are written, the time is added.
A SetTagWait call is set to guarantee that the value has been written before the C-Action is
processed any further. The SetTagWait call in cyclic C actions is to be avoided.
Note
The difference between GetTag and GetTagWait also exists for internal tags. The difference
is not quite so serious here however, since no coupling comes into play. To synchronize fast
write/read procedures, the respective wait function is to be used with internal tags as well.
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1409
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
get
Functionality of the GetTag functions
GetTagXXX
By calling the function the tag is logged on and, from that moment, polled cyclically from the
AS. The cycle for the registration depends on the trigger (see following description). For
GetTagXXX calls, the value that is available in WinCC is sent. For Close Picture, the tag actions
are ended again.
The call is marked by the following:
● The value is read from the tag image by WinCC.
● The call is faster in comparison to GetTagXXXWait (except for the first call which generally
takes longer because the value from the PLC must be read out and logged on).
● The duration of the call does not depend on the bus-load or on the AS.
● The function does not deliver any information on the status of the tags
Note
If a tag is requested in a Global Script action, it remains registered throughout the enter
Runtime of WinCC.
In Callback functions, the respective GetTagXXXWait function must be used.
Behavior in actions with tag trigger (recommended):
All of the tags contained in the tag trigger are already known with Open Picture and are
registered with the defined monitoring time.
Since all tags are requested at once, the best possible optimization can be targeted from the
channel. If a tag is requested with GetTagXXX() within a C-Action, which is contained in the
trigger, the value already exists and is sent directly to the call (high-performance).
Registering tags in actions with tag trigger
WinCC: Scripting (VBS, ANSI-C, VBA)
1410 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
As the tags are already known when the picture is selected, they can be transmitted in a job
to the Data Manager and so be registered collectively to the channel.
Note
If a tag is requested, which is not in the trigger, then the behavior is the same as with the default
trigger.
Behavior in actions with default trigger:
tags are registered with half of the cycle time with the first call. For every other call, the value
is present.
Registering tags in actions with default trigger and event trigger
Only when the individual actions are executed is it identified which tags are needed in the
picture. As a result, the tags are registered to the channel in a large number of single jobs.
When a picture with cyclic actions is selected, the continual reorganization may place a heavy
strain on communications.
Example: The channel supports custom cycle creation. Usually cycles are created by the
channel directly from the AS. The resources for these cycles are limited by the AS. As a result,
the channel stops the current jobs for this cycle and reconfigures the cycle on the AS.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1411
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Behavior in event triggered actions:
The tag is registered in the "upon change" mode with the first call. Process tags that are
registered in the "upon change" mode correspond with a cyclic read job with a cycle time of
1s.
Note
If a value is requested by GetTagXXX() by a mouse click for example, the tag is accepted in
the tag image. The tag is requested cyclically from the AS as of this point in time and therefore
increases the basic load.
To avoid this increase in basic loading, the value can be requested by GetTagXXXWait(). The
call GetTagXXXWait() causes a higher communication load one time but the tag is not added
to the tag image.
GetTagXXXWait
The function returns the current value. The tag is not registered cyclically, the value is
requested from the AS one time only.
The call is marked by the following:
● The value is read explicitly from the AS.
● The call, compared with GetTagXXX, takes longer.
WinCC: Scripting (VBS, ANSI-C, VBA)
1412 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
● The duration of the call does not depend on the bus-load or on the AS.
● The function does not deliver any information on the status of the tags.
GetTagXXXState
The function GetTagXXXState has the same features as GetTagXXX, it also sends the function
information on the status of the tags. Since the status is always delivered internally, there is
no performance difference to GetTagXXX.
GetTagXXXStateWait
The function GetTagXXXStateWait has the same features as GetTagXXXWait, additionally it
sends the function information on the status of the tags. Since the status is always delivered
internally, there is no performance difference to GetTagXXXWait.
The difference between functions GetTagXXXStateWait and GetTagXXXState corresponds
with the difference between GetTagXXXWait and GetTagXXX. Since the value is explicitly
read from the AS for process tags, the value and the status can be more current than for
GetTagXXXState.
GetTagXXXStateQC
The function GetTagXXXStateQC has the same features as GetTagXXXState. The function
also delivers information on the quality code of the tag.
GetTagXXXStateQCWait
The function GetTagXXXStateQCWait has the same features as GetTagXXXStateWait. The
function also delivers information on the quality code of the tag.
GetTagMultiWait
The function GetTagMultiWait has the same features as GetTagXXXWait. However, it allows
the request for more tags in a job. Therefore, the read requests in the direction of the AS can
be optimized in most cases so that only one request will be given to the AS.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1413
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagMultiStateWait
The function GetTagMultiStateWait has the same features as GetTagMultiWait, additionally it
sends the function information on the statuses of the tags.
GetTagMultiStateQCWait
The function GetTagMultiStateQCWait has the same features as GetTagMultiStateWait. The
function also delivers information on the quality codese of the tags.
state
wait
getTagBitStateWait
Function
Determines the value of a tag of data type "Binary tag". The value is read explicitly from the
AS. The status of the tag is also returned.
Syntax
BOOL GetTagBitStateWait(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "BOOL"
See also
Tag statuses (Page 1603)
GetTagBitStateWait example (Page 1545)
Functionality of the GetTag functions (Page 1410)
WinCC: Scripting (VBS, ANSI-C, VBA)
1414 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagByteStateWait
Function
Determines the value of a tag of data type "unsigned 8 bit". The value is read explicitly from
the AS. The status of the tag is also returned.
Syntax
BYTE GetTagByteStateWait(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "BYTE"
See also
Tag statuses (Page 1603)
GetTagWordStateWait example (Page 1559)
Functionality of the GetTag functions (Page 1410)
GetTagCharStateWait
Function
Determines the value of a tag of data type "8-bit text tag" or "16-bit text tag". The value is read
explicitly from the AS. The status of the tag is also returned.
Syntax
char* GetTagCharStateWait(Tag Tag_Name, PDWORD lp_dwstate);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1415
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Pointer to the value of the tag in data type "char".
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
See also
Functionality of the GetTag functions (Page 1410)
Tag statuses (Page 1603)
Beispiel GetTagCharStateWait (Page 1548)
GetTagDoubleStateWait
Function
Determines the value of a tag of data type "64-bit floating point value". The value is read
explicitly from the AS. The status of the tag is also returned.
Syntax
double GetTagDoubleStateWait(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
WinCC: Scripting (VBS, ANSI-C, VBA)
1416 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Value of the tag in the data type "double"
See also
Tag statuses (Page 1603)
GetTagFloatStateWait example (Page 1550)
Functionality of the GetTag functions (Page 1410)
GetTagDWordStateWait
Function
Determines the value of a tag of data type "unsigned 32 bit". The value is read explicitly from
the AS. The status of the tag is also returned.
Syntax
DWORD GetTagDWordStateWait(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "DWORD"
See also
Tag statuses (Page 1603)
GetTagWordStateWait example (Page 1559)
Functionality of the GetTag functions (Page 1410)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1417
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagFloatStateWait
Function
Determines the value of a tag of data type "32-bit floating point value". The value is read
explicitly from the AS. The status of the tag is also returned.
Syntax
float GetTagFloatStateWait(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "float"
See also
Tag statuses (Page 1603)
GetTagFloatStateWait example (Page 1550)
Functionality of the GetTag functions (Page 1410)
GetTagMultiStateWait
Function
The values and states of several tags are established and stored in the corresponding
addresses in the specified format. The values are read explicitly from the AS.
The function must transfer a DWORD array whose members contain the individual tag states
after the function is invoked. The size of the array must be selected so that sufficient memory
space is available for these states.
Syntax
BOOL GetTagMultiStateWait(DWORD* pdwState, const char* pFormat)
WinCC: Scripting (VBS, ANSI-C, VBA)
1418 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
pdwState
Field in which the tag states are stored.
pFormat
Format description for all requested tags and for each tag name and address of the tag value.
Example for three tags (LONG, double, char*):
● "%d%f%s"
Data formats:
%d int, LONG, SDWORD, BOOL
%g, %G, %e, %E, %f double
%s char*
%u unsigned int, ULONG, DWORD
You can also use "%d" for these data formats.
Overwriting occurs with smaller data formats (e.g. BYTE, SBYTE, WORD, SWORD, float, etc.).
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Format descriptors (Page 1598)
Tag statuses (Page 1603)
GetTagMultiStateWait example (Page 1552)
Functionality of the GetTag functions (Page 1410)
GetTagRawStateWait
Function
Determines the value of a tag of data type "Raw data type". The value is read explicitly from
the AS. The status of the tag is also returned.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1419
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL GetTagRawStateWait(Tag Tag_Name, BYTE pValue, DWORD size, PDWORD
lp_dwstate);
Parameters
Tag_Name
name of the tag
pValue
The pointer to a byte field which contains the value of the raw data tag
size
Size of the byte field in bytes
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
GetTagRawStateWait example (Page 1556)
Functionality of the GetTag functions (Page 1410)
GetTagSByteStateWait
Function
Determines the value of a tag of data type "signed 8 bit". The value is read explicitly from the
AS. The status of the tag is also returned.
Syntax
signed char GetTagSByteStateWait(Tag Tag_Name, PDWORD lp_dwstate);
WinCC: Scripting (VBS, ANSI-C, VBA)
1420 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
The value of the tag in the data type "signed char"
See also
Tag statuses (Page 1603)
GetTagSByteStateWait example (Page 1558)
Functionality of the GetTag functions (Page 1410)
GetTagSDWordStateWait
Function
Determines the value of a tag of data type "signed 32 bit". The value is read explicitly from the
AS. The status of the tag is also returned.
Syntax
long GetTagSDWordStateWait(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "long"
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1421
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Tag statuses (Page 1603)
GetTagSByteStateWait example (Page 1558)
Functionality of the GetTag functions (Page 1410)
GetTagSWordStateWait
Function
Determines the value of a tag of data type "signed 16 bit". The value is read explicitly from the
AS. The status of the tag is also returned.
Syntax
short GetTagSWordStateWait(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "short"
See also
Functionality of the GetTag functions (Page 1410)
Tag statuses (Page 1603)
GetTagSByteStateWait example (Page 1558)
GetTagWordStateWait
Function
Determines the value of a tag of data type "unsigned 16 bit". The value is read explicitly from
the AS. The status of the tag is also returned.
WinCC: Scripting (VBS, ANSI-C, VBA)
1422 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
WORD GetTagWordStateWait(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "WORD"
See also
Tag statuses (Page 1603)
GetTagWordStateWait example (Page 1559)
Functionality of the GetTag functions (Page 1410)
GetTagBitState
Function
Determines the value of a tag of data type "Binary tag". The status of the tag is also returned.
Syntax
BOOL GetTagBitState(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "BOOL"
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1423
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Tag statuses (Page 1603)
GetTagBitStateWait example (Page 1545)
Functionality of the GetTag functions (Page 1410)
GetTagByteState
Function
Determines the value of a tag of data type "unsigned 8 bit". The status of the tag is also returned.
Syntax
BYTE GetTagByteState(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "BYTE"
See also
Tag statuses (Page 1603)
GetTagWordStateWait example (Page 1559)
Functionality of the GetTag functions (Page 1410)
GetTagCharState
Function
Determines the value of a tag of data type "8-bit text tag" or "16-bit text tag". The status of the
tag is also returned.
WinCC: Scripting (VBS, ANSI-C, VBA)
1424 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
char* GetTagCharState(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Pointer to the value of the tag in data type "char".
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
See also
Tag statuses (Page 1603)
Beispiel GetTagCharStateWait (Page 1548)
Functionality of the GetTag functions (Page 1410)
GetTagDoubleState
Function
Determines the value of a tag of data type "64-bit floating point value". The status of the tag
is also returned.
Syntax
double GetTagDoubleState(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1425
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "double"
See also
Tag statuses (Page 1603)
GetTagFloatStateWait example (Page 1550)
Functionality of the GetTag functions (Page 1410)
GetTagDWordState
Function
Determines the value of a tag of data type "unsigned 32 bit". The status of the tag is also
returned.
Syntax
DWORD GetTagDWordState(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "DWORD"
See also
Tag statuses (Page 1603)
GetTagWordStateWait example (Page 1559)
Functionality of the GetTag functions (Page 1410)
WinCC: Scripting (VBS, ANSI-C, VBA)
1426 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagFloatState
Function
Determines the value of a tag of data type "32-bit floating point value". The status of the tag
is also returned.
Syntax
float GetTagFloatState(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "float"
See also
GetTagFloatStateWait example (Page 1550)
Tag statuses (Page 1603)
Functionality of the GetTag functions (Page 1410)
GetTagRawState
Function
Determines the value of a tag of data type "Raw data type". The status of the tag is also
returned.
Syntax
BOOL GetTagRawState(Tag Tag_Name, BYTE* pValue, DWORD size, PDWORD
lp_dwstate);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1427
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Tag_Name
name of the tag
pValue
The pointer to a byte field which contains the value of the raw data tag
size
Size of the byte field in bytes
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
GetTagRawStateWait example (Page 1556)
Functionality of the GetTag functions (Page 1410)
GetTagSByteState
Function
Determines the value of a tag of data type "signed 8 bit". The status of the tag is also returned.
Syntax
signed char GetTagSByteState(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
WinCC: Scripting (VBS, ANSI-C, VBA)
1428 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
The value of the tag in the data type "signed char"
See also
Tag statuses (Page 1603)
GetTagSByteStateWait example (Page 1558)
Functionality of the GetTag functions (Page 1410)
GetTagSDWordState
Function
Determines the value of a tag of data type "signed 32 bit". The status of the tag is also returned.
Syntax
long GetTagSDWordState(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "long"
See also
Tag statuses (Page 1603)
GetTagSByteStateWait example (Page 1558)
Functionality of the GetTag functions (Page 1410)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1429
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagSWordState
Function
Determines the value of a tag of data type "signed 16 bit". The status of the tag is also returned.
Syntax
short GetTagSWordState(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "short"
See also
Tag statuses (Page 1603)
GetTagSByteStateWait example (Page 1558)
Functionality of the GetTag functions (Page 1410)
GetTagWordState
Function
Determines the value of a tag of data type "unsigned 16 bit". The status of the tag is also
returned.
Syntax
WORD GetTagWordState(Tag Tag_Name, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
WinCC: Scripting (VBS, ANSI-C, VBA)
1430 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
Value of the tag in the data type "WORD"
See also
Tag statuses (Page 1603)
GetTagWordStateWait example (Page 1559)
Functionality of the GetTag functions (Page 1410)
stateqc
wait
GetTagBitStateQCWait
Function
Determines the value of a tag of data type "Binary tag". The value is read explicitly from the
AS. In addition, the status and the quality code of the tags are returned.
Syntax
BOOL GetTagBitStateQCWait(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1431
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Value of the tags in the data type "BOOL".
See also
Tag statuses (Page 1603)
GetTagWordStateQCWait example (Page 1559)
Functionality of the GetTag functions (Page 1410)
GetTagByteStateQCWait
Function
Determines the value of a tag of data type "unsigned 8 bit". The value is read explicitly from
the AS. In addition, the status and the quality code of the tags are returned.
Syntax
BYTE GetTagByteStateQCWait(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "BYTE".
See also
Tag statuses (Page 1603)
GetTagWordStateQCWait example (Page 1559)
Functionality of the GetTag functions (Page 1410)
WinCC: Scripting (VBS, ANSI-C, VBA)
1432 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagCharStateQCWait
Function
Determines the value of a tag of data type "8-bit text tag" or "16-bit text tag". The value is read
explicitly from the AS. In addition, the status and the quality code of the tags are returned.
Syntax
char* GetTagCharStateQCWait(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Pointer to the value of the tag in data type "char".
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
See also
Tag statuses (Page 1603)
GetTagCharStateQCWait example (Page 1547)
Functionality of the GetTag functions (Page 1410)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1433
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagDoubleStateQCWait
Function
Determines the value of a tag of data type "64-bit floating point value". The value is read
explicitly from the AS. In addition, the status and the quality code of the tags are returned.
Syntax
double GetTagDoubleStateQCWait(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "double".
See also
Tag statuses (Page 1603)
GetTagFloatStateQCWait example (Page 1549)
Functionality of the GetTag functions (Page 1410)
GetTagDWordStateQCWait
Function
Determines the value of a tag of data type "unsigned 32 bit". The value is read explicitly from
the AS. In addition, the status and the quality code of the tags are returned.
Syntax
DWORD GetTagDWordStateQCWait(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
WinCC: Scripting (VBS, ANSI-C, VBA)
1434 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "DWORD".
See also
Tag statuses (Page 1603)
GetTagWordStateQCWait example (Page 1559)
Functionality of the GetTag functions (Page 1410)
GetTagFloatStateQCWait
Function
Determines the value of a tag of data type "32-bit floating point value". The value is read
explicitly from the AS. In addition, the status and the quality code of the tags are returned.
Syntax
float GetTagFloatStateQCWait(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1435
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "float".
See also
Tag statuses (Page 1603)
GetTagFloatStateQCWait example (Page 1549)
Functionality of the GetTag functions (Page 1410)
GetTagMultiStateQCWait
Function
The values, states and quality codes are determined for several tags and are stored in the
respective addresses in the specified format. The values are read explicitly from the AS.
The function must be provided with two DWORD arrays, the member of which contains the
states and quality codes of the individual tags after the function has been called. The size of
the arrays must be selected so that sufficient memory space is available for these states.
Syntax
BOOL GetTagMultiStateQCWait(DWORD* pdwState, DWORD* pdwQualityCode, const char*
pFormat)
Parameters
pdwState
Field in which the status of the individual tags is stored after the function has been completed.
pdwQualityCode
Field in which the quality codes of the individual tags is stored after the function has been
completed.
pFormat
Format description for all requested tags and for each tag name and address of the tag value.
Example for three tags (LONG, double, char*):
● "%d%f%s"
WinCC: Scripting (VBS, ANSI-C, VBA)
1436 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Data formats:
%d int, LONG, SDWORD, BOOL
%g, %G, %e, %E, %f double
%s char*
%u unsigned int, ULONG, DWORD
You can also use "%d" for these data formats.
Overwriting occurs with smaller data formats (e.g. BYTE, SBYTE, WORD, SWORD, float, etc.).
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Format descriptors (Page 1598)
Tag statuses (Page 1603)
GetTagMultiStateQCWait example (Page 1551)
Functionality of the GetTag functions (Page 1410)
GetTagRawStateQCWait
Function
Determines the value of a tag of data type "Raw data type". The value is read explicitly from
the AS. In addition, the status and the quality code of the tags are returned.
Syntax
BOOL GetTagRawStateQCWait(Tag Tag_Name, BYTE pValue, DWORD size, PDWORD
lp_dwstate, PDWORD pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
pValue
Pointer to a byte field containing the value of the raw data tag.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1437
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
size
Size of the byte field in bytes.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
GetTagRawStateQCWait example (Page 1555)
Functionality of the GetTag functions (Page 1410)
GetTagSByteStateQCWait
Function
Determines the value of a tag of data type "signed 8 bit". The value is read explicitly from the
AS. In addition, the status and the quality code of the tags are returned.
Syntax
signed char GetTagSByteStateQCWait(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
WinCC: Scripting (VBS, ANSI-C, VBA)
1438 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "signed char".
See also
Tag statuses (Page 1603)
GetTagSByteStateQCWait example (Page 1557)
Functionality of the GetTag functions (Page 1410)
GetTagSDWordStateQCWait
Function
Determines the value of a tag of data type "signed 32 bit". The value is read explicitly from the
AS. In addition, the status and the quality code of the tags are returned.
Syntax
long GetTagSDWordStateQCWait(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tags in the data type "long".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1439
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Tag statuses (Page 1603)
GetTagSByteStateQCWait example (Page 1557)
Functionality of the GetTag functions (Page 1410)
GetTagSWordStateQCWait
Function
Determines the value of a tag of data type "signed 16 bit". The value is read explicitly from the
AS. In addition, the status and the quality code of the tags are returned.
Syntax
short GetTagSWordStateQCWait(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "short".
See also
Tag statuses (Page 1603)
GetTagSByteStateQCWait example (Page 1557)
Functionality of the GetTag functions (Page 1410)
WinCC: Scripting (VBS, ANSI-C, VBA)
1440 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagValueStateQCWait
Function
Enables the transfer of a value in the form of a variant. Establishes the pointer to the result
structure containing the value. The value is read explicitly from the AS. In addition, the status
and the quality code of the tags are returned.
Syntax
BOOL GetTagValueStateQCWait(LPDM_VARKEY lpdmVarKey,
LPDM_VAR_UPDATE_STRUCTEX lpdmresult, LPCMN_ERROR lpdmError);
Parameters
lpdmVarKey
Pointer to a structure of the data type "DM_VARKEY"
lpdmresult
Pointer to the value from data type "DM_VAR_UPDATE_STRUCTEX"
lpdmError
Pointer to the structure which contains the error description
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Structure definition CMN_ERROR (Page 1606)
Structure definition DM_VAR_UPDATE_STRUCTEX (Page 1608)
Structure definition DM_VARKEY (Page 1609)
Functionality of the GetTag functions (Page 1410)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1441
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagWordStateQCWait
Function
Determines the value of a tag of data type "unsigned 16 bit". The value is read explicitly from
the AS. In addition, the status and the quality code of the tags are returned.
Syntax
WORD GetTagWordStateQCWait(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "WORD".
See also
Tag statuses (Page 1603)
GetTagWordStateQCWait example (Page 1559)
Functionality of the GetTag functions (Page 1410)
GetTagBitStateQC
Function
Determines the value of a tag of data type "Binary tag". In addition, the status and the quality
code of the tags are returned.
Syntax
BOOL GetTagBitStateQC(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
WinCC: Scripting (VBS, ANSI-C, VBA)
1442 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tags in the data type "BOOL".
See also
Tag statuses (Page 1603)
GetTagBitStateQC example (Page 1544)
Functionality of the GetTag functions (Page 1410)
GetTagByteStateQC
Function
Determines the value of a tag of data type "unsigned 8 bit". In addition, the status and the
quality code of the tags are returned.
Syntax
BYTE GetTagByteStateQC(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1443
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "BYTE".
See also
Tag statuses (Page 1603)
GetTagWordStateQCWait example (Page 1559)
Functionality of the GetTag functions (Page 1410)
GetTagCharStateQC
Function
Determines the value of a tag of data type "8-bit text tag" or "16-bit text tag". In addition, the
status and the quality code of the tags are returned.
Syntax
char* GetTagCharStateQC(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Pointer to the value of the tag in data type "char".
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
WinCC: Scripting (VBS, ANSI-C, VBA)
1444 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
if(pszValue != NULL)
{
.......
}
See also
Tag statuses (Page 1603)
GetTagCharStateQCWait example (Page 1547)
Functionality of the GetTag functions (Page 1410)
GetTagDoubleStateQC
Function
Determines the value of a tag of data type "64-bit floating point value". In addition, the status
and the quality code of the tags are returned.
Syntax
double GetTagDoubleStateQC(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "double".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1445
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
GetTagFloatStateQCWait example (Page 1549)
Tag statuses (Page 1603)
Functionality of the GetTag functions (Page 1410)
GetTagDWordStateQC
Function
Determines the value of a tag of data type "unsigned 32 bit". In addition, the status and the
quality code of the tags are returned.
Syntax
DWORD GetTagDWordStateQC(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "DWORD".
See also
Tag statuses (Page 1603)
GetTagWordStateQCWait example (Page 1559)
Functionality of the GetTag functions (Page 1410)
WinCC: Scripting (VBS, ANSI-C, VBA)
1446 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagFloatStateQC
Function
Determines the value of a tag of data type "32-bit floating point value". In addition, the status
and the quality code of the tags are returned.
Syntax
float GetTagFloatStateQC(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "float".
See also
GetTagFloatStateQCWait example (Page 1549)
Tag statuses (Page 1603)
Functionality of the GetTag functions (Page 1410)
GetTagRawStateQC
Function
Determines the value of a tag of data type "Raw data type". In addition, the status and the
quality code of the tags are returned.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1447
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL GetTagRawStateQC(Tag Tag_Name, BYTE* pValue, DWORD size, PDWORD
lp_dwstate, PDWORD pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
pValue
Pointer to a byte field containing the value of the raw data tag.
size
Size of the byte field in bytes.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
GetTagRawStateQCWait example (Page 1555)
Functionality of the GetTag functions (Page 1410)
GetTagSByteStateQC
Function
Determines the value of a tag of data type "signed 8 bit". In addition, the status and the quality
code of the tags are returned.
WinCC: Scripting (VBS, ANSI-C, VBA)
1448 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
signed char GetTagSByteStateQC(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "signed char".
See also
Tag statuses (Page 1603)
GetTagSByteStateQCWait example (Page 1557)
Functionality of the GetTag functions (Page 1410)
GetTagSDWordStateQC
Function
Determines the value of a tag of data type "signed 32 bit". In addition, the status and the quality
code of the tags are returned.
Syntax
long GetTagSDWordStateQC(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1449
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tags in the data type "long".
See also
Tag statuses (Page 1603)
GetTagSByteStateQCWait example (Page 1557)
Functionality of the GetTag functions (Page 1410)
GetTagSWordStateQC
Function
Determines the value of a tag of data type "signed 16 bit". In addition, the status and the quality
code of the tags are returned.
Syntax
short GetTagSWordStateQC(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "short".
WinCC: Scripting (VBS, ANSI-C, VBA)
1450 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Tag statuses (Page 1603)
GetTagSByteStateQCWait example (Page 1557)
Functionality of the GetTag functions (Page 1410)
GetTagValueStateQC
Function
Enables the transfer of a value in the form of a variant. Establishes the pointer to the result
structure containing the value. In addition, the status and the quality code of the tags are
returned.
Syntax
BOOL GetTagValueStateQC(LPDM_VARKEY lpdmVarKey,
LPDM_VAR_UPDATE_STRUCTEX lpdmresult, LPCMN_ERROR lpdmError);
Parameters
lpdmVarKey
Pointer to a structure of the data type "DM_VARKEY"
lpdmresult
Pointer to the value from data type "DM_VAR_UPDATE_STRUCTEX"
lpdmError
Pointer to the structure which contains the error description
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Structure definition CMN_ERROR (Page 1606)
Structure definition DM_VAR_UPDATE_STRUCTEX (Page 1608)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1451
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Structure definition DM_VARKEY (Page 1609)
Functionality of the GetTag functions (Page 1410)
GetTagWordStateQC
Function
Determines the value of a tag of data type "unsigned 16 bit". In addition, the status and the
quality code of the tags are returned.
Syntax
WORD GetTagWordStateQC(Tag Tag_Name, PDWORD lp_dwstate, PDWORD
pdwQualityCode);
Parameters
Tag_Name
Name of the tag.
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
pdwQualityCode
Pointer to a DWORD in which the quality code of the tag is stored after the function is complete.
Return value
Value of the tag in the data type "WORD".
See also
Tag statuses (Page 1603)
GetTagWordStateQCWait example (Page 1559)
Functionality of the GetTag functions (Page 1410)
WinCC: Scripting (VBS, ANSI-C, VBA)
1452 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
wait
GetTagBitWait
Function
Determines the value of a tag of data type "Binary tag". The value is read explicitly from the
AS.
Syntax
BOOL GetTagBitWait(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "BOOL"
See also
GetTagBit example (Page 1543)
Functionality of the GetTag functions (Page 1410)
GetTagByteWait
Function
Determines the value of a tag of data type "unsigned 8 bit". The value is read explicitly from
the AS.
Syntax
BYTE GetTagByteWait(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1453
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
Value of the tag in the data type "BYTE"
See also
GetTagWord example (Page 1558)
Functionality of the GetTag functions (Page 1410)
GetTagCharWait
Function
Determines the value of a tag of data type "8-bit text tag" or "16-bit text tag". The value is read
explicitly from the AS.
Syntax
char* GetTagCharWait(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Pointer to a character string containing the value of the tag.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
See also
GetTagChar example (Page 1546)
Functionality of the GetTag functions (Page 1410)
WinCC: Scripting (VBS, ANSI-C, VBA)
1454 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagDoubleWait
Function
Determines the value of a tag of data type "64-bit floating point value". The value is read
explicitly from the AS.
Syntax
double GetTagDoubleWait(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "double"
See also
GetTagFloat example (Page 1548)
Functionality of the GetTag functions (Page 1410)
GetTagDWordWait
Function
Determines the value of a tag of data type "unsigned 32 bit". The value is read explicitly from
the AS.
Syntax
DWORD GetTagDWordWait(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "DWORD"
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1455
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Functionality of the GetTag functions (Page 1410)
GetTagWord example (Page 1558)
GetTagFloatWait
Function
Determines the value of a tag of data type "32-bit floating point value". The value is read
explicitly from the AS.
Syntax
float GetTagFloatWait(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "float"
See also
GetTagFloat example (Page 1548)
Functionality of the GetTag functions (Page 1410)
GetTagMultiWait
Function
The values of several tags are established and stored in the corresponding addresses in the
specified format. The value is read explicitly from the AS. The memory for the tag value is
created by the function with SysMalloc.
Syntax
BOOL GetTagMultiWait(const char* pFormat,...)
WinCC: Scripting (VBS, ANSI-C, VBA)
1456 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
pFormat
Format description for all requested tags and for each tag name and address of the tag value.
Example for three tags (LONG, double, char*):
● "%d%f%s"
Data formats:
%d int, LONG, SDWORD, BOOL
%g, %G, %e, %E, %f double
%s char*
%u unsigned int, ULONG, DWORD
You can also use "%d" for these data formats.
Overwriting occurs with smaller data formats (e.g. BYTE, SBYTE, WORD, SWORD, float, etc.).
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Format descriptors (Page 1598)
GetTagMultiWait example (Page 1554)
Functionality of the GetTag functions (Page 1410)
GetTagRawWait
Function
Determines the value of a tag of data type "Raw data type". The value is read explicitly from
the AS.
Syntax
BOOL GetTagRawWait(Tag Tag_Name , BYTE pValue, DWORD size);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1457
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Tag_Name
name of the tag
pValue
The pointer to a byte field which contains the value of the raw data tag
size
Size of the byte field in bytes
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Functionality of the GetTag functions (Page 1410)
GetTagRaw example (Page 1555)
GetTagSByteWait
Function
Determines the value of a tag of data type "signed 8 bit". The value is read explicitly from the
AS.
Syntax
signed char GetTagSByteWait(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
The value of the tag in the data type "signed char"
WinCC: Scripting (VBS, ANSI-C, VBA)
1458 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
GetTagSByte example (Page 1557)
Functionality of the GetTag functions (Page 1410)
GetTagSDWordWait
Function
Determines the value of a tag of data type "signed 32 bit". The value is read explicitly from the
AS.
Syntax
long GetTagSDWordWait(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "long"
See also
GetTagSByte example (Page 1557)
Functionality of the GetTag functions (Page 1410)
GetTagSWordWait
Function
Determines the value of a tag of data type "signed 16 bit". The value is read explicitly from the
AS.
Syntax
short GetTagSWordWait(Tag Tag_Name);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1459
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "short"
See also
GetTagSByte example (Page 1557)
Functionality of the GetTag functions (Page 1410)
GetTagValueWait
Function
Enables the transfer of a value in the form of a variant. Establishes the pointer to the result
structure containing the value. The value is read explicitly from the AS.
Syntax
BOOL GetTagValueWait(LPDM_VARKEY lpdmVarKey, LPDM_VAR_UPDATE_STRUCT
lpdmresult, LPCMN_ERROR lpdmError);
Parameters
lpdmVarKey
Pointer to a structure of the data type "DM_VARKEY"
lpdmresult
Pointer to the value from data type "DM_VAR_UPDATE_STRUCT"
lpdmError
Pointer to the structure which contains the error description
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1460 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Structure definition CMN_ERROR (Page 1606)
Structure definition DM_VAR_UPDATE_STRUCT (Page 1607)
Structure definition DM_VARKEY (Page 1609)
Functionality of the GetTag functions (Page 1410)
GetTagWordWait
Function
Determines the value of a tag of data type "unsigned 16 bit". The value is read explicitly from
the AS.
Syntax
WORD GetTagWordWait(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "WORD"
See also
GetTagWord example (Page 1558)
Functionality of the GetTag functions (Page 1410)
GetTagBit
Function
Determines the value of a tag of data type "Binary tag".
Syntax
BOOL GetTagBit(Tag Tag_Name);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1461
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "BOOL"
See also
GetTagBit example (Page 1543)
Functionality of the GetTag functions (Page 1410)
GetTagByte
Function
Determines the value of a tag of data type "unsigned 8 bit".
Syntax
BYTE GetTagByte(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "BYTE"
See also
GetTagWord example (Page 1558)
Functionality of the GetTag functions (Page 1410)
GetTagChar
Function
Determines the value of a tag of data type "8-bit text tag" or "16-bit text tag".
WinCC: Scripting (VBS, ANSI-C, VBA)
1462 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
char* GetTagChar(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Pointer to a character string containing the value of the tag.
The return value must be checked for validity to prevent a null pointer exception, e.g. with the
function "GetText()":
pszValue = GetText(lpszPictureName,"Text1");
if(pszValue != NULL)
{
.......
}
See also
GetTagChar example (Page 1546)
Functionality of the GetTag functions (Page 1410)
GetTagDateTime
Function
Determines the value of a tag of data type "Date/Time".
Syntax
SYSTEMTIME GetTagDateTime(Tag Tag_Name);
Parameter
Tag_Name
Name of the tag
Return value
Value of the tag in the data type "Date/Time".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1463
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagDouble
Function
Determines the value of a tag of data type "64-bit floating point value".
Syntax
double GetTagDouble(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "double"
See also
GetTagFloat example (Page 1548)
Functionality of the GetTag functions (Page 1410)
GetTagDWord
Function
Determines the value of a tag of data type "unsigned 32 bit".
Syntax
DWORD GetTagDWord(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "DWORD"
WinCC: Scripting (VBS, ANSI-C, VBA)
1464 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
GetTagWord example (Page 1558)
Functionality of the GetTag functions (Page 1410)
GetTagFloat
Function
Determines the value of a tag of data type "32-bit floating point value".
Syntax
float GetTagFloat(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "float".
See also
GetTagFloat example (Page 1548)
Functionality of the GetTag functions (Page 1410)
GetTagRaw
Function
Determines the value of a tag of data type "Raw data type".
Syntax
BOOL GetTagRaw(Tag Tag_Name, BYTE* pValue, DWORD size);
Parameters
Tag_Name
name of the tag
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1465
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
pValue
The pointer to a byte field which contains the value of the raw data tag
size
Size of the byte field in bytes
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
GetTagRaw example (Page 1555)
Functionality of the GetTag functions (Page 1410)
GetTagSByte
Function
Determines the value of a tag of data type "signed 8 bit".
Syntax
signed char GetTagSByte(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
The value of the tag in the data type "signed char"
See also
GetTagSByte example (Page 1557)
Functionality of the GetTag functions (Page 1410)
WinCC: Scripting (VBS, ANSI-C, VBA)
1466 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagSDWord
Function
Determines the value of a tag of data type "signed 32 bit".
Syntax
long GetTagSDWord(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "long"
See also
GetTagSByte example (Page 1557)
Functionality of the GetTag functions (Page 1410)
GetTagSWord
Function
Determines the value of a tag of data type "signed 16 bit".
Syntax
short GetTagSWord(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "short"
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1467
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
GetTagSByte example (Page 1557)
Functionality of the GetTag functions (Page 1410)
GetTagValue
Function
Enables the transfer of a value in the form of a variant. Establishes the pointer to the result
structure containing the value.
Syntax
BOOL GetTagValue(LPDM_VARKEY lpdmVarKey, LPDM_VAR_UPDATE_STRUCT
lpdmresult, LPCMN_ERROR lpdmError);
Parameters
lpdmVarKey
Pointer to a structure of the data type "DM_VARKEY"
lpdmresult
Pointer to the value from data type "DM_VAR_UPDATE_STRUCT"
lpdmError
Pointer to the structure which contains the error description
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Structure definition CMN_ERROR (Page 1606)
Structure definition DM_VAR_UPDATE_STRUCT (Page 1607)
Structure definition DM_VARKEY (Page 1609)
Functionality of the GetTag functions (Page 1410)
WinCC: Scripting (VBS, ANSI-C, VBA)
1468 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagWord
Function
Determines the value of a tag of data type "unsigned 16 bit".
Syntax
WORD GetTagWord(Tag Tag_Name);
Parameters
Tag_Name
name of the tag
Return value
Value of the tag in the data type "WORD"
See also
GetTagWord example (Page 1558)
Functionality of the GetTag functions (Page 1410)
set
Principle of the SetTag functions
SetTagXXX
The SetTagXXX function assigns the job a value to write and returns immediately to the caller.
In this case, the system does not wait until value is actually written.
The call is marked by the following:
● The call is fast.
● The caller does not know when the value is actually written.
● The function provides no information on the state of the write job.
SetTagXXXWait
The function SetTagXXXWait assigns the job of writing a value and will first return to the caller
when the value has actually been written.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1469
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
The call is marked by the following:
● The call takes longer in comparison to SetTagXXX. The duration is also dependent on the
channel and AS, amongst other things.
● The value is written after the call.
● The function provides no information on the state of the write job.
SetTagXXXState
The function SetTagXXXState has the same features as SetTagXXX; plus the function returns
information regarding the status of the write request.
Since the status is always provided internally, there is no performance difference compared
to SetTagXXX.
SetTagXXXStateWait
The function SetTagXXXStateWait has the same features as SetTagXXXWait; plus the
function returns information regarding the status of the write request.
Since the status is always provided internally, there is no performance difference compared
to SetTagXXXWait.
The difference between the functions SetTagXXXStateWait and SetTagXXXState
corresponds to the difference between SetTagXXXWait and SetTagXXX.
Note, that certain statuses can only be generated when the write process has been completed.
SetTagMultiWait
The SetTagMultiWait function has the same features as SetTagXXXWait. It also offers the
option of granting several write jobs in a single job.
state
wait
SetTagBitStateWait
Function
Sets the value of a tag of data type "Binary tag". The function is ended after the AS has
acknowledged acceptance of the value. The status of the tag is also returned.
Principle of the SetTag
functionsEXAMPLE_INTERNAL_FUNCTIONS_TAG_STATEWAIT_23_130
WinCC: Scripting (VBS, ANSI-C, VBA)
1470 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetTagBitStateWait(Tag Tag_Name, short value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "short"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. To do this, the
tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
Beispiel SetTagBitStateWait (Page 1575)
SetTagByteStateWait
Function
Sets the value of a tag of the data type "unsigned 8 Bit". The function is ended after the AS
has acknowledged acceptance of the value. The status of the tag is also returned.
Principle of the SetTag
functionsEXAMPLE_INTERNAL_FUNCTIONS_TAG_STATEWAIT_23_130
Syntax
BOOL SetTagByteStateWait(Tag Tag_Name, BYTE value, PDWORD lp_dwstate);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1471
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "BYTE"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. To do this, the
tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
Beispiel SetTagWordStateWait (Page 1583)
SetTagCharStateWait
Function
Sets the value of a tag of the data type " 8-bit text tag" or "16-bit text tag". The function is ended
after the AS has acknowledged acceptance of the value. The status of the tag is also returned.
Principle of the SetTag
functionsEXAMPLE_INTERNAL_FUNCTIONS_TAG_STATEWAIT_23_130
Syntax
BOOL SetTagCharStateWait(Tag Tag_Name, LPSTR value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
WinCC: Scripting (VBS, ANSI-C, VBA)
1472 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
value
Value of the tag in the data type "LPSTR"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. To do this, the
tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
SetTagCharStateWait example (Page 1576)
SetTagDoubleStateWait
Function
Defines the value of a tag of the data type "64-bit floating point value". The function is ended
after the AS has acknowledged acceptance of the value. The status of the tag is also returned.
Principle of the SetTag
functionsEXAMPLE_INTERNAL_FUNCTIONS_TAG_STATEWAIT_23_130
Syntax
BOOL SetTagDoubleStateWait(Tag Tag_Name, double value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "double"
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1473
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. To do this, the
tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
SetTagFloatStateWait example (Page 1577)
SetTagDWordStateWait
Function
Sets the value of a tag of the data type "unsigned 32 Bit". The function is ended after the AS
has acknowledged acceptance of the value. The status of the tag is also returned.
Principle of the SetTag
functionsEXAMPLE_INTERNAL_FUNCTIONS_TAG_STATEWAIT_23_130
Syntax
BOOL SetTagDWordStateWait(Tag Tag_Name, DWORD value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "DWORD"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
WinCC: Scripting (VBS, ANSI-C, VBA)
1474 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. To do this, the
tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
Beispiel SetTagWordStateWait (Page 1583)
SetTagFloatStateWait
Function
Defines the value of a tag of the data type "32-bit floating point value". The function is ended
after the AS has acknowledged acceptance of the value. The status of the tag is also returned.
Principle of the SetTag
functionsEXAMPLE_INTERNAL_FUNCTIONS_TAG_STATEWAIT_23_130
Syntax
BOOL SetTagFloatStateWait(Tag Tag_Name, float value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "float"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1475
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
However, no test is made as to whether the tag could be written without errors. To do this, the
tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
SetTagFloatStateWait example (Page 1577)
SetTagMultiStateWait
Function
Sets the values of several tags. The function is ended after the AS has acknowledged
acceptance of the value.
The function must transfer a DWORD array whose members contain the individual tag states
after the function is invoked. The size of the array must be selected so that sufficient memory
space is available for these states.
Syntax
BOOL SetTagMultiStateWait(DWORD* pdwState, const char* pFormat,...)
Parameters
pdwState
Field in which the tag states are stored.
pFormat
Format description for all requested tags and for each name and value of the tags.
Example for three tags (LONG, double, char*):
● "%d%f%s"
Data formats:
%d int, LONG, SDWORD, BOOL
%g, %G, %e, %E, %f double
%s char*
%u unsigned int, ULONG, DWORD
You can also use "%d" for these data formats.
Incorrect values are transferred for smaller data formats (BYTE, SBYTE, WORD, SWORD, float,). In
addition it is read.
WinCC: Scripting (VBS, ANSI-C, VBA)
1476 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
SetTagMultiStateWait example (Page 1578)
Format descriptors (Page 1598)
Principle of the SetTag functions (Page 1469)
SetTagRawStateWait
Function
Sets the value of a tag of the data type "Raw data type". The function is ended after the AS
has acknowledged acceptance of the value. The status of the tag is also returned.
Principle of the SetTag
functionsEXAMPLE_INTERNAL_FUNCTIONS_TAG_STATEWAIT_23_130
Syntax
BOOL SetTagRawStateWait(Tag Tag_Name, BYTE pValue, DWORD size, PDWORD
lp_dwstate);
Parameters
Tag_Name
name of the tag
pValue
The pointer to a byte field which contains the value of the raw data tag
size
Size of the byte field in bytes
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1477
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. To do this, the
tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
SetTagRawStateWait example (Page 1581)
SetTagSByteStateWait
Function
Sets the value of a tag of the data type "signed 8 bit". The function is ended after the AS has
acknowledged acceptance of the value. The status of the tag is also returned.
Principle of the SetTag
functionsEXAMPLE_INTERNAL_FUNCTIONS_TAG_STATEWAIT_23_130
Syntax
BOOL SetTagSByteStateWait(Tag Tag_Name, signed char value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
The value of the tag in the data type "signed char"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
1478 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
However, no test is made as to whether the tag could be written without errors. To do this, the
tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
Beispiel SetTagSByteStateWait (Page 1582)
SetTagSDWordStateWait
Function
Sets the value of a tag of the data type "signed 32 bit". The function is ended after the AS has
acknowledged acceptance of the value. The status of the tag is also returned.
Principle of the SetTag
functionsEXAMPLE_INTERNAL_FUNCTIONS_TAG_STATEWAIT_23_130
Syntax
BOOL SetTagSDWordStateWait(Tag Tag_Name, long value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "long"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. To do this, the
tag status must be evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1479
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
Beispiel SetTagSByteStateWait (Page 1582)
SetTagSWordStateWait
Function
Sets the value of a tag of the data type "signed 16 bit". The function is ended after the AS has
acknowledged acceptance of the value. The status of the tag is also returned.
Principle of the SetTag
functionsEXAMPLE_INTERNAL_FUNCTIONS_TAG_STATEWAIT_23_130
Syntax
BOOL SetTagSWordStateWait(Tag Tag_Name, short value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "short"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. To do this, the
tag status must be evaluated.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1480 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Tag statuses (Page 1603)
Beispiel SetTagSByteStateWait (Page 1582)
SetTagWordStateWait
Function
Sets the value of a tag of the data type "unsigned 16 Bit". The function is ended after the AS
has acknowledged acceptance of the value. The status of the tag is also returned.
Principle of the SetTag
functionsEXAMPLE_INTERNAL_FUNCTIONS_TAG_STATEWAIT_23_130
Syntax
BOOL SetTagWordStateWait(Tag Tag_Name, WORD value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "WORD"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. To do this, the
tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
Beispiel SetTagWordStateWait (Page 1583)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1481
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetTagBitState
Function
Sets the value of a tag of data type "Binary tag". The status of the tag is also returned.
Syntax
BOOL SetTagBitState(Tag Tag_Name, short int value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "short int"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. For this purpose,
the tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
Beispiel SetTagBitStateWait (Page 1575)
Principle of the SetTag functions (Page 1469)
SetTagByteState
Function
Sets the value of a tag of the data type "unsigned 8 Bit". The status of the tag is also returned.
WinCC: Scripting (VBS, ANSI-C, VBA)
1482 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetTagByteState(Tag Tag_Name, BYTE value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "BYTE"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. For this purpose,
the tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
Beispiel SetTagWordStateWait (Page 1583)
Principle of the SetTag functions (Page 1469)
SetTagCharState
Function
Sets the value of a tag of the data type " 8-bit text tag" or "16-bit text tag". The status of the
tag is also returned.
Syntax
BOOL SetTagCharState(Tag Tag_Name, LPSTR value, PDWORD lp_dwstate);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1483
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "LPSTR"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. For this purpose,
the tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
SetTagCharStateWait example (Page 1576)
Principle of the SetTag functions (Page 1469)
SetTagDoubleState
Function
Defines the value of a tag of the data type "64-bit floating point value". The status of the tag is
also returned.
Syntax
BOOL SetTagDoubleState(Tag Tag_Name, double value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
WinCC: Scripting (VBS, ANSI-C, VBA)
1484 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
value
Value of the tag in the data type "double"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. For this purpose,
the tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
SetTagFloatStateWait example (Page 1577)
Principle of the SetTag functions (Page 1469)
SetTagDWordState
Function
Sets the value of a tag of the data type "unsigned 32 Bit". The status of the tag is also returned.
Syntax
BOOL SetTagDWordState(Tag Tag_Name, DWORD value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "DWORD"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1485
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. For this purpose,
the tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
Beispiel SetTagWordStateWait (Page 1583)
Principle of the SetTag functions (Page 1469)
SetTagFloatState
Function
Defines the value of a tag of the data type "32-bit floating point value". The status of the tag is
also returned.
Syntax
BOOL SetTagFloatState(Tag Tag_Name, float value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "float"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
1486 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
However, no test is made as to whether the tag could be written without errors. For this purpose,
the tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
SetTagFloatStateWait example (Page 1577)
Principle of the SetTag functions (Page 1469)
SetTagRawState
Function
Sets the value of a tag of the data type "Raw data type". The status of the tag is also returned.
Syntax
BOOL SetTagRawState(Tag Tag_Name, BYTE* pValue, DWORD size, PDWORD
lp_dwstate);
Parameters
Tag_Name
name of the tag
pValue
The pointer to a byte field which contains the value of the raw data tag
size
Size of the byte field in bytes
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1487
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
GetTagRaw example (Page 1555)
Principle of the SetTag functions (Page 1469)
SetTagSByteState
Function
Sets the value of a tag of the data type "signed 8 bit". The status of the tag is also returned.
Syntax
BOOL SetTagSByteState(Tag Tag_Name, signed char value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
The value of the tag in the data type "signed char"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. For this purpose,
the tag status must be evaluated.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1488 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Tag statuses (Page 1603)
Beispiel SetTagSByteStateWait (Page 1582)
Principle of the SetTag functions (Page 1469)
SetTagSDWordState
Function
Sets the value of a tag of the data type "signed 32 bit". The status of the tag is also returned.
Syntax
BOOL SetTagSDWordState(Tag Tag_Name, long value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "long"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. For this purpose,
the tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
Beispiel SetTagSByteStateWait (Page 1582)
Principle of the SetTag functions (Page 1469)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1489
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetTagSWordState
Function
Sets the value of a tag of the data type "signed 16 bit". The status of the tag is also returned.
Syntax
BOOL SetTagSWordState(Tag Tag_Name, short value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "short"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. For this purpose,
the tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
Beispiel SetTagSByteStateWait (Page 1582)
Principle of the SetTag functions (Page 1469)
SetTagWordState
Function
Sets the value of a tag of the data type "unsigned 16 Bit". The status of the tag is also returned.
WinCC: Scripting (VBS, ANSI-C, VBA)
1490 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetTagWordState(Tag Tag_Name, WORD value, PDWORD lp_dwstate);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "short"
lp_dwstate
Pointer to a DWORD in which the status of the tag is stored after the function has been
completed.
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors. For this purpose,
the tag status must be evaluated.
FALSE
An error has occurred.
See also
Tag statuses (Page 1603)
Beispiel SetTagWordStateWait (Page 1583)
Principle of the SetTag functions (Page 1469)
wait
SetTagBitWait
Function
Sets the value of a tag of data type "Binary tag". The function is ended after the AS has
acknowledged acceptance of the value.
Syntax
BOOL SetTagBitWait(Tag Tag_Name, short value);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1491
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameter
Tag_Name
Name of the tag
Value
Value of the tag in the data type "short"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagBit example (Page 1575)
Principle of the SetTag functions (Page 1469)
SetTagByteWait
Function
Sets the value of a tag of the data type "unsigned 8 Bit". The function is ended after the AS
has acknowledged acceptance of the value.
Syntax
BOOL SetTagByteWait(Tag Tag_Name, BYTE value);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "BYTE"
WinCC: Scripting (VBS, ANSI-C, VBA)
1492 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagWord example (Page 1582)
Principle of the SetTag functions (Page 1469)
SetTagCharWait
Function
Sets the value of a tag of the data type " 8-bit text tag" or "16-bit text tag". The function is ended
after the AS has acknowledged acceptance of the value.
Syntax
BOOL SetTagCharWait(Tag Tag_Name, LPSTR value);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "LPSTR"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1493
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Principle of the SetTag functions (Page 1469)
SetTagChar example (Page 1575)
SetTagDoubleWait
Function
Defines the value of a tag of the data type "64-bit floating point value". The function is ended
after the AS has acknowledged acceptance of the value.
Syntax
BOOL SetTagDoubleWait(Tag Tag_Name, double value);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "double"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagFloat example (Page 1576)
Principle of the SetTag functions (Page 1469)
SetTagDWordWait
Function
Sets the value of a tag of the data type "unsigned 32 Bit". The function is ended after the AS
has acknowledged acceptance of the value.
WinCC: Scripting (VBS, ANSI-C, VBA)
1494 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetTagDWordWait(Tag Tag_Name, DWORD value);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "DWORD"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagWord example (Page 1582)
Principle of the SetTag functions (Page 1469)
SetTagFloatWait
Function
Defines the value of a tag of the data type "32-bit floating point value". The function is ended
after the AS has acknowledged acceptance of the value.
Syntax
BOOL SetTagFloatWait(Tag Tag_Name, float value);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "float"
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1495
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagFloat example (Page 1576)
Principle of the SetTag functions (Page 1469)
SetTagMultiWait
Function
The values of several tags are set in the specified format. The function is ended after the AS
has acknowledged acceptance of the value.
Syntax
BOOL SetTagMultiWait(const char* pFormat,...)
Parameters
pFormat
Format description for all requested tags and for each name and value of the tags.
Example for three tags (LONG, double, char*):
● "%d%f%s"
Data formats:
%d int, LONG, SDWORD, BOOL
%g, %G, %e, %E, %f double
%s char*
%u unsigned int, ULONG, DWORD
You can also use "%d" for these data formats.
Incorrect values are transferred for smaller data formats (BYTE, SBYTE, WORD, SWORD, float,). In
addition it is read.
WinCC: Scripting (VBS, ANSI-C, VBA)
1496 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
Format descriptors (Page 1598)
SetTagMultiWait example (Page 1579)
Principle of the SetTag functions (Page 1469)
SetTagRawWait
Function
Sets the value of a tag of the data type "Raw data type". The function is ended after the AS
has acknowledged acceptance of the value.
Syntax
BOOL SetTagRawWait(Tag Tag_Name, BYTE pValue, DWORD size);
Parameters
Tag_Name
name of the tag
pValue
The pointer to a byte field which contains the value of the raw data tag
size
Size of the byte field in bytes
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1497
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
FALSE
An error has occurred.
See also
SetTagRaw example (Page 1580)
Principle of the SetTag functions (Page 1469)
SetTagSByteWait
Function
Sets the value of a tag of the data type "signed 8 bit". The function is ended after the AS has
acknowledged acceptance of the value.
Syntax
BOOL SetTagSByteWait(Tag Tag_Name, signed char value);
Parameters
Tag_Name
name of the tag
value
The value of the tag in the data type "signed char"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagSByte example (Page 1581)
Principle of the SetTag functions (Page 1469)
WinCC: Scripting (VBS, ANSI-C, VBA)
1498 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetTagSDWordWait
Function
Sets the value of a tag of the data type "signed 32 bit". The function is ended after the AS has
acknowledged acceptance of the value.
Syntax
BOOL SetTagSDWordWait(Tag Tag_Name, long value);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "long"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
Principle of the SetTag functions (Page 1469)
SetTagSByte example (Page 1581)
SetTagSWordWait
Function
Sets the value of a tag of the data type "signed 16 bit". The function is ended after the AS has
acknowledged acceptance of the value.
Syntax
BOOL SetTagSWordWait(Tag Tag_Name, short value);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1499
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "short"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagSByte example (Page 1581)
Principle of the SetTag functions (Page 1469)
SetTagValueWait
Function
Enables the transfer of a value in the form of a variant and sets the pointer to the value of the
data type "Variant". The function is ended after the AS has acknowledged acceptance of the
value.
Syntax
BOOL SetTagValueWait(LPDM_VARKEY lpdmVarKey, LPVARIANT lpdmValue, PDWORD
dwState, LPCMN_ERROR lpdmError);
Parameters
lpdmVarKey
Pointer to a structure of the data type "DM_VARKEY"
lpdmValue
Pointer to the value of data type "Variant". A description of the data type VARIANT can be
found in the associated documentation.
WinCC: Scripting (VBS, ANSI-C, VBA)
1500 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
dwState
Tag status which is returned after the function has been run.
lpdmError
Pointer to the structure which contains the error description
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
Structure definition CMN_ERROR (Page 1606)
Tag statuses (Page 1603)
Structure definition DM_VAR_UPDATE_STRUCT (Page 1607)
Structure definition DM_VARKEY (Page 1609)
Principle of the SetTag functions (Page 1469)
SetTagWordWait
Function
Sets the value of a tag of the data type "unsigned 16 Bit". The function is ended after the AS
has acknowledged acceptance of the value.
Syntax
BOOL SetTagWordWait(Tag Tag_Name, WORD value);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "WORD"
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1501
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagWord example (Page 1582)
Principle of the SetTag functions (Page 1469)
SetTagBit
Function
Sets the value of a tag of data type "Binary tag".
Syntax
BOOL SetTagBit(Tag Tag_Name, short int value);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "short int"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1502 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Principle of the SetTag functions (Page 1469)
SetTagBit example (Page 1575)
SetTagByte
Function
Sets the value of a tag of the data type "unsigned 8 Bit".
Syntax
BOOL SetTagByte(Tag Tag_Name, BYTE value);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "BYTE"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagWord example (Page 1582)
Principle of the SetTag functions (Page 1469)
SetTagChar
Function
Sets the value of a tag of the data type " 8-bit text tag" or "16-bit text tag".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1503
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameter
Tag_Name
Name of the tag
Value
Value of the tag in the data type "LPSTR"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagChar example (Page 1575)
Principle of the SetTag functions (Page 1469)
SetTagDateTime
Function
Sets the value of a tag of data type "Date/Time".
Syntax
BOOL SetTagDateTime(Tag Tag_Name, SYSTEMTIME value);
Parameter
Tag_Name
Name of the tag
value
Value of the tag in the data type "Date/Time".
WinCC: Scripting (VBS, ANSI-C, VBA)
1504 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
SetTagDouble
Function
Defines the value of a tag of the data type "64-bit floating point value".
Syntax
BOOL SetTagDouble(Tag Tag_Name, double value);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "double"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagFloat example (Page 1576)
Principle of the SetTag functions (Page 1469)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1505
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetTagDWord
Function
Sets the value of a tag of the data type "unsigned 32 Bit".
Syntax
BOOL SetTagDWord(Tag Tag_Name, DWORD value);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "DWORD"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagWord example (Page 1582)
Principle of the SetTag functions (Page 1469)
SetTagFloat
Function
Defines the value of a tag of the data type "32-bit floating point value".
Syntax
BOOL SetTagFloat(Tag Tag_Name, float value);
WinCC: Scripting (VBS, ANSI-C, VBA)
1506 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "float"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagFloat example (Page 1576)
Principle of the SetTag functions (Page 1469)
SetTagRaw
Function
Sets the value of a tag of the data type "Raw data type".
Syntax
BOOL SetTagRaw(Tag Tag_Name, BYTE* pValue, DWORD size);
Parameters
Tag_Name
name of the tag
pValue
The pointer to a byte field which contains the value of the raw data tag
size
Size of the byte field in bytes
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1507
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagRaw example (Page 1580)
Principle of the SetTag functions (Page 1469)
SetTagSByte
Function
Sets the value of a tag of the data type "signed 8 bit".
Syntax
BOOL SetTagSByte(Tag Tag_Name, signed char value);
Parameters
Tag_Name
name of the tag
value
The value of the tag in the data type "signed char"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
WinCC: Scripting (VBS, ANSI-C, VBA)
1508 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
SetTagSByte example (Page 1581)
Principle of the SetTag functions (Page 1469)
SetTagSDWord
Function
Sets the value of a tag of the data type "signed 32 bit".
Syntax
BOOL SetTagSDWord(Tag Tag_Name, long value);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "long"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagSByte example (Page 1581)
Principle of the SetTag functions (Page 1469)
SetTagSWord
Function
Sets the value of a tag of the data type "signed 16 bit".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1509
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Syntax
BOOL SetTagSWord(Tag Tag_Name, short value);
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "short"
size
Size of the byte field in bytes
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagSByte example (Page 1581)
Principle of the SetTag functions (Page 1469)
SetTagValue
Function
Enables the transfer of a value in the form of a variant and sets the pointer to the value of the
data type "Variant".
Syntax
BOOL SetTagValue(LPDM_VARKEY lpdmVarKey, LPVARIANT lpdmValue, PDWORD
dwState, LPCMN_ERROR lpdmError);
WinCC: Scripting (VBS, ANSI-C, VBA)
1510 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
lpdmVarKey
Pointer to a structure of the data type "DM_VARKEY"
lpdmValue
Pointer to the value of data type "Variant". A description of the data type VARIANT can be
found in the associated documentation.
dwState
Tag status which is returned after the function has been run.
lpdmError
Pointer to the structure which contains the error description
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
Principle of the SetTag functions (Page 1469)
Structure definition CMN_ERROR (Page 1606)
Tag statuses (Page 1603)
Structure definition DM_VAR_UPDATE_STRUCT (Page 1607)
Structure definition DM_VARKEY (Page 1609)
SetTagWord
Function
Sets the value of a tag of the data type "unsigned 16 Bit".
Syntax
BOOL SetTagWord(Tag Tag_Name, WORD value);
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1511
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Tag_Name
name of the tag
value
Value of the tag in the data type "WORD"
Return value
TRUE
The function itself has been completed without any errors.
However, no test is made as to whether the tag could be written without errors.
FALSE
An error has occurred.
See also
SetTagWord example (Page 1582)
Principle of the SetTag functions (Page 1469)
2.15.3.6 WinCC
WinCC - short description
The functions of the WinCC group allow to define various setting in Runtime.
The functions of the System subgroup can be used to influence WinCC Runtime.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
WinCC: Scripting (VBS, ANSI-C, VBA)
1512 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
system
DeactivateRTProject
Function
Deactivates the activated project.
Note
If Runtime is exited on a server or client this applies only to the respective computer.
An activated project for which the WinCC Explorer has not been started must be closed with
the internal function "ExitWinCC".
If the activated project was exited with the internal function "DeactivateRTProject" the WinCC
project remains open in the background. To close this project, the WinCC Explorer must be
opened and then be closed by means of the menu commands "File" > "Exit".
Syntax
BOOL DeactivateRTProject();
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
DeactivateRTProject example (Page 1521)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1513
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
ExitWinCC
Function
Deactivates Runtime and exits WinCC on the computer executing the function.
Note
If Runtime is exited on a server or client this applies only to the respective computer.
An activated project for which the WinCC Explorer has not been started must be closed with
the internal function "ExitWinCC".
If the activated project was exited with the internal function "DeactivateRTProject" the WinCC
project remains open in the background. To close this project, the WinCC Explorer must be
opened and then be closed by means of the menu commands "File" > "Exit".
Syntax
BOOL ExitWinCC ();
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
ExitWinCC example (Page 1521)
GetLanguage
Function
Determines the current Runtime language.
Syntax
DWORD GetLanguage();
WinCC: Scripting (VBS, ANSI-C, VBA)
1514 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Return value
The current Runtime language with the associated language identifier is returned.
Note
You can find a comprehensive "Language code" table in the "Basic Principles of VBScript"
documentation under the index entry "Language code".
See also
GetLanguage example (Page 1529)
InquireLanguage
Function
Determines all languages configured in the text library for the runtime.
Use dWCount to specify where the number of determined language IDs is to be stored.
Syntax
DWORD* InquireLanguage(DWORD* dwCount);
Parameters
dwCount
Pointer to the number of determined language IDs
Return value
The configured languages with the associated language identifiers are returned.
Note
You can find a comprehensive "Language code" table in the "Basic Principles of VBScript"
documentation under the index entry "Language code".
See also
InquireLanguage example (Page 1562)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1515
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetLanguage
Function
Changes the language setting in Runtime.
Syntax
BOOL SetLanguage(DWORD dwLocaleID);
Parameters
dwLocaleID
Language ID of the language to be set
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
See also
Language ID (Page 1601)
SetLanguage example (Page 1570)
SetLanguageByID
Function
Changes the language setting in Runtime.
Syntax
BOOL SetLanguageById (long int lToggle);
WinCC: Scripting (VBS, ANSI-C, VBA)
1516 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameter
lToggle
Changes to the next configured language. Only the "-1" parameter is available for this purpose,
i.e. "SetLanguageByID(-1)".
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
SetLanguageByName
Function
Changes the language setting in Runtime using the country name of the language to be set.
Syntax
BOOL SetLanguageByName (char* lpszRfc1766);
Parameter
lpszRfc1766
Language code in accordance with "RFC 1766" format. This changes to the language
corresponding to the specified language code, e.g. "SetLanguageByName("en-us").
Return value
TRUE
The function has been completed without any errors.
FALSE
An error has occurred.
FillDiagnoseInTags
Function
Activates or deactivates the storage of diagnostic information in tags.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1517
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
As filling the tags is an additional load for the system, it should only be activated temporarily
for diagnostic information.
Syntax
void FillDiagnoseInTags(BOOL bfill);
Parameters
bFill
Storage of diagnostic information in tags on/off
TRUE Activate supply of diagnostic tags
FALSE Deactivate supply of diagnostic tags
Diagnostic tags of GlobalScript
@SCRIPT_COUNT_TAGS
This tag contains the current number of tags requested via Script.
@SCRIPT_COUNT_REQUEST_IN_QUEUES
This tag contains the current number of jobs.
@SCRIPT_COUNT_ACTIONS_IN_QUEUES
This tag contains the current number of actions.
GetServerTagPrefix
Function
To be able to access tags of the respective server from a WinCC client in a distributed system,
the tag names must be supplemented with the server prefix.
If the tags are accessed by means of the functions GetTagxx or SetTagxx, the required addition
is made by the script control.
If WinCC API functions are used for accessing, the tag names have to be supplemented by
the user. The GetServer TagPrefix function provides the required prefixes.
One pointer each of the "char" type to ServerPrefix, TagPrefix and WindowPrefix is returned.
The user must neither change the memory (also no strcat) nor release it.
Syntax
void GetServerTagPrefix(char** ppszServerPrefix, char** ppszTagPrefix, char**
ppszWindowPrefix);
WinCC: Scripting (VBS, ANSI-C, VBA)
1518 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
ppszServerPrefix
Pointer to a pointer referring to the server prefix
ppszTagPrefix
Pointer to a pointer referring to the tag prefix
ppszWindowPrefix
Pointer to a pointer referring to the window prefix
See also
GetServerTagPrefix example (Page 1542)
TraceText
Function
The value defined in <Parameter> is recorded in APDiag if the specified diagnostic level has
been reached.
Syntax
void TraceText(DWORD dwTraceLevel, char* pszFormat, <Parameter>);
Parameters
dwTraceLevel
Diagnostic level
pszFormat
Output format (according to printf function)
<Parameter>
Value to be reported
Note
The parameterization dialog for this function provides the selection of tags, graphic objects
and pictures.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1519
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
TraceTime
Function
The value defined in <Parameter> is recorded in APDiag if the specified diagnostic level has
been reached.
In addition, the time since the AP start of diagnosis is output in milliseconds to enable
performance measurements.
Syntax
void TraceTime(DWORD dwTraceLevel, char* pszFormat, <Parameter>);
Parameters
dwTraceLevel
Diagnostic level
pszFormat
Output format (according to printf function)
<Parameter>
Value to be reported
Note
The parameterization dialog for this function provides the selection of tags, graphic objects
and pictures.
2.15.4 Examples
2.15.4.1 Examles - A to G
AcknowledgeMessage example
{
//Acknowledge the AlarmLogging message which is selected
AcknowledgeMessage(GetTagWord("U08i_MsgNr"));
}
Specify the message number to be acknowledged. It is read from a tag.
WinCC: Scripting (VBS, ANSI-C, VBA)
1520 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
DeactivateRTProject example
{
//deactivate the runtime
DeactivateRTProject ();
}
This function deactivates WinCC Runtime.
ExitWinCC example
{
//exit wincc
ExitWinCC ();
}
This function exits WinCC.
2.15.4.2 Examples - GetAlarmHigh to GetPropChar
GetAlarmHigh example
{
double dAlarmHigh;
//Get the Alarm High Limit
dAlarmHigh = GetAlarmHigh(lpszPictureName,"Bar1");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the function GetAlarmHigh:
"lpszPictureName" is the name of the picture in which the object was configured.
"Bar1" is the name of the object.
1. Read out the upper alarm limit and temporarily store it in dAlarmHigh.
2. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1521
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetBackColor example
{
long int bk_color;
//Get the background color
bk_color = GetBackColor(lpszPictureName,"StatischerText1");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the function GetBackColor:
"lpszPictureName" is the name of the picture in which the object was configured.
"StaticText1" is the name of the object.
1. Read out the current background color and temporarily store it in bk_color.
2. Executing user-defined code for processing return values.
GetBorderStyle example
{
long int lstyle;
//Get the current border style
lstyle = GetBorderStyle(lpszPictureName,"Rectangle1");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the function GetBorderStyle:
"lpszPictureName" is the name of the picture in which the object was configured.
"Rectangle1" is the name of the object.
1. Read out the current line style of the object and temporarily store it in lstyle.
2. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
1522 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetFilling example
{
BOOL bfilling;
//Get the actual state of dynamic filling
bfilling = GetFilling(lpszPictureName,"Rectangle1");
if(bfilling)
{
// User defined code if the
// dynamic filling is activated
...
}
Else
{
// User defined code if the
// dynamic filling is deactivated
...
}
}
Parameters of the function GetFilling:
"lpszPictureName" is the name of the picture in which the object was configured.
"Rectangle1" is the name of the object.
1. Read out whether dynamic filling is activated or not and temporary store in bfilling.
2. Executing user-defined code, depending on the return value of the function.
GetFillingIndex example
{
long int filling_index;
//Get the actual filling index of the object
filling_index = GetFillingIndex(lpszPictureName,"Rectangle1");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the function GetFillingIndex:
"lpszPictureName" is the name of the picture in which the object was configured.
"Rectangle1" is the name of the object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1523
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
1. Read out the current fill level of the object and temporarily store it in filling_index.
2. Executing user-defined code for processing return values.
GetFillStyle example
{
long int lstyle;
//Get the current fill style
lstyle = GetFillStyle(lpszPictureName,"Rectangle1");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the function GetFillStyle:
"lpszPictureName" is the name of the picture in which the object was configured.
"Rectangle1" is the name of the object.
1. Read out the current fill pattern of the object and temporarily store it in lstyle.
2. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
1524 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetFlashBackColor example
{
BOOL bflash_col;
//Get if the flashing is on or off
bflash_col = GetFlashBackColor(lpszPictureName,"Group1");
if(bflash_col)
{
// User defined code if the
// flashing is activated
...
}
Else
{
// User defined code if the
// flashing is deactivated
...
}
}
Parameters of the function GetFlashBackColor:
"lpszPictureName" is the name of the picture in which the object was configured.
"Group1" is the name of the object.
1. Read out whether flashing of the background color is activated or not and temporary store
in bflash_col.
2. Executing user-defined code, depending on the return value of the function.
GetFlashBackColorOn example
{
long int flashcol_on;
//Get the BackFlashColor
flashcol_on = GetBackFlashColorOn(lpszPictureName,"Group1");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetBackFlashColorOn function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Group1" is the name of the object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1525
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
1. Read out the background flash color for the "On" status of the obvject and and temporarily
store it in flashcol_on.
2. Executing user-defined code for processing return values.
GetFlashRateFlashPic example
{
long lFlashRate;
//Get the flashrate
lFlashRate = GetFlashRateFlashPic(lpszPictureName,"StatusDisplay1");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetFlashRateFlashPic function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Status display1" is the name of the object.
1. Read out the flash frequency of the object and temporarily store it in lFlashRate.
2. Executing user-defined code for processing return values.
GetFocus example
{
char* pszValue = NULL;
char szValue[_MAX_PATH+1];
//Get the Object which has the focus
pszValue = Get_Focus();
//Copy the string
if(pszValue != NULL)
{
strncpy(szValue,pszValue,_MAX_PATH);
}
//User defined code where the
//user can do something with the return value
...
}
WinCC: Scripting (VBS, ANSI-C, VBA)
1526 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
1. Read out on which object the focus is and temporarily store in pszValue.
2. If a valid value has been returned, store the return value of the function in the local string
szValue. A maximum of _MAX_PATH characters is stored.
3. Executing user-defined code for processing return values.
GetFontBold example
{
BOOL bbold;
//Get if the text is bold
bbold = GetFontBold(lpszPictureName,"StaticText1");
if(bbold)
{
// User defined code if the
// font is bold
...
}
Else
{
// User defined code if the
// font is not bold
...
}
}
Parameters of the GetBackColor function
"lpszPictureName" is the name of the picture in which the object was configured.
"StaticText1" is the name of the object.
1. Read out whether the text is in bold or not and temporarily store in bbold.
2. Executing user-defined code, depending on the return value of the function.
GetFontSize example
{
long int fontsize;
//Get the actual Font size
fontsize = GetFontSize(lpszPictureName,"StaticText1");
//User defined code where the
//user can do something with the return value
...
}
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1527
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters of the GetFontSize function:
"lpszPictureName" is the name of the picture in which the object was configured.
"StaticText1" is the name of the object.
1. Read out the current font size and temporarily store it in fontsize.
2. Executing user-defined code for processing return values.
GetHeight example
{
long lHeight;
//Get the height of the object
lHeight = GetHeight(lpszPictureName,"WinCCLogo");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetHeight function:
"lpszPictureName" is the name of the picture in which the object was configured.
"WinCCLogo" is the name of the object.
1. Read out the current height of the object and temporarily store it in lHeight.
2. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
1528 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetHiddenInput example
{
BOOL bHiddenInput;
//Get the state of hidden input
bHiddenInput = GetHiddenInput(lpszPictureName,"IOField1");
if(bHiddenInput)
{
// User defined code if the
// hidden input is activated
...
}
Else
{
// User defined code if the
// hidden input is activated
...
}
}
Parameters of the GetHiddenInput function:
"lpszPictureName" is the name of the picture in which the object was configured.
"IOField1" is the name of the object.
1. Read out whether the text is in bold or not and temporarily store in bHiddenInput.
2. Executing user-defined code, depending on the return value of the function.
GetLanguage example
{
DWORD rt_language;
//Get the current language
rt_language = GetLanguage ();
//User defined code where the
//user can do something with the return value
...
}
1. Read out the current Runtime language and temporarily store it in rt_language.
2. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1529
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetLeft example
{
long lPos;
//Get the x-position of the object
lPos = GetLeft(lpszPictureName,"WinCCLogo");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetLeft function:
"lpszPictureName" is the name of the picture in which the object was configured.
"WinCCLogo" is the name of the object.
1. Read out the current X position of the object and temporarily store it in lPos.
2. Executing user-defined code for processing return values.
GetLink example
{
LINKINFO linkinfo;
//Get the linked Tag
GetLink(lpszPictureName,"Bar1","Process",&linkinfo);
// linkinfo.szLinkName is the tag name
// linkinfo.dwCycle is the update cycle
// linkinfo.LinkType is the type of the connection
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetLink function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Bar1" is the name of the object.
"Process" is the property connected to a tag.
"&linkinfo" is the address of the linkinfo structure.
WinCC: Scripting (VBS, ANSI-C, VBA)
1530 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
1. Fills the passed linkinfo structure with the tag connection information.
2. Executing user-defined code, depending on the return value of the function.
GetLinkedVariable example
{
char* pszVarName = NULL;
char szVarName[_MAX_PATH+1];
//Get the TagName
pszVarName = GetLinkedVariable("gs_stand_graph_00","StaticText6","Visible");
//Copy the string
if (strcmp (pszVarName,"")!= 0)
{
strncpy(szVarName,pszVarName,_MAX_PATH);
}
else printf("Attribute 'visible' is not made dynamic\r\n");
}
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetLinkedVariable function:
"gs_stand_graph_00" is the name of the picture in which the object was configured.
"StaticText6" is the name of the object.
"Visible" is the property connected to a tag.
1. Temporarily store the return value of the GetLinkedVariable function in pszVarName.
2. If a valid value has been returned, store the return value in szVarName. A maximum of
_MAX_PATH characters is stored.
3. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1531
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetLocalPicture example
{
char* pszPicName = NULL;
char szPicName[_MAX_PATH+1];
//Get the Local Picture
pszPicName = GetLocalPicture(lpszPictureName);
//Copy the string
if (pszPicName != NULL)
{
strncpy(szPicName,pszPicName,_MAX_PATH);
}
//User defined code where the
//user can do something with the return value
...
}
1. Temporarily store the return value of the GetLocalPicture function in pszPicName.
2. If a valid value has been returned, store the return value in szPicName. A maximum of
_MAX_PATH characters is stored.
3. Executing user-defined code for processing return values.
GetMarker example
{
BOOL bmarker;
//Get the state of the Marker
bmarker = GetMarker(lpszPictureName,"Bar1");
if(bmarker)
{
// User defined code if the
// marker is activated
...
}
Else
{
// User defined code if the
// marker is deactivated
...
}
}
Parameters of the GetMarker function:
"lpszPictureName" is the name of the picture in which the object was configured.
WinCC: Scripting (VBS, ANSI-C, VBA)
1532 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
"Bar1" is the name of the object.
1. Read out whether the marker is displayed or not and temporarily store in bmarker.
2. Executing user-defined code, depending on the return value of the function.
GetOutputValueDouble example
{
double doutput;
//Get the output value of IO Field 1
doutput = GetOutputValueDouble(lpszPictureName,"IOField1");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetOutputValueDouble function:
"lpszPictureName" is the name of the picture in which the object was configured.
"IOField1" is the name of the object.
1. Read out the output value and temporarily store it in doutput.
2. Executing user-defined code for processing return values.
GetParentPicture example
{
char* pszPicName = NULL;
char szPicName[_MAX_PATH+1];
//Get the parent picture
pszPicName = GetParentPicture(lpszPictureName);
//Copy the string
if (pszPicName != NULL)
{
strncpy(szPicName,pszPicName,_MAX_PATH);
}
//User defined code where the
//user can do something with the return value
...
}
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1533
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
1. Temporarily store the return value of the GetParentPicture function in pszPicName.
2. If a valid value has been returned, store the return value in szPicName. A maximum of
_MAX_PATH characters is stored.
3. Executing user-defined code for processing return values.
GetPictureDown example
{
char* pszPicName = NULL;
char szPicName[_MAX_PATH+1];
//Get the current picture name
pszPicName = GetPictureDown(lpszPictureName,"Roundbutton1");
if (pszPicName != NULL)
{
//Copy the string
strncpy(szPicName,pszPicName,_MAX_PATH);
}
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetPictureDown function:
"lpszPictureName" is the name of the picture in which the object was configured.
"RoundButton1" is the name of the object.
1. Read out the picture name of the picture displayed in round button 1 and temporarily store
it in pszPicName.
2. If a valid value has been returned, store the return value of the function in the local string
szPicName. A maximum of _MAX_PATH characters is stored.
3. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
1534 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetPictureName example
{
char* pszPictureName = NULL;
char szPictureName[_MAX_PATH + 1];
//Get the current PictureName
pszPictureName = GetPictureName(lpszPictureName,"GraphicObject1");
if(pszPictureName != NULL)
{
//copy the string
strncpy(szPictureName,pszPictureName,_MAX_PATH);
}
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetPictureName function:
"lpszPictureName" is the name of the picture in which the object was configured.
"GraphicObject1" is the name of the object.
1. Read out the picture name of the picture displayed in graphic object 1 and temporarily store
it in pszPictureName.
2. If a valid value has been returned, store the return value of the function in the local string
szPictureName. A maximum of _MAX_PATH characters is stored.
3. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1535
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetPictureUp example
{
char* pszPicName = NULL;
char szPicName[_MAX_PATH+1];
//Get the current picture name
pszPicName = GetPictureUp(lpszPictureName,"Roundbutton1");
if (pszPicName != NULL)
{
//Copy the string
strncpy(szPicName,pszPicName,_MAX_PATH);
}
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetPictureUp function:
"lpszPictureName" is the name of the picture in which the object was configured.
"RoundButton1" is the name of the object.
1. Read out the picture name of the picture displayed in round button 1 and temporarily store
it in pszPicName.
2. If a valid value has been returned, store the return value of the function in the local string
szPicName. A maximum of _MAX_PATH characters is stored.
3. Executing user-defined code for processing return values.
GetPosition example
{
long int lpos;
//Get the actual position of the Slider
lpos = GetPosition(lpszPictureName,"Control1");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetPosition function:
WinCC: Scripting (VBS, ANSI-C, VBA)
1536 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
"lpszPictureName" is the name of the picture in which the object was configured.
"Control1" is the name of the object.
1. Read out the current slider position and temporarily store it in lpos.
2. Executing user-defined code for processing return values.
GetPropBOOL example
{
BOOL bProp;
//Get the property Visible
bProp = GetPropBOOL("gs_graph_eafield","IOField1","Visible");
if(bProp)
{
// User defined code if the
// object is visible
...
}
else
{
// User defined code if the
// object is not visible
...
}
}
Parameters of the GetVisible function:
"lpszPictureName" is the name of the picture in which the object was configured.
"IOField1" is the name of the object.
"Visible" is the object property.
1. Read out whether the object is visible or not and temporarily store in bProp.
2. Executing user-defined code, depending on the return value of the function.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1537
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetPropChar example
{
char* pszProp = NULL;
char szProp[14];
//Get the property Tooltiptext
pszProp = GetPropChar("lpszPictureName","EAFeld1","Tooltiptext");
if(pszProp != NULL)
{
//Copy the string
strncpy(szProp,pszProp,13);
}
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetPropChar function:
"lpszPictureName" is the name of the picture in which the object was configured.
"IOField1" is the name of the object.
"Tooltiptext" is the object property.
1. Read out the tooltip text of the object and temporarily store it in pszProp.
2. If a valid value has been returned, store the return value of the function in the local string
szProp. A maximum of 13 characters is stored.
3. Executing user-defined code for processing return values.
2.15.4.3 Examples - GetRangeMax to GetWidth
GetRangeMax example
{
long int lrange;
//Get the upper scale Limit
lrange = GetRangeMax(lpszPictureName,"Control1");
//User defined code where the
//user can do something with the return value
...
}
WinCC: Scripting (VBS, ANSI-C, VBA)
1538 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters of the GetRangeMax function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Control1" is the name of the object.
1. Read out the current upper limit of the object and temporarily store it in lrange.
2. Executing user-defined code for processing return values.
GetRangeMin example
{
long int lrange;
//Get the lower scale Limit
lrange = GetRangeMin(lpszPictureName,"Control1");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetRangeMin function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Control1" is the name of the object.
1. Read out the current lower limit of the object and temporarily store it in lrange.
2. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1539
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Beispiel GetScaling
{
BOOL bscaling;
//Get the Scaling state
bscaling = GetScaling(lpszPictureName,"Bar1");
if (bscaling)
{
// User defined code if the
// bar object has an additional scale
...
}
Else
{
// User defined code if the
// bar object has no additional scale
...
}
}
Parameters of the GetScaling function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Bar1" is the name of the object.
1. Read out whether the scale of the bar is displayed or not and temporarily store in bscaling.
2. Executing user-defined code, depending on the return value of the function.
WinCC: Scripting (VBS, ANSI-C, VBA)
1540 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetServerTagPrefix example
{
char* pszServerPrefix;
char* pszTagPrefix;
char* pszWindowPrefix;
int nServerPrefixLen = 0;
int nTagPrefixLen = 0;
int nTagLen = 0;
char myTagName[MAX_DM_VAR_NAME+1];
//Initialize the return value
memset(myTagName,0,MAX_DM_VAR_NAME + 1);
//Get the serverprefix the tagprefix and the windowprefix
GetServerTagPrefix(&pszServerPrefix, &pszTagPrefix, &pszWindowPrefix);
//If a serverprefix exists
if (pszServerPrefix)
{
//Get the length of the string
nServerPrefixLen = strlen(pszServerPrefix);
}
Else
{
printf("No server prefix was returned.");
return;
}
//If a tagprefix exists
if (pszTagPrefix)
{
//Get the length of the string
nTagPrefixLen = strlen(pszTagPrefix);
}
//Get the length of the tag
nTagLen = strlen("TagName");
//Check if the lenght of the
//ServerPrefix+TagPrefix+VarName + the double points < MAX_DM_VAR_NAME)
if (nServerPrefixLen + nTagPrefixLen + nTagLen+2 < MAX_DM_VAR_NAME)
{
sprintf(myTagName,"%s::%s%s",pszServerPrefix,pszTagPrefix,"TagName");
//User defined code where the
//user can do something with the return value
...
}
Else
{
printf("The resulting string is too long.");
return;
}
}
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1541
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
1. Initialize the myTagName tag.
2. Read out the server prefix, the tag prefix and the window prefix.
3. If no server prefix has been returned, a text ist output and the function is terminated.
4. If a server prefix has been returned, determine its length and temporarily store it in
nServerPrefixLen.
5. If a tag prefix has been returned, determine its length and temporarily store it in TagPrefixLen.
6. Determine the length of the tag name and temporarily store it in nVarLen.
7. If the length permitted for tag names is exceeded a text is output and the function is
terminated.
8. If the length permitted for tag names is not exceeded, the tag name required for a client
environment is compiled.
9. Executing user-defined code for processing return values.
GetServerTagPrefix example
{
char* pszServerPrefix;
char* pszTagPrefix;
char* pszWindowPrefix;
//Get the serverprefix and the tagprefix
GetServerTagPrefix(&pszServerPrefix, &pszTagPrefix, &pszWindowPrefix);
//User defined code where the
//user can do something with the return value
...
Parameters of the GetServerTagPrefix function:
"pszServerPrefix" is the tag which is written into the server prefix.
"pszTagPrefix" is the tag which is written into the tag prefix.
"pszWindowrPrefix" is the tag which is written into the window prefix.
1. Read out the server prefix, the tag prefix and the window prefix.
2. The pszServerPrefix tag contains the returned server prefix.
3. The pszTagPrefix tag contains the returned tag prefix.
4. The pszWindowPrefix tag contains the returned window prefix.
5. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
1542 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagBit example
{
BOOL bstate;
//Get the current state of the tag
bstate = GetTagBit("gs_tag_bit");
if(bstate)
{
// User defined code if the
// value of the tag is true
...
}
else
{
// User defined code if the
// value of the tag is false
...
}
}
Parameters of the GetTagBit function
"gs_tag_bit" is the name of the tag.
1. Read out the value of the tag and temporarily store it in bstate.
2. Executing user-defined code, depending on the return value of the function.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1543
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagBitStateQC example
{
DWORD dwState;
DWORD dwQC;
BOOL bValue;
dwState = 0xFFFFFFFF;
//Get the tag value
//dwstate is the tag state
bValue = GetTagBitStateQCWait("gs_tag_bit",&dwState,&dwQC);
//Create a string which includes the tag value
if (bValue)
{
// User defined code if the
// value of the tag is true
...
}
else
{
// User defined code if the
// value of the tag is false
...
}
}
Parameters of the GetTagBitStateQC function:
"gs_tag_bit" is the name of the tag.
"&dwState" is the address of the tags in which the tag status is to be stored.
"&dwQC" is the address of the tag in which the quality code is to be stored.
1. Read out the value of the tag and temporarily store it in bValue. The function puts the tag
status in dwState and the quality code in dwQC.
2. Executing user-defined code, depending on the return value of the function.
WinCC: Scripting (VBS, ANSI-C, VBA)
1544 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagBitStateWait example
{
DWORD dwstate;
BOOL bValue;
dwstate = 0xFFFFFFFF;
//Get the tag value
//dwstate is the tag state
bValue = GetTagBitStateWait("gs_tag_bit",&dwstate);
//Create a string which includes the tag value
if (bValue)
{
// User defined code if the
// value of the tag is true
...
}
else
{
// User defined code if the
// value of the tag is false
...
}
}
Parameters of the GetTagBitStateWait function:
"gs_tag_bit" is the name of the tag.
"&dwstate" is the address of the tags in which the tag status is to be stored.
1. Read out the value of the tag and temporarily store it in bstate. The function puts the tag
status in dwstate.
2. Executing user-defined code, depending on the return value of the function.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1545
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagChar example
{
char* pszValue = NULL;
char szValue[13];
//Get the current value of the tag
pszValue = GetTagChar("gs_tag_char");
if(pszValue != NULL)
{
//Copy the string
strncpy(szValue,pszValue,12);
}
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetTagChar function:
"gs_tag_char" is the name of the tag.
1. Reading the value of the tag and temporarily storing in pszValue.
2. If a valid value has been returned, store the return value of the function in the local string
szValue. A maximum of 12 characters is stored.
3. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
1546 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagCharStateQCWait example
{
DWORD dwState;
DWORD dwQC;
char* pszRetValue = NULL;
char szRetValue[13];
dwState = 0xFFFFFFFF;
//Get the tag value
pszRetValue = GetTagCharStateQCWait("gs_tag_char",&dwState, &dwQC);
if (pszRetValue != NULL)
{
//Copy the string
strncpy(szRetValue,pszRetValue,12);
}
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetTagCharStateQCWait function:
"gs_tag_char" is the name of the tag.
"&dwState" is the address of the tags in which the tag status is to be stored.
"&dwQC" is the address of the tag in which the quality code is to be stored.
1. Read out the value of the tag and temporarily store it in pszRetValue. The function puts the
tag status in dwState and the quality code in dwQC.
2. If a valid value has been returned, store the return value of the function in the local string
szRetValue. A maximum of 12 characters is stored.
3. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1547
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Beispiel GetTagCharStateWait
{
DWORD dwstate;
char szValue[11];
char* pszRetValue = NULL;
char szRetValue[13];
dwstate = 0xFFFFFFFF;
//Get the tag value
//dwstate is the tag state
pszRetValue = GetTagCharStateWait("gs_tag_char",&dwstate);
if (pszRetValue != NULL)
{
//Copy the string
strncpy(szRetValue,pszRetValue,12);
}
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetTagCharStateWait function:
"gs_tag_char" is the name of the tag.
"&dwstate" is the address of the tags in which the tag status is to be stored.
1. Read out the value of the tag and temporarily store it in pszRetValue. The function puts the
tag status in dwstate.
2. If a valid value has been returned, store the return value of the function in the local string
szRetValue. A maximum of 12 characters is stored.
3. Executing user-defined code for processing return values.
GetTagFloat example
{
float fValue;
//Get the current value of the tag
fValue = GetTagFloat("gs_tag_float");
//User defined code where the
//user can do something with the return value
...
}
WinCC: Scripting (VBS, ANSI-C, VBA)
1548 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters of the GetTagFloat function:
"gs_tag_float" is the name of the tag.
1. Read out the value of the tag and temporarily store it in fValue.
2. Executing user-defined code for processing return values.
GetTagFloatStateQCWait example
{
DWORD dwState;
DWORD dwQC;
float fValue;
dwState = 0xFFFFFFFF;
//Get the tag value
fValue = GetTagFloatStateQCWait("gs_tag_float",&dwState, &dwQC);
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetTagFloatStateQCWait function:
"gs_tag_float" is the name of the tag.
"&dwState" is the address of the tags in which the tag status is to be stored.
"&dwQC" is the address of the tag in which the quality code is to be stored.
1. Read out the value of the tag and temporarily store it in fValue. The function puts the tag
status in dwState and the quality code in dwQC.
2. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1549
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagFloatStateWait example
{
DWORD dwstate;
float fValue;
dwstate = 0xFFFFFFFF;
//Get the tag value
//dwstate is the tag state
fValue = GetTagFloatStateWait("gs_tag_float",&dwstate);
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetTagFloatStateWait function:
"gs_tag_float" is the name of the tag.
"&dwstate" is the address of the tags in which the tag status is to be stored.
1. Read out the value of the tag and temporarily store it in fValue. The function puts the tag
status in dwstate.
2. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
1550 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagMultiStateQCWait example
{
#define DATA_SIZE 5
DWORD dwState[DATA_SIZE];
DWORD dwQC[DATA_SIZE];
//define all data
BOOL lValue1; //OK when BOOL is defined as int
//careful, do not use bool as this is only 1 byte
//will overwrite following data as result
long lValue2 ;
char* szValue3;
double dblValue4 ;
/*WORD*/ long lValue5 ; //careful, do not use shorter types than int, long, ...
//will overwrite following data as result
//Set the tags
GetTagMultiStateQCWait(dwState,dwQC,"%d%d%s%f%d",
"gs_tag_bit",&lValue1,
"gs_tag_SByte",&lValue2,
"gs_tag_char",&szValue3,
"gs_tag_float",&dblValue4,
"gs_tag_word",&lValue5);
//User defined code where the
//user can do something with the return value
...
}
Parameters
Parameters of the GetTagMultiStateQCWait function:
● "dwState" is the DWord array, in which the tag states are stored.
● "dwQC" is the DWord array, in which the quality codes are stored.
● "%d%d%s%f%d" are the type descriptions of the tags to be read.
● "gs_tag_bit" is the tag to be read.
● "&lValue1" is the address of the tags in which the value of the tags gs_tag_bit should be
stored.
● "gs_tag_SByte" is the tag to be read.
● "&lValue2" is the address of the tags in which the value of the tags gs_tag_SByte should
be stored.
The other parameters are to be handled in the same way as those described previously.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1551
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Procedure
1. Create a DWord array with the required size (number of tags).
2. Reading and storing the values of the tags.
– The value of the tags gs_tag_bit is stored temporarily in lValue1.
– The value of the tags gs_tag_SByte is stored temporarily in lValue2, etc.
Only use the tag types "int", "long" or greater for the following formats:
– %d, %u
Only use the tag type "double" or greater for the following formats:
– %e, %E, %g, %G, %f
Overwriting occurs with smaller data formats.
If you need the BYTE or WORD tag types for example, use separate tags that you can
convert to the required type.
3. Executing user-defined code for processing return values.
GetTagMultiStateWait example
{
#define DATA_SIZE 5
DWORD dwData[DATA_SIZE];
//define all data
BOOL lValue1; //OK when BOOL is defined as int
//careful, do not use bool as this is only 1 byte
//will overwrite following data as result
long lValue2 ;
char* szValue3;
double dblValue4 ;
/*WORD*/ long lValue5 ; //careful, do not use shorter types than int, long, ...
//will overwrite following data as result
//Set the tags
GetTagMultiStateWait(dwData,"%d%d%s%f%d",
"gs_tag_bit",&lValue1,
"gs_tag_SByte",&lValue2,
"gs_tag_char",&szValue3,
"gs_tag_float",&dblValue4,
"gs_tag_word",&lValue5);
//User defined code where the
//user can do something with the return value
...
}
WinCC: Scripting (VBS, ANSI-C, VBA)
1552 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters
Parameters of the GetTagMultiStateWait function:
● "dwData" is the DWord array, in which the tag states are stored.
● "%d%d%s%f%d" are the type descriptions of the tags to be read.
● "gs_tag_bit" is the tag to be read.
● "&lValue1" is the address of the tags in which the value of the tags gs_tag_bit should be
stored.
● "gs_tag_SByte" is the tag to be read.
● "&lValue2" is the address of the tags in which the value of the tags gs_tag_SByte should
be stored.
The other parameters are to be handled in the same way as those described previously.
Procedure
1. Create a DWord array with the required size (number of tags).
2. Reading and storing the values of the tags.
– The value of the tags gs_tag_bit is stored temporarily in lValue1.
– The value of the tags gs_tag_SByte is stored temporarily in lValue2, etc.
Only use the tag types "int", "long" or greater for the following formats:
– %d, %u
Only use the tag type "double" or greater for the following formats:
– %e, %E, %g, %G, %f
Overwriting occurs with smaller data formats.
If you need the BYTE or WORD tag types for example, use separate tags that you can
convert to the required type.
3. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1553
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagMultiWait example
DWORD dwVar1Value;
char* szVar2Value;
//Memory for the tag value is
//created by teh function with SysMalloc
double dbVar3Value;
BOOL ok;
ok=GetTagMultiWait("%d%s%f", "Ernie_word", &dwVar1Value,
"Ernie_char", &szVar2Value,
"Ernie_double", &dbVar3Value);
printf("Word %d, String %s, Double %f\r\n",
dwVar1Value, szVar2Value, dbVar3Value);
GetTagPrefix example
{
char* pszTagPrefix = NULL;
char szTagPrefix[7];
//Get the current tag prefix
pszTagPrefix = GetTagPrefix(lpszPictureName,"PicWindow1");
if(pszTagPrefix != NULL)
{
//Copy the string
strncpy(szTagPrefix,pszTagPrefix,6);
}
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetTagPrefix function:
"lpszPictureName" is the name of the picture in which the object was configured.
"PictureWindow1" is the name of the object.
1. Read out the current tag prefix of picture window 1 and temporarily store it in pszTagPrefix.
2. If a valid value has been returned, store the return value of the function in the local string
szTagPrefix. A maximum of 6 characters is stored.
3. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
1554 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagRaw example
{
#define DATA_SIZE 3
BYTE byData[DATA_SIZE];
//Get the current values of the tag
GetTagRaw("gs_tag_raw",byData,DATA_SIZE);
//Use the values received in the array byData
...
}
Parameters of the GetTagRaw function:
"gs_tag_raw" is the name of the tag.
"byData" is the byte array in which the values of the raw data tags will be stored.
"DATA_SIZE" is the number of values that will be read.
1. Reading the values of the tags and temporarily storing in byData.
2. Executing user-defined code for processing return values.
GetTagRawStateQCWait example
{
#define DATA_SIZE 3
DWORD dwState;
DWORD dwQC;
BYTE byData[DATA_SIZE];
dwState = 0xFFFFFFFF;
//Get the values of the tag
GetTagRawStateQCWait("gs_tag_raw",byData,DATA_SIZE,&dwState,&dwQC);
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetTagRawStateQCWait function:
"gs_tag_raw" is the name of the tag.
"byData" is the byte array in which the values of the raw data tags will be stored.
"DATA_SIZE" is the number of values that will be read.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1555
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
"&dwState" is the address of the tags in which the tag status is to be stored.
"&dwQC" is the address of the tag in which the quality code is to be stored.
1. Reading the values of the tags and temporarily storing in byData.
2. Executing user-defined code for processing return values.
GetTagRawStateWait example
{
#define DATA_SIZE 3
DWORD dwstate;
BYTE byData[DATA_SIZE];
char szValue[11];
//Load dwState with default values
dwstate = 0xFFFFFFFF;
//Get the values of the tag
//dwstate is the tag state
GetTagRawStateWait("gs_tag_raw",byData,DATA_SIZE,&dwstate);
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetTagRawStateWait function:
"gs_tag_raw" is the name of the tag.
"byData" is the byte array in which the values of the raw data tags will be stored.
"DATA_SIZE" is the number of values that will be read.
"&dwstate" is the address of the tags in which the tag status is to be stored.
1. Reading the values of the tags and temporarily storing in byData.
2. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
1556 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagSByte example
{
long lValue;
//Get the current value of the tag
lValue = GetTagSByte("gs_tag_SByte");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetTagSByte function:
"gs_tag_SByte" is the name of the tag.
1. Read the value of the tag and temporarily store it in lValue.
2. Executing user-defined code for processing return values.
GetTagSByteStateQCWait example
{
DWORD dwState;
DWORD dwQC;
long lValue;
dwState = 0xFFFFFFFF;
//Get the tag value
lValue = GetTagSByteStateQCWait("gs_tag_SByte",&dwState, &dwQC);
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetTagSByteStateQCWait function:
"gs_tag_SByte" is the name of the tag.
"&dwState" is the address of the tags in which the tag status is to be stored.
"&dwQC" is the address of the tag in which the quality code is to be stored.
1. Read the value of the tag and temporarily store it in lValue. The function puts the tag status
in dwState and the quality code in dwQC.
2. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1557
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagSByteStateWait example
{
DWORD dwstate;
long lValue;
dwstate = 0xFFFFFFFF;
//Get the tag value
//dwstate is the tag state
lValue = GetTagSByteStateWait("gs_tag_SByte",&dwstate);
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetTagSByteStateWait function:
"gs_tag_SByte" is the name of the tag.
"&dwstate" is the address of the tags in which the tag status is to be stored.
1. Read the value of the tag and temporarily store it in lValue. The function puts the tag status
in dwstate.
2. Executing user-defined code for processing return values.
GetTagWord example
{
WORD wValue;
//Get the current value of the tag
wValue = GetTagWord("gs_tag_word");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetTagWord function:
"gs_tag_word" is the name of the tag.
1. Read out the value of the tag and temporarily store it in wValue.
2. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
1558 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetTagWordStateQCWait example
{
DWORD dwState;
DWORD dwQC;
WORD wValue;
dwState = 0xFFFFFFFF;
//Get the tag value
wValue = GetTagWordStateQCWait("gs_tag_word",&dwState, &dwQC);
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetTagWordStateQCWait function:
"gs_tag_word" is the name of the tag.
"&dwState" is the address of the tags in which the tag status is to be stored.
"&dwQC" is the address of the tag in which the quality code is to be stored.
1. Read out the value of the tag and temporarily store it in wValue. The function puts the tag
status in dwState and the quality code in dwQC.
2. Executing user-defined code for processing return values.
GetTagWordStateWait example
{
DWORD dwstate;
WORD wValue;
dwstate = 0xFFFFFFFF;
//Get the tag value
//dwstate is the tag state
wValue = GetTagWordStateWait("gs_tag_word",&dwstate);
//User defined code where the
//user can do something with the return value
...
}
Parameters of then GetTagWordStateWait function:
"gs_tag_word" is the name of the tag.
"&dwstate" is the address of the tags in which the tag status is to be stored.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1559
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
1. Read out the value of the tag and temporarily store it in wValue. The function puts the tag
status in dwstate.
2. Executing user-defined code for processing return values.
GetText example
{
char* pszValue = NULL;
char szValue[13];
//Get the Text which is actually set
pszValue = GetText(lpszPictureName,"StaticText1");
if(pszValue != NULL)
{
//Copy the string
strncpy(szValue,pszValue,12);
}
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetText function:
"lpszPictureName" is the name of the picture in which the object was configured.
"StaticText1" is the name of the object.
1. Read out the text in the object StaticText1 and temporarily store it in pszValue.
2. If a valid value has been returned, store the return value of the function in the local string
szValue. A maximum of 12 characters is stored.
3. Executing user-defined code for processing return values.
GetTop example
{
long lPos;
//Get the y-Position of the Object
lPos = GetTop(lpszPictureName,"WinCCLogo");
//User defined code where the
//user can do something with the return value
...
}
WinCC: Scripting (VBS, ANSI-C, VBA)
1560 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters of the GetTop function:
"lpszPictureName" is the name of the picture in which the object was configured.
"WinCCLogo" is the name of the object.
1. Read out the current Y position of the object and temporarily store it in lPos.
2. Executing user-defined code for processing return values.
GetVisible example
{
BOOL bVisible;
//Get the visibility
bVisible = GetVisible(lpszPictureName,"GraphicObject1");
if(bVisible)
{
// User defined code if the
// object is visible
...
}
else
{
// User defined code if the
// object is not visible
...
}
}
Parameters of the GetVisible function:
"lpszPictureName" is the name of the picture in which the object was configured.
"GraphicObject1" is the name of the object.
1. Read out whether the object is visible or not and temporarily store in bVisible.
2. Executing user-defined code, depending on the return value of the function.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1561
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
GetWidth example
{
long lWidth;
//Get the width of the object
lWidth = GetWidth(lpszPictureName,"WinCCLogo");
//User defined code where the
//user can do something with the return value
...
}
Parameters of the GetWidth function:
"lpszPictureName" is the name of the picture in which the object was configured.
"WinCCLogo" is the name of the object.
1. Read out the current width of the object and temporarily store it in lWidth.
2. Executing user-defined code for processing return values.
2.15.4.4 Examples - H to S
InquireLanguage example
{
DWORD count;
DWORD* language;
int i;
//Count the installed languages
language = InquireLanguage(&count);
printf("##################### INQUIRE LANGUAGE ####################");
//Print out the count of languages
printf ( "\r\nCount Languages=%d\r\n", count );
//print out which languages are installed
for (i=1;i<=count; i++)
{
printf ("\r\n%d.language=%x", i,*language++);
}
}
1. Determine the languages configured for the runtime. In language the language IDs are
temporarily stored. In count the number of languages is temporarily stored.
WinCC: Scripting (VBS, ANSI-C, VBA)
1562 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2. The number of determined languages is output.
3. All determined language IDs are displayed.
ProgramExecute example
{
//start the program calc.exe
ProgramExecute("C:\\Winnt\\system32\\calc.exe");
}
As parameter the file is to be specified with its path.
RPTJobPreview example
{
//Start the print preview of the specified print job
RPTJobPreview("Documentation Text Library");
}
Parameters of the "RPTJobPreview" function:
"Documentation Text Library" is the name of the print job.
RPTJobPrint example
{
//Print the specified print job out
RPTJobPrint("@Text library (compact)");
}
Parameters of the RPTJobPrint function:
@Text library (compact) is the name of the print job.
SysMalloc example
char* main(...);
{
char* returnwert;
char text[17];
returnwert=SysMalloc(17);
strcpy(returnwert,&text[0];
return returnwert;
}
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1563
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2.15.4.5 Examples - SetAlarmHigh to SetPropChar
SetAlarmHigh example
{
//Set the upper limit for the warning
SetAlarmHigh(lpszPictureName,"Bar1",3.0);
}
Parameters of the SetAlarmHigh funtion:
"lpszPictureName" is the name of the picture in which the object was configured.
"Bar1" is the name of the object.
"3.0" is the value to which the upper alarm limit will be set.
SetBackColor example
{
//Set the back color blue
SetBackColor(lpszPictureName,"StaticText1",CO_BLUE);
}
Parameters of the SetBackColor function:
"lpszPictureName" is the name of the picture in which the object was configured.
"StaticText1" is the name of the object.
"CO_BLUE" is the constant for the color "Blue".
Note
Instead of using the constant for the color value you may also specify the color by means of
a hexadecimal value.
SetBorderEndStyle example
{
SetBorderEndStyle(lpszPictureName,"Line", (2|393216));
}
WinCC: Scripting (VBS, ANSI-C, VBA)
1564 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Sets the left line end as filled arrow and the right one as filled circle. The left line end is stored
in the two lower bytes, the right line end in the two upper bytes. The parameters are transferred
by means of numeric values.
Example of setting the line ends with symbolic names
{
SetBorderEndStyle(lpszPictureName,"Line", (LE_FULL_ARROW|(LE_FULL_CIRCLE <<16));
}
Sets the left line end as filled arrow and the right one as filled circle. The left line end is stored
in the two lower bytes, the right line end in the two upper bytes. To address the right line end
the symbolic designation "LE_FULL_CIRCLE" is moved by 2 bytes or 16 bit into the two upper
bytes.
SetBorderStyle example
{
//Change the Border style
SetBorderStyle(lpszPictureName,"Rectangle1",3);
}
Parameters of the SetBorderStyle function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Rectangle1" is the name of the object.
"3" is the line style which is set for the object.
SetColorAlarmHigh example
{
//Set the Color for the alarm high limit to red
SetColorAlarmHigh(lpszPictureName,"Bar1",CO_RED);
}
Parameters of the SetColorAlarmHigh function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Bar1" is the name of the object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1565
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
"CO_RED" is the constant for the color red.
Note
Instead of using the constant for the color value you may also specify the color by means of
a hexadecimal value.
Example - SetCursorMode
{
//Set the Cursor Mode to Alpha cursor
SetCursorMode(lpszPictureName,"GraphikObjekt1",FALSE);
}
Parameters of the SetCursorMode function:
"lpszPictureName" is the name of the picture in which the object was configured.
"GraphicObject1" is the name of the object.
"FALSE" signifies: Cursor mode "Alpha-Cursor" is set.
SetFilling example
{
//Set the dynamic filling true
SetFilling(lpszPictureName,"Rectangle1",TRUE);
}
Parameters of the SetFilling function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Rectangle1" is the name of the object.
"TRUE" means: Activating dynamic filling.
SetFillingIndex example
{
//Set the Filling of Rectangle1 to 10
SetFillingIndex(lpszPictureName,"Rectangle1",10);
}
Parameters of the SetFillingIndex function:
WinCC: Scripting (VBS, ANSI-C, VBA)
1566 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
"lpszPictureName" is the name of the picture in which the object was configured.
"Rectangle1" is the name of the object.
"10" is the fill level which is assigned to the object.
SetFillStyle example
{
//Change the fill style
SetFillStyle(lpszPictureName,"Rectangle1",196617);
}
Parameters of the SetFillStyle function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Rectangle1" is the name of the object.
"196617" is the fill pattern (brick wall) which is set for the object.
SetFlashBackColor example
{
//Set the flashing to True
SetFlashBackColor(lpszPictureName,"Group1",TRUE);
}
Parameters of the SetFlashBackColor function
"lpszPictureName" is the name of the picture in which the object was configured.
"Group1" is the name of the object.
"TRUE" means: Activating flashing of the background color.
SetFlashBackColorOn example
{
//Set the Flash color for the state on to red
SetBackFlashColorOn(lpszPictureName,"Group1",CO_RED);
}
Parameters of the SetBackFlashColorOn function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Group1" is the name of the object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1567
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
"CO_Red" is the constant for the color "Red".
Note
Instead of using the constant for the color value you may also specify the color by means of
a hexadecimal value.
SetFlashRateFlashPic example
{
//Set the flash rate to 0
SetFlashRateFlashPic(lpszPictureName,"Statusdisplay1",0);
}
Parameters of the SetFlashRateFlashPic function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Status display1" is the name of the object.
"0" is the flash frequency of the object.
SetFocus example
{
//Set the Focus on the Object Button 1
Set_Focus(lpszPictureName,"Button1");
}
Parameters of the Set_Focus function
"lpszPictureName" is the name of the picture in which the object was configured.
"Button1" is the name of the object on which the focus is set.
SetFontBold example
{
//Set the displayed Text bold
SetFontBold(lpszPictureName,"StatischerText1",TRUE);
}
Parameters of the SetFontBold function:
"lpszPictureName" is the name of the picture in which the object was configured.
WinCC: Scripting (VBS, ANSI-C, VBA)
1568 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
"StaticText1" is the name of the object.
"TRUE" means: The text is written in bold face.
SetFontSize example
{
//Set Font Size to 12
SetFontSize(lpszPictureName,"StaticText1",12);
}
Parameters of the SetFontSize function:
"lpszPictureName" is the name of the picture in which the object was configured.
"StaticText1" is the name of the object.
"12" is the font size to which the text is set.
SetHeight example
{
//Set the height of the object to 100
SetHeight(lpszPictureName,"WinCCLogo",100);
}
Parameters of the SetHeight function:
"lpszPictureName" is the name of the picture in which the object was configured.
"WinCCLogo" is the name of the object.
"100" is the height to which the object is set.
SetHiddenInput example
{
//Set the hidden input true
SetHiddenInput(lpszPictureName,"IOField1",TRUE);
}
Parameters of the SetHiddenInput function:
"lpszPictureName" is the name of the picture in which the object was configured.
"IOField1" is the name of the object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1569
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
"TRUE" means: Activating the hidden input.
SetLanguage example
{
//German
SetLanguage(0x0407);
}
The Runtime language is set to German.
SetLeft example
{
//Set the x-position to 0
SetLeft(lpszPictureName,"WinCCLogo",0);
}
Parameters of the SetLeft function:
"lpszPictureName" is the name of the picture in which the object was configured.
"WinCCLogo" is the name of the object.
"0" is the X position to which the object is set.
SetLink example
{
LINKINFO linkinfo;
//Set the link type
linkinfo.LinkType = 1;
//Set the update cycle
linkinfo.dwCycle = 0;
//set the Structmember
strcpy(linkinfo.szLinkName, "U08i_link_00");
//Set the connection to the tag
SetLink(lpszPictureName,"Bar1","Process",&linkinfo);
}
WinCC: Scripting (VBS, ANSI-C, VBA)
1570 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters of the SetLink function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Bar1" is the name of the object.
"Process" is the property connected to a tag.
"&linkinfo" is the address of the linkinfo structure.
1. Set the connection type for the process property to direct connection.
2. Set the update cycle to "Upon change".
3. Set the tag name to U08i_link_00.
SetMarker example
{
//Set the marker visible
SetMarker(lpszPictureName,"Bar1",TRUE);
}
Parameters of the SetMarker function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Bar1" is the name of the object.
"TRUE" means: The marker is displayed.
SetOutputValueDouble example
{
//Set the output value of the IO field to 55.5
SetOutputValueDouble(lpszPictureName,"IOField1",55.5);
}
Parameters of the SetOutputValueDouble function:
"lpszPictureName" is the name of the picture in which the object was configured.
"IOField1" is the name of the object.
"55.5" is the value which is output.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1571
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetPictureDown example
{
//Set the picture name to activated.bmp
SetPictureDown(lpszPictureName,"Roundbutton1","activated.bmp");
}
Parameters of the SetPictureDown function:
"lpszPictureName" is the name of the picture in which the object was configured.
"RoundButton1" is the name of the object.
"activated.bmp" is the picture name of the picture to be displayed in round button 1.
SetPictureName example
{
//Set the picture name cool_man.bmp
SetPictureName(lpszPictureName,"GraphicObject1","cool_man.bmp");
}
Parameters of the SetPictureName function:
"lpszPictureName" is the name of the picture in which the object was configured.
"GraphicObject1" is the name of the object.
"cool_man.bmp" is the picture name of the picture to be displayed in graphic object 1.
SetPictureUp example
{
//Set the picture name to deactivated.bmp
SetPictureUp(lpszPictureName,"Roundbutton1","deactivated.bmp");
}
Parameters of the SetPictureUp function:
"lpszPictureName" is the name of the picture in which the object was configured.
"RoundButton1" is the name of the object.
"deactivated.bmp" is the picture name of the picture to be displayed in round button 1.
WinCC: Scripting (VBS, ANSI-C, VBA)
1572 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetPosition example
{
//Set the Slider Position to 30
SetPosition(lpszPictureName,"Control1",30);
}
Parameters of the SetPosition function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Control1" is the name of the object.
"30" is the position to which the slider is to be set.
SetPropBOOL example
{
//Set the visibility TRUE
SetPropBOOL("lpszPictureName","EAFeld1","Visible",TRUE);
}
Parameters of the SetVisible function:
"lpszPictureName" is the name of the picture in which the object was configured.
"IOField1" is the name of the object.
"TRUE" means: The object is intended to be visible.
SetPropChar example
{
//Set the property Tooltiptext
SetPropChar("gs_graph_eafield","IOField1","ToolTipText","Tooltiptext1 ");
}
Parameters of the SetPropChar function:
"lpszPictureName" is the name of the picture in which the object was configured.
"IOField1" is the name of the object.
"Tooltiptext" is the object property.
"Tooltiptext 1" is the value to which the property is to be set.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1573
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2.15.4.6 Examples - SetRangeMax to SetWidth
SetRangeMax example
{
//Set the Upper Scale Limit
SetRangeMax(lpszPictureName,"Control1",80);
}
Parameters of the SetRangeMax function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Control1" is the name of the object.
"80" is the upper limit to be assigned to the object.
SetRangeMin example
{
//Set the lower Scale Limit
SetRangeMin(lpszPictureName,"Control1",0);
}
Parameters of the SetRangeMin function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Control1" is the name of the object.
"0" is the lower limit to be assigned to the object.
SetScaling example
{
//Set the Scaling Visible
SetScaling(lpszPictureName,"Bar1",TRUE);
Parameters of the SetScaling function:
"lpszPictureName" is the name of the picture in which the object was configured.
"Bar1" is the name of the object.
"TRUE" means: Making the scaling visible.
WinCC: Scripting (VBS, ANSI-C, VBA)
1574 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetTagBit example
{
//Set the tag to true
SetTagBit("gs_tag_bit",TRUE);
}
Parameters of the SetTagBit function:
"gs_tag_bit" is the name of the tag.
"TRUE" is the value to be written to the tag.
Beispiel SetTagBitStateWait
{
DWORD dwstate;
//Load dwState with default values
dwstate = 0xFFFFFFFF;
//Set the value of the tag to TRUE
//dwstate is the tag state
SetTagBitStateWait("gs_tag_bit",TRUE,&dwstate);
//User defined code where the
//user can do something with the return value
...
}
Parameters of the SetTagBitStateWait function:
"gs_tag_bit" is the name of the tag.
"TRUE" is the value to be written to the tag.
"&dwstate" is the address of the tags in which the tag status is to be stored.
1. Setting the tags to the specified value.
2. Executing user-defined code for processing return values.
SetTagChar example
{
//Set the tag to Example text
SetTagChar("gs_tag_char","Example Text");
}
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1575
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters of the SetTagChar function:
"gs_tag_char" is the name of the tag.
"Example text" is the value to be written to the tag.
SetTagCharStateWait example
{
DWORD dwstate;
//Load dwState with default values
dwstate = 0xFFFFFFFF;
//Set the tag to Example Text
//dwstate is the tag state
SetTagCharStateWait("gs_tag_char","Example Text",&dwstate);
//User defined code where the
//user can do something with the return value
...
}
Parameters of the SetTagCharStateWait function:
"gs_tag_char" is the name of the tag.
"Example text" is the value to be written to the tag.
"&dwstate" is the address of the tags in which the tag status is to be stored.
1. Setting the tags to the specified value.
2. Executing user-defined code for processing return values.
SetTagFloat example
{
//Set the tag to 55.4711
SetTagFloat("gs_tag_float",55.4711);
}
Parameters of the SetTagFloat function:
"gs_tag_float" is the name of the tag.
"55.4711" is the value to be written to the tag.
WinCC: Scripting (VBS, ANSI-C, VBA)
1576 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetTagFloatStateWait example
{
DWORD dwstate;
char szValue[9];
//Load dwState with default values
dwstate = 0xFFFFFFFF;
//Set the tag to 55.4711
//dwstate is the tag state
SetTagFloatStateWait("gs_tag_float",55.4711,&dwstate);
//User defined code where the
//user can do something with the return value
...
}
Parameters of the SetTagFloatStateWait function:
"gs_tag_float" is the name of the tag.
"55.4711" is the value to be written to the tag.
"&dwstate" is the address of the tags in which the tag status is to be stored.
1. Setting the tags to the specified value.
2. Executing user-defined code for processing return values.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1577
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetTagMultiStateWait example
{
#define DATA_SIZE 5
DWORD dwData[DATA_SIZE];
//define all tags
BOOL lValue1; //OK when BOOL is defined as int
//careful, do not use bool as this is only 1 byte
//will set a wrong value as result
long lValue2;
char szValue3[_MAX_PATH];
/*float*/ double lValue4; //careful, do not use float, this is shorter than double
//will set a wrong value as result
/*char*/ long lValue5; //careful, do not use shorter types than int, long, ...
//will set a wrong value as result
// Fill the tags with the values
// you want to set into the WinCC tags
...
//Set the WinCC tags
SetTagMultiStateWait(dwData,"%d%d%s%f%d","gs_tag_bit",lValue1,
"gs_tag_SByte",lValue2,
"gs_tag_char",szValue3,
"gs_tag_float",lValue4,
"gs_tag_word",lValue5);
//User defined code where the
//user can do something with the return value
...
}
Parameters
Parameters of the SetTagMultiStateWait function:
● "dwData" is the DWord array, in which the tag states are stored.
● "%d%d%s%f%d" are the type descriptions of the tags to be written.
● "gs_tag_bit" is the WinCC tag to be written.
● "lValue1" is the tag to whose value the WinCC tag gs_tag_bit is to be set.
● "gs_tag_SByte" is the WinCC tag to be written.
● "&lValue2" is the tag to whose value the WinCC tag gs_tag_SByte is to be set.
The other parameters are to be handled in the same way as those described previously.
WinCC: Scripting (VBS, ANSI-C, VBA)
1578 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Procedure
1. Create a DWord array with the required size (number of tags).
2. Create tags whose values are to be written to the WinCC tags.
Only use the tag types "int", "long" or greater for the following formats:
– %d, %u
Only use the tag type "double" or greater for the following formats:
– %e, %E, %g, %G, %f
Otherwise incorrect values are set.
3. Writing the values of the previously created and filled tags to the WinCC tags.
4. Executing user-defined code for processing return values.
See also
SetTagMultiStateWait (Page 1476)
SetTagMultiWait example
BOOL ok;
ok=SetTagMultiWait("%d%s%f", "Ernie_word", 16,
"Ernie_char", "Hello World",
"Ernie_double", 55.4711);
SetTagPrefix example
{
//Set the TagPrefix to Struct1.
SetTagPrefix(lpszPictureName,"PicWindow1","Struct1.");
//Set the picture name again to update the tag prefix
SetPictureName(lpszPictureName,"PicWindow1","gs_graph_eafield");
}
Parameters of the SetTagPrefix function:
"lpszPictureName" is the name of the picture in which the object was configured.
"PictureWindow1" is the name of the object.
"Struct1." is the tag prefix to be set at picture window 1.
1. Set the tag prefix of the object "PictureWindow1" to "Struct1.".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1579
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2. Reset the name of the picture shown in the picture window to make the tag prefix setting
effective.
SetTagRaw example
{
#define DATA_SIZE 3
BYTE byData[DATA_SIZE];
// Fill the Byte array with the values
// you want to set into the raw data tag
...
//Set the tag to the default values
SetTagRaw("gs_tag_raw",byData,DATA_SIZE);
}
Parameters of the SetTagRaw function:
"gs_tag_raw" is the name of the tag.
"byData" is the byte array whose values are written to the raw data tags.
"DATA_SIZE" is the number of values that will be written.
1. Creating a BYTE-Array with the required size (size of the raw data tag).
2. Filling the BYTE-Array with the values to be written.
3. Writing the values of the BYTE-Array to the raw data tag.
WinCC: Scripting (VBS, ANSI-C, VBA)
1580 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetTagRawStateWait example
{
#define DATA_SIZE 3
BYTE byData[DATA_SIZE];
DWORD dwstate;
char szValue[9];
//Load dwState with default values
dwstate = 0xFFFFFFFF;
// Fill the Byte array with the values
// you want to set into the raw data tag
...
//Set the tag to the default values
//dwstate is the tag state
SetTagRawStateWait("gs_tag_raw",byData,DATA_SIZE,&dwstate);
//User defined code where the
//user can do something with the return value
...
}
Parameters of the SetTagRawStateWait function:
"gs_tag_raw" is the name of the tag.
"byData" is the byte array whose values are written to the raw data tags.
"DATA_SIZE" is the number of values that will be written.
"&dwstate" is the address of the tags in which the tag status is to be stored.
1. Creating a BYTE-Array with the required size (size of the raw data tag).
2. Filling the BYTE-Array with the values to be written.
3. Writing the values of the BYTE-Array to the raw data tag.
4. Executing user-defined code for processing return values.
SetTagSByte example
{
//Set the tag to 50
SetTagSByte("gs_tag_SByte",50);
}
Parameters of the SetTagSByte function:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1581
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
"gs_tag_SByte" is the name of the tag.
"50" is the value to be written to the tag.
Beispiel SetTagSByteStateWait
{
DWORD dwstate;
char szValue[9];
//Load dwState with default values
dwstate = 0xFFFFFFFF;
//Set the tag to 50
//dwstate is the tag state
SetTagSByteStateWait("gs_tag_SByte",50,&dwstate);
//User defined code where the
//user can do something with the return value
...
}
Parameters of the SetTagSByteStateWait:
"gs_tag_SByte" is the name of the tag.
"50" is the value to be written to the tag.
"&dwstate" is the address of the tags in which the tag status is to be stored.
1. Setting the tags to the specified value.
2. Executing user-defined code for processing return values.
SetTagWord example
{
//Set the tag to 50
SetTagWord("gs_tag_word",50);
}
Parameters of the SetTagWord function:
"gs_tag_word" is the name of the tag.
"50" is the value to be written to the tag.
WinCC: Scripting (VBS, ANSI-C, VBA)
1582 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Beispiel SetTagWordStateWait
{
DWORD dwstate;
char szValue[9];
//Load dwState with default values
dwstate = 0xFFFFFFFF;
//Set the tag to 50
//dwstate is the tag state
SetTagWordStateWait("gs_tag_word",50,&dwstate);
//User defined code where the
//user can do something with the return value
...
}
Parameters of the SetTagWordStateWait funtion:
"gs_tag_word" is the name of the tag.
"50" is the value to be written to the tag.
"&dwstate" is the address of the tags in which the tag status is to be stored.
1. Setting the tags to the specified value.
2. Executing user-defined code for processing return values.
SetText example
{
//Set the text Example Text on the StaticText field
SetText(lpszPictureName,"StaticText1","Example Text");
}
Parameters of the SetText function:
"lpszPictureName" is the name of the picture in which the object was configured.
"StaticText1" is the name of the object.
"ExampleText" is the text which is to be output.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1583
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
SetTop example
{
//Set the y-position to 0
SetTop(lpszPictureName,"WinCCLogo",140);
}
Parameters of the SetTop function:
"lpszPictureName" is the name of the picture in which the object was configured.
"WinCCLogo" is the name of the object.
"140" is the Y position to which the object is set.
SetVisible example
{
//Set the Object visible
SetVisible(lpszPictureName,"GraphicObject1",TRUE);
}
Parameters of the SetVisible function:
"lpszPictureName" is the name of the picture in which the object was configured.
"GraphicObject1" is the name of the object.
"TRUE" means: The object is intended to be visible.
SetWidth example
{
//Set the width of the object to 400
SetWidth(lpszPictureName,"WinCCLogo",400);
}
Parameters of the SetWidth function
"lpszPictureName" is the name of the picture in which the object was configured.
"WinCCLogo" is the name of the object.
"400" is the width to which the object is set.
WinCC: Scripting (VBS, ANSI-C, VBA)
1584 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2.15.4.7 Examples of WinCC controls
How to add elements to a WinCC OnlineTrendControl
Introduction
In the following example, insert value columns with properties in an empty WinCC
OnlineTableControl and link the columns to archive tags.
Prerequisite
● An archive is created in the "Tag Logging Editor" with three archive tags.
● A "WinCC OnlineTableControl" with the name "Control2" is inserted in the process picture
in the Graphics Designer.
● A button is inserted in the Graphics Designer. You have configured, for example, the event
"mouse click" with a C action and the following script for the button.
Example
//enable BackColor
SetPropBOOL(lpszPictureName, "Control2", "UseColumnBackColor",TRUE);
//add new TimeColumn and assign column length
SetPropChar(lpszPictureName, "Control2", "TimeColumnAdd", "myRefTimeColumn");
SetPropWord(lpszPictureName, "Control2", "TimeColumnLength", 20);
//add new ValueColumn and assign properties
SetPropChar(lpszPictureName, "Control2", "ValueColumnAdd", "myValueTable1");
SetPropWord(lpszPictureName, "Control2", "ValueColumnProvider", 1);
SetPropChar(lpszPictureName, "Control2", "ValueColumnTagName", "Process value archive\
\PDL_ZT_1");
SetPropWord(lpszPictureName, "Control2", "ValueColumnBackColor", RGB(255,255,255));
SetPropChar(lpszPictureName, "Control2", "ValueColumnTimeColumn", "myRefTimeColumn");
//add new ValueColumn and assign properties
SetPropChar(lpszPictureName, "Control2", "ValueColumnAdd", "myValueTable2");
SetPropWord(lpszPictureName, "Control2", "ValueColumnProvider", 1);
SetPropChar(lpszPictureName, "Control2", "ValueColumnTagName", "Process value archive\
\PDL_ZT_2");
SetPropWord(lpszPictureName, "Control2", "ValueColumnBackColor", RGB(0,255,255));
SetPropChar(lpszPictureName, "Control2", "ValueColumnTimeColumn", "myRefTimeColumn");
//add new ValueColumn and assign properties
SetPropChar(lpszPictureName, "Control2", "ValueColumnAdd", "myValueTable3");
SetPropWord(lpszPictureName, "Control2", "ValueColumnProvider", 1);
SetPropChar(lpszPictureName, "Control2", "ValueColumnTagName", "Process value archive\
\PDL_ZT_3");
SetPropWord(lpszPictureName, "Control2", "ValueColumnBackColor", RGB(255,255,0));
SetPropChar(lpszPictureName, "Control2", "ValueColumnTimeColumn", "myRefTimeColumn");
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1585
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Result
How to add elements to a WinCC OnlineTrendControl
Introduction
In the following example you insert the Trend Window, Value Axis, Time Axis and Trends
elements into an empty WinCC OnlineTrendControl.
Prerequisite
● An archive is created in the "Tag Logging Editor" with three archive tags.
● A "WinCC OnlineTrendControl" with the name "Control2" is inserted in the process picture
in the Graphics Designer.
● A button is inserted in the Graphics Designer. You have configured, for example, the event
"mouse click" with a C action and the following script for the button.
WinCC: Scripting (VBS, ANSI-C, VBA)
1586 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Example
//create reference to new window, time and value axis
SetPropChar(lpszPictureName, "Control2", "TrendWindowAdd", "myWindow");
SetPropChar(lpszPictureName, "Control2", "TimeAxisAdd", "myTimeAxis");
SetPropChar(lpszPictureName, "Control2", "ValueAxisAdd", "myValueAxis");
//assign time and value axis to the window
SetPropChar(lpszPictureName, "Control2", "TimeAxisTrendWindow", "myWindow");
SetPropChar(lpszPictureName, "Control2", "ValueAxisTrendWindow", "myWindow");
//add new trend and assign properties
SetPropChar(lpszPictureName, "Control2", "TrendAdd", "myTrend1");
SetPropWord(lpszPictureName, "Control2", "TrendProvider", 1);
SetPropChar(lpszPictureName, "Control2", "TrendTagName", "Process value archive\
\PDL_ZT_1");
SetPropWord(lpszPictureName, "Control2", "TrendColor", RGB(255,0,0));
SetPropChar(lpszPictureName, "Control2", "TrendTrendWindow", "myWindow");
SetPropChar(lpszPictureName, "Control2", "TrendTimeAxis", "myTimeAxis");
SetPropChar(lpszPictureName, "Control2", "TrendValueAxis", "myValueAxis");
//add new trend and assign properties
SetPropChar(lpszPictureName, "Control2", "TrendAdd", "myTrend2");
SetPropWord(lpszPictureName, "Control2", "TrendProvider", 1);
SetPropChar(lpszPictureName, "Control2", "TrendTagName", "Process value archive\
\PDL_ZT_2");
SetPropWord(lpszPictureName, "Control2", "TrendColor", RGB(0,255,0));
SetPropChar(lpszPictureName, "Control2", "TrendTrendWindow", "myWindow");
SetPropChar(lpszPictureName, "Control2", "TrendTimeAxis", "myTimeAxis");
SetPropChar(lpszPictureName, "Control2", "TrendValueAxis", "myValueAxis");
//add new trend and assign properties
SetPropChar(lpszPictureName, "Control2", "TrendAdd", "myTrend3");
SetPropWord(lpszPictureName, "Control2", "TrendProvider", 1);
SetPropChar(lpszPictureName, "Control2", "TrendTagName", "Process value archive\
\PDL_ZT_3");
SetPropWord(lpszPictureName, "Control2", "TrendColor", RGB(0,0,255));
SetPropChar(lpszPictureName, "Control2", "TrendTrendWindow", "myWindow");
SetPropChar(lpszPictureName, "Control2", "TrendTimeAxis", "myTimeAxis");
SetPropChar(lpszPictureName, "Control2", "TrendValueAxis", "myValueAxis");
2.15.4.8 Examples - Obsolete functions
AXC_OnBtnMsgFirst example
{
// jump to the first message in the WinCC Alarm Control
AXC_OnBtnMsgFirst("gs_alarm_00","Control1");
}
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1587
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters of the AXC_OnBtnMsgFirst function:
"gs_alarm_00" is the name of the picture in which WinCC Alarm Control was configured.
Control1 is the object name of the WinCC Alarm Control.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
Beispiel AXC_OnBtnMsgLast
{
// jump to the last message in the WinCC Alarm Control
AXC_OnBtnMsgLast("gs_alarm_00","Control1");
}
Parameters of the AXC_OnBtnMsgLast function:
"gs_alarm_00" is the name of the picture in which WinCC Alarm Control was configured.
Control1 is the object name of the WinCC Alarm Control.
AXC_OnBtnScroll example
{
// activate/deactivate the scroll function
AXC_OnBtnScroll("gs_alarm_00","Control1");
}
Parameters of the AXC_OnBtnScroll function:
"gs_alarm_00" is the name of the picture in which WinCC Alarm Control was configured.
Control1 is the object name of the WinCC Alarm Control.
AXC_OnBtnSinglAckn example
{
// acknowledge the active message
AXC_OnBtnSinglAckn("gs_alarm_00","Control1");
}
WinCC: Scripting (VBS, ANSI-C, VBA)
1588 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Parameters of the AXC_OnBtnSinglAckn function:
"gs_alarm_00" is the name of the picture in which WinCC Alarm Control was configured.
Control1 is the object name of the WinCC Alarm Control.
AXC_SetFilter example
{
BOOL ret;
MSG_FILTER_STRUCT Filter;
CMN_ERROR Error;
//Reset the filter struct
memset( &Filter, 0, sizeof( MSG_FILTER_STRUCT ) );
//Set the filter name
strcpy( Filter.szFilterName, "Control1");
// Choose selection elements
Filter.dwFilter = MSG_FILTER_NR_FROM | MSG_FILTER_NR_TO;
// Message number from
Filter.dwMsgNr[0] = 2;
// Message number to
Filter.dwMsgNr[1] = 2;
ret = AXC_SetFilter("gs_alarm_00","Control1",&Filter,&Error);
}
1. Name the filter.
2. Select the filter type.
3. Specify the filter criteria.
4. Set the filter.
Note
The filter type and the filter criteria are to be adapted, all other filter types are described in the
filter structure.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1589
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
ResetFilter example
{
BOOL ret;
MSG_FILTER_STRUCT Filter;
CMN_ERROR Error;
//delete the whole Filter struct
memset( &Filter, 0, sizeof( MSG_FILTER_STRUCT ) );
//set an empty filter struct
AXC_SetFilter("gs_alarm_00","Control1",&Filter,&Error);
}
1. Delete the filter structure.
2. Write empty values into the filter structure.
TlgGetNumberOfColumns example
{
char text[5];
long int columns
//get number of Columns
columns = GetNumberOfColumns("TableControl_01");
//convert long int to char
sprintf(text,"%d",columns);
//set text on TextField5
SetText(lpszPictureName,"StaticText5",text);
}
Parameters of the TlgGetNumberOfColumns function:
"TableControl_01" is the name of the WinCC Table Control.
1. Temporarily store the return value of the TlgGetNumberofColumns in columns.
2. Temporarily store the return value in the text string.
WinCC: Scripting (VBS, ANSI-C, VBA)
1590 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
3. Output the return value to a static text field.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
TlgGetNumberOfRows example
{
char text[5];
long int rows;
//get number of rows
rows = TlgGetNumberOfRows("TableControl_01");
//convert long int to char
sprintf(text,"%d",rows);
//set text on TextField5
SetText(lpszPictureName,"StaticText5",text);
}
Parameters of the TlgGetNumberOfRows function:
TableControl_01 is the name of the WinCC Table Control.
1. Temporarily store the return value of the TlgGetNumberofRows in rows.
2. Temporarily store the return value in the text string.
3. Output the return value to a static text field.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1591
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
TlgGetRulerTimeTrend example
{
SYSTEMTIME systime;
WORD wHour;
WORD wMin;
WORD wSec;
char szTime[10];
//Get the current systemtime
systime = TlgGetRulerTimeTrend("TrendControl_01",0);
//Get the hour
wHour = systime.wHour;
//Get the minute
wMin = systime.wMinute;
//Get the second
wSec = systime.wSecond;
//
sprintf(szTime,"%d:%d:%d",wHour,wMin,wSec);
//output the variable name
SetText(lpszPictureName,"StaticText7",szTime);
}
1. Read out the current system time.
2. Read out hour, minute and second from the SYSTEMTIME structure.
3. Create a string containing the time.
4. Output the current time.
WinCC: Scripting (VBS, ANSI-C, VBA)
1592 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
TlgGetRulerVariableNameTrend example
{
char* pszVarName = NULL;
char szVarName[20];
//Get the ruler variable name
pszVarName = TlgGetRulerVariableNameTrend("TrendControl_01",0);
if (pszVarName != NULL)
{
//Copy the string
strncpy(szVarName,pszVarName,19);
}
//output the variable name
SetText(lpszPictureName,"StaticText6",szVarName);
}
Parameters of the TlgGetRulerVariableNameTrend function:
"TrendControl_01" is the name of the WinCC Trend Control.
"0" is the number of the trend.
1. Temporarily store the return value of the TlgGetRulerVariableNameTrend function in
pszVarName.
2. If a valid value has been returned, copy the return value to szVarName.
3. Output the return value to a static text field.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
TlgTrendWindowPressOpenDlgButton example
{
//Opens the Property Dialog
TlgTrendWindowPressOpenDlgButton("TrendControl_01");
}
Parameters of the TlgTrendWindowPressOpenDlgButton function:
"TrendControl_01" is the window title of WinCC Trend Control.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1593
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
TlgTrendWindowPressStartStopButton example
{
//start/stop the actualization
TlgTrendWindowPressStartStopButton("TrendControl_01");
}
Parameters of the TlgTrendWindowPressStartStopButton function:
"TrendControl_01" is the window title of WinCC Trend Control.
Note
Various examples are offered for the function descriptions. For functions with a similar syntax,
a selected function is used as a template in the example. This example must be adapted as
well.
TlgTrendWindowPressZoomInButton example
{
//zoom in
TlgTrendWindowPressZoomInButton("TrendControl_01");
}
Parameters of the TlgTrendWindowPressZoomInButton function:
"TrendControl_01" is the window title of WinCC Trend Control.
TlgTrendWindowPressZoomOutButton example
{
// zoom out
TlgTrendWindowPressZoomOutButton("TrendControl_01");
}
Parameters of the TlgTrendWindowPressZoomOutButton function:
"TrendControl_01" is the window title of WinCC Trend Control.
WinCC: Scripting (VBS, ANSI-C, VBA)
1594 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2.15.5 Lists
2.15.5.1 Bar direction
Bar direction Numeric value
Up 0
bottom 1
left 2
right 3
2.15.5.2 Bar Scaling
Numeric val‐ Bar Scaling
ue
0 Linear (same weighting)
1 Logarithmic (low values emphasized)
2 Negative logarithmic (high values emphasized)
3 Automatic (linear)
4 Tangential (high and low values emphasized)
5 Square (high values emphasized)
6 Cubic (high values strongly emphasized)
2.15.5.3 Flash frequencies
Flash frequency Assigned Value
Slow (approx. 0.25 Hz) 0
Medium (approx. 0.5 Hz) 1
Fast (approx. 1 Hz) 2
Note
Since the flashing is performed by means of software engineering, the flash frequency is both
system-dependent and hardware-bound (number of objects, processor speed, RAM size,
update time etc.).
The information in the table is therefore only for orientation purposes.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1595
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2.15.5.4 I/O field, output format
The display of numeric values output into an I/O field is controlled by a format specification.
A format indication consists of one or several formatting characters. The valid formatting
characters and their meaning are listed in the following table:
Charac‐ Meaning Note
ters
s Positive numbers are displayed Always in the first position of the format specification
with signs May only appear once in the format specification
0(ZER Leading and ending zeros are out‐ Always following s
O) put. If s is missing, it is in the first position
May only appear once in the format specification
9 Specifies the position of a digit in May appear in the format indication as often as required.
the number to be output
,(com‐ Position of the decimal point
ma)
e Returns the number in exponential Always at the last position of the format specification
form
Example:
Num‐ Format Representation
ber
123,4 999,999 123,455
55
123,4 999,99 123,46
55
123,4 9999,9999 123,4550
55
123,4 s09999.99 +0123,4550
55 99
123,4 9.99999e 1.23455e+002
55
If the decimal point is left out in the format specification the decimal places are not displayed
and the number is rounded to an integer.
If fewer decimal positions are provided in the format specification than the number actually
has, only the decimal places specified in the format specification are output.
The number is rounded correspondingly.
If the number has more places before the decimal point than specified in the format
specification, three asterisks (***) are output which means that the number cannot be displayed
in this format.
WinCC: Scripting (VBS, ANSI-C, VBA)
1596 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2.15.5.5 I/O field, data type of the field content
Data type Numeric value
Binary 0
decimal 1
string 2
hexadeci‐ 3
mal
2.15.5.6 I/O field, field type
Type Numeric value
Edition 0
Input 1
Output and 2
input
2.15.5.7 Element alignment in check boxes and radio boxes
Alignment Numeric value
left 0
right -1
2.15.5.8 Color chart
The 16 primary colors are:
Color Color value symbolic constant
(Hex)
Red 0x000000F CO_RED
F
Dark red 0x00000080 CO_DKRED
Green 0x0000FF0 CO_GREEN
0
Dark green 0x00008000 CO_DKGREEN
Blue 0x00FF000 CO_BLUE
0
Dark blue 0x00800000 CO_DKBLUE
Cyan 0x00FFFF0 CO_CYAN
0
Dark cyan 0x00808000 CO_DKCYAN
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1597
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Color Color value symbolic constant
(Hex)
Yellow 0x0000FFF CO_YELLOW
F
Dark yellow 0x00008080 CO_DKYELLOW
Magenta 0x00FF00F CO_MAGENTA
F
Dark magenta 0x00800080 CO_DKMAGENTA
Light gray 0x00C0C0C CO_LTGRAY
0
Gray 0x00808080 CO_DKGRAY
Black 0x00000000 CO_BLACK
White 0x00FFFFF CO_WHITE
F
Note
The symbolic constants are externally predefined by #define and provied by WinCC.
2.15.5.9 Format descriptors
For format descriptors the following type is expected:
%d = DWORD / Int
%f = double
%s = char*
It is also possible e.g. to read a text tag with %d if provisions are made that the value can be
mapped in a DWORD.
The following provision makes sure the value can be mapped:
Varia‐ For‐ C-tag
ble mat
Bit %d DWORD / long int signed
Byte %d DWORD / long int signed
SByte %d DWORD / long int signed
Word %d DWORD / long int signed
SWor %d DWORD / long int signed
d
DWor %d DWORD / long int signed
d
SDWo %d DWORD / long int signed
rd
Float %f double
Dou‐ %f double
ble
Char %s char*
WinCC: Scripting (VBS, ANSI-C, VBA)
1598 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Note
If a "DWORD," for which the 32nd bit is set, is to be read, a format descriptor must be used
for unsigned integers (%u).
See also
SetTagMultiStateWait (Page 1476)
2.15.5.10 Fill pattern
Fill pattern Value
Transparent 65536
Solid 0
Fill pattern Value Fill pattern Value Fill pattern Value
1048576 196611 196627
1048577 196612 196628
1048578 196613 196629
1048579 196614 196630
1048832 196615 196631
1048833 196616 196632
1048834 196617 196633
1048835 196618 196634
131072 196619 196635
131073 196620 196636
131074 196621 196637
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1599
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Fill pattern Value Fill pattern Value Fill pattern Value
131075 196622 196638
131076 196623 196639
196608 196624 196640
196609 196625 196641
196610 196626 196642
Note
The "Solid" fill pattern fills the object with the set background color.
2.15.5.11 Line styles
Line style symbolic name Value
LS_SOLID 0
LS_DASH 1
LS_DOT 2
LS_DASHDOT 3
LS_DASHDOT‐ 4
DOT
hidden LS_INVISIBLE 5
2.15.5.12 Line end style
Line end symbolic name Value for the left line ends Value for the right line ends
LE_NO 0 0
LE_HOLLOW_ARROW 1 65536
LE_FULL_ARROW 2 131072
LE_CFULL_ARROW 3 196608
LE_LINE 4 262144
WinCC: Scripting (VBS, ANSI-C, VBA)
1600 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Line end symbolic name Value for the left line ends Value for the right line ends
LE_HOLLOW_CIRCLE 5 327680
LE_FULL_CIRCLE 6 393216
Note
From a line width > 5 the line end "empty circle" is displayed as filled circle.
2.15.5.13 List types
List type Numeric value
decimal 0
Binary 1
bit 2
2.15.5.14 Language ID
WinCC only supports the SUBLANG_DEFAULT languages of Windows.
symbolic name Value (hexadeci‐ Abbreviation
mal)
LANG_ARABIC 0x0401
LANG_AFRIKAANS 0x0436
LANG_ALBANIAN 0x041C
LANG_BASQUE 0x042D
LANG_BULGARIAN 0x0402
LANG_BYELORUSSIAN 0x0423
LANG_CATALAN 0x0403
LANG_CHINESE 0x0404
LANG_CROATIAN 0x041A
LANG_CZECH 0x0405 CSY
LANG_DANISH 0x0406 DAN
LANG_DUTCH 0x0413 NLD
LANG_ENGLISH 0x0409 ENU
LANG_ESTONIAN 0x0425
LANG_FAEROESE 0x0438
LANG_FARSI 0x0429
LANG_FINNISH 0x040B FIN
LANG_FRENCH 0x040C FRA
LANG_GERMAN 0x0407 DEU
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1601
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
symbolic name Value (hexadeci‐ Abbreviation
mal)
LANG_GREEK 0x0408
LANG_HEBREW 0x040D
LANG_HUNGARIAN 0x040E HUN
LANG_ICELANDIC 0x040F ISL
LANG_INDONESIAN 0x0421
LANG_ITALIAN 0x0410 ITA
LANG_JAPANESE 0x0411
LANG_KOREAN 0x0412
LANG_LATVIAN 0x0426
LANG_LITHUANIAN 0x0427
LANG_NORWEGIAN 0x0414 NOR
LANG_POLISH 0x0415 PLK
LANG_PORTUGUESE 0x0416 PTB
LANG_ROMANIAN 0x0418
LANG_RUSSIAN 0x0419 RUS
LANG_SLOVAK 0x041B SKY
LANG_SLOVENIAN 0x0424
LANG_SORBIAN 0x042E
LANG_SPANISH 0x040A ESP
LANG_SWEDISH 0x041D SVE
LANG_THAI 0x041E
LANG_TURKISH 0x041F TRK
LANG_UKRAINIAN 0x0422
2.15.5.15 Text alignment
Hori‐ Align‐ Numeric value
zontal ment
left 0
centered 1
right 2
Verti‐ Align‐ Numeric value
cal ment
Up 0
centered 1
bottom 2
WinCC: Scripting (VBS, ANSI-C, VBA)
1602 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2.15.5.16 Tag statuses
Value (dec‐ Value (hex‐ Meaning
imal) decimal)
0 0x0000 No error
1 0x0001 Connection to partner not established
2 0x0002 Handshake error
4 0x0004 Network module defective
8 0x0008 Configured upper limit exceeded
16 0x0010 Configured lower limit exceeded
32 0x0020 Format upper limit exceeded
64 0x0040 Format lower limit exceeded
128 0x0080 Conversion error
256 0x0100 Tag initialization value
512 0x0200 Tag replacement value
1024 0x0400 Channel addressing error
2048 0x0800 Tag not found or not available
4096 0x1000 Access to tag not permitted
8192 0x2000 Timeout, no check-back message from the channel
16384 0x4000 Server not available.
2.15.6 Structure definitions
2.15.6.1 Structure definition CCAPErrorExecute
typedef struct {
DWORD dwCurrentThreadID; Thread ID of the current thread
DWORD dwErrorCode1; Error code 1
DWORD dwErrorCode2; Error code 2
BOOL bCycle; cycle/acycle
char* szApplicationName; Name of the application
char* szFunctionName; Name of the function
char* szTagName; Name of the tag
LPVOID lpParam; Pointer to the action stack
DWORD dwParamSize; Size of the action stack
DWORD dwCycle; Cycle of the variable
CMN_ERROR* pError; Pointer to CMN_ERROR
} CCAPErrorExecute;
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1603
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Members
The meaning of the individual error IDs and the structure elements depending on them are
specified in the following table:
1007001 0 X X X X X Action requires exception
1007001 1 X X X X X Exception when access‐
ing the return result
1007001 4097 X X X X X Stack overflow while exe‐
cuting the action
1007001 4098 X X X X X The action contains a di‐
vision by 0
1007001 4099 X X X X X The action contains an ac‐
cess to a non-existing
symbol
1007001 4100 X X X X X The action contains an ac‐
cess violation
1007004 0 X X X Function is not known
1007005 1 X X Action does not include a
P code.
1007005 2 X X Incorrect function name
1007005 4 X X X X X Return value type is inva‐
lid
1007005 32768ff X X X X X Ciss Compiler error when
loading the action
1007006 0 X X X X X X X Tag is not defined
1007006 1 X X X X X X X Tag timeout
1007006 2 X X X X X X X X Tag cannot be returned in
the desired format
1007006 3 X X X X X X X X Tag returns status viola‐
tion, status present in
CMN_ERROR.dwError1
1007007 1 X X X X X X Error in PDLRTGetProp
1007007 2 X X X X X X Error in PDLRTSetProp
1007007 3 X X X X X X Error with DM call
Error structure
The OnErrorExecute function uses the error structure to evaluate or to output error messages,
if marked by an "x" in the pError column.
WinCC: Scripting (VBS, ANSI-C, VBA)
1604 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
See also
Structure definition CMN_ERROR (Page 1606)
2.15.6.2 Structure definition CCAPTime
typedef struct {
DWORD dwCurrentThreadID; ThreadID of the current Thread
DWORD dwCode; Code
BOOL bCycle; cycle/acycle
char* szApplicationName; Name of the Application
char* szFunctionName; Name of the Function
LPVOID lpParam; Pointer to the Action-Stack
DWORD dwParamSize; size of the Action-Stack
double dblTime;
DWORD dwFlags; flags
} CCAPTime;
Members
dwCode
The structure element dwCode provides information on calling OnTime:
dwCode = 113 Call with time definition for each action
dwCode = 114 Call with time monitoring for each action
dwFlags
The structure element dwFlags provides information on the output type:
dwFlags = TRUE The results are output to a file
dwFlags = FALSE The results are output to the diagnostics window
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1605
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
2.15.6.3 Structure definition CMN_ERROR
struct CMNERRORSTRUCT {
DWORD dwError1,
DWORD dwError2,
DWORD dwError3,
DWORD dwError4,
DWORD dwError5;
TCHAR szErrorText[MAX_ERROR_LEN];
}
CMN_ERROR
Description
The extended error structure contains the error code and an error text for the error that has
occurred. Each application can use the error structure to evaluate or to output error messages.
Members
dwError1 .. dwError5
These entries can be used in any way by the API functions.
The API descriptions inform about the values the respective entries contain in case of an error.
If not specified otherwise, the error codes are present in dwError1.
szErrorText
Buffer for the text description of the error cause
The content is determined from the resources and therefore language-dependent.
2.15.6.4 Structure definition DM_TYPEREF
typedef struct {
DWORD dwType;
DWORD dwSize;
char szTypeName[MAX_DM_TYPE_NAME + 1];
}
DM_TYPEREF;
WinCC: Scripting (VBS, ANSI-C, VBA)
1606 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Members
dwType
Specifies the tag type
DM_VARTYPE_BIT Binary tag
DM_VARTYPE_SBYTE Signed 8-bit value
DM_VARTYPE_BYTE Unsigned 8-bit value
DM_VARTYPE_SWORD Signed 16-bit value
DM_VARTYPE_WORD Unsigned 16-bit value
DM_VARTYPE_SDWORD Signed 32-bit value
DM_VARTYPE_DWORD Unsigned 32-bit value
DM_VARTYPE_FLOAT Floating-point number 32-bit IEEE 754
DM_VARTYPE_DOUBLE Floating-point number 64-bit IEEE 754
DM_VARTYPE_TEXT_8 Text tag, 8-bit font
DM_VARTYPE_TEXT_16 Text tag, 16-bit font
DM_VARTYPE_RAW Raw data type
DM_VARTYPE_STRUCT Structure tag
DM_VARTYPE_TEXTREF Text reference tag
dwSize
Specifies the length of the data type in bytes.
szTypeName
In the case of structure tags, contains the name of the structure type
2.15.6.5 Structure definition DM_VAR_UPDATE_STRUCT
typedef struct {
DM_TYPEREF dmTypeRef;
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
}
DM_VAR_UPDATE_STRUCT;
Members
dmTypeRef
Contains information on the tag type. For performance reasons, nothing is entered into this
structure in case of cyclic requirements.
dmVarKey
Specifies the tags to be edited.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1607
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
dmValue
Tag value
Upon access to the value of the VARIANT a ".u." has to be inserted between the name of the
VARIANT and the name of the member.
Example:
// Supply variant
myVariant.vt = VT_I4;
myVariant.u.lVal = 233;
A description of the data type VARIANT can be found in the associated documentation. The
VARIANT dmValue must be initialized with VariantInit() before first use and enabled again with
VariantClear(&dmValue) after use. For this reason, the structure
DM_VAR_UPDATE_STRUCT must not be deleted with ZeroMemory() or memset().
dwState
Identifies the tag status.
See also
Tag statuses (Page 1603)
Structure definition DM_VARKEY (Page 1609)
Structure definition DM_TYPEREF (Page 1606)
2.15.6.6 Structure definition DM_VAR_UPDATE_STRUCTEX
typedef struct {
DM_TYPEREF dmTypeRef;
DM_VARKEY dmVarKey;
VARIANT dmValue;
DWORD dwState;
DWORD dwQualityCode;
}
DM_VAR_UPDATE_STRUCTEX;
Members
dmTypeRef
Contains information on the tag type. For performance reasons, nothing is entered into this
structure in case of cyclic requirements.
dmVarKey
Specifies the tags to be edited.
WinCC: Scripting (VBS, ANSI-C, VBA)
1608 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
dmValue
Tag value
Upon access to the value of the VARIANT a ".u." has to be inserted between the name of the
VARIANT and the name of the member.
Example:
// Supply variant
myVariant.vt = VT_I4;
myVariant.u.lVal = 233;
A description of the data type VARIANT can be found in the associated documentation. The
VARIANT dmValue must be initialized with VariantInit() before first use and enabled again with
VariantClear(&dmValue) after use. For this reason, the structure
DM_VAR_UPDATE_STRUCTEX must not be deleted with ZeroMemory() or memset().
dwState
Identifies the tag status.
dwQualityCode
Identifies the tag quality code.
See also
Tag statuses (Page 1603)
Structure definition DM_VARKEY (Page 1609)
Structure definition DM_TYPEREF (Page 1606)
2.15.6.7 Structure definition DM_VARKEY
typedef struct {
DWORD dwKeyType;
DWORD dwID;
char szName[ MAX_DM_VAR_NAME + 1 ];
LPVOID lpvUserData;
}
DM_VARKEY;
Members
dwKeyType
Defines whether the tag is to be addressed by a key ID or by its name.
DM_VARKEY_ID Specification via key ID
DM_VARKEY_NAME Specification via tag name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1609
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
dwID
Contains the key ID of the tags if dwKeyType is set accordingly
szName
Contains the name of the tag if dwKeyType is set accordingly
lpvUserData
Pointer to application-specific data
2.15.6.8 Structure definition LINKINFO
typedef struct {
LINKTYPE LinkType;
DWORD dwCycle;
TCHAR szLinkName[256];
}
LINKINFO;
Members
LinkType
LinkType are enumeration constants defined in the "Trigger.h" file. They are to be integrated
into your script with the #include "Trigger.h" command and the corresponding enumeration
constants.
BUBRT_LT_NOLINK 0 no shortcut
BUBRT_LT_VARIABLE_DIRECT 1 direct tag
BUBRT_LT_VARIABLE_INDIRECT 2 indirect tag
BUBRT_LT_ACTION 3 C action
BUBRT_LT_ACTION_WIZARD 4 Dynamic Dialog
BUB_LT_DIRECT_CONNECTION 5 Direct connection
BUBRT_LT_ACTION_WIZARD_INPROC 6 Dynamic Dialog
For the function SetLink only the enumeration constants BUBRT_LT_VARIABLE_DIRECT and
BUBRT_LT_VARIABLE_INDIRECT may be used. The function GetLink allows to return all
listed enumeration constants.
dwCycle
Update cycle time
dwCycle Update Cycle
255 Picture cycle
235 Window Cycle
WinCC: Scripting (VBS, ANSI-C, VBA)
1610 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
dwCycle Update Cycle
0 Upon change
1 250ms
2 500 ms
3 1s
4 2s
5 5s
6 10s
7 1min
8 5min
9 10min
10 1h
11-15 User cycle 1-5
szLinkName
Tag name
2.15.6.9 Structure definition MSG_FILTER_STRUCT
typedef struct {
CHAR szFilterName[MSG_MAX_TEXTLEN+1];
WORD dwFilter;
SYSTEMTIME st[2];
DWORD dwMsgNr[2];
DWORD dwMsgClass;
DWORD dwMsgType[MSG_MAX_CLASS];
DWORD dwMsgState;
WORD wAGNr[2];
WORD wAGSubNr[2];
DWORD dwArchivMode;
char szTB[MSG_MAX_TB][
MSG_MAX_TB_CONTENT+1]
DWORD dwTB;
Double dPValue[MSG_MAX_PVALUE][2];
DWORD dwPValue[2];
DWORD dwMsgCounter[2];
DWORD dwQuickSelect;
}
MSG_FILTER_STRUCT;
Description
In this structure the filter criteria are specified.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1611
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Members
dwFilter
The filter conditions are defined by means of the following constants from the file "m_global.h":
MSG_FILTER_DATE_FROM Date from
MSG_FILTER_DATE_TO Date to
MSG_FILTER_TIME_FROM Time from
MSG_FILTER_TIME_TO Time to
MSG_FILTER_NR_FROM Message number from
MSG_FILTER_NR_TO Message number to
MSG_FILTER_CLASS Message classes
MSG_FILTER_STATE Message status
MSG_FILTER_AG_FROM AS number from
MSG_FILTER_AG_TO AS number to
MSG_FILTER_AGSUB_FROM AG subnumber from
MSG_FILTER_AGSUB_TO AG subnumber to
MSG_FILTER_TEXT Message texts
MSG_FILTER_PVALUE Process values
MSG_FILTER_COUNTER_FROM Internal message counter from
MSG_FILTER_COUNTER_TO Internal message counter to
MSG_FILTER_PROCESSMSG Process messages
MSG_FILTER_SYSMSG System messages
MSG_FILTER_BEDMSG Operator messages
MSG_FILTER_DATE Date from to
MSG_FILTER_TIME Time from to
MSG_FILTER_NR Message number from to
MSG_FILTER_VISIBLEONLY Display visible messages
MSG_FILTER_HIDDENONLY Display hidden messages
st
Date/time from - to
Where st[0] is the start time (from), st[1] the end time (to)
Assign these fields for the filter criteria: MSG_FILTER_DATE, MSG_FILTER_DATE_FROM,
MSG_FILTER_DATE_TO, MSG_FILTER_TIME, MSG_FILTER_TIME_FROM or
MSG_FILTER_TIME_TO
If a current time is needed for the transfer of a SYSTEMTIME parameter the function
GetLocalTime is to be used instead of GetSystemTime. As a rule there is a significant time
difference between these two functions.
dwMsgNr
Message number from - to
WinCC: Scripting (VBS, ANSI-C, VBA)
1612 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Where dwMsgNr[0] is the start no. (from), dwMsgNr[1] the end no. (to)
Assign these fields for the filter criteria: MSG_FILTER_NR, MSG_FILTER_NR_FROM or
MSG_FILTER_NR_TO
dwMsgClass
Message classes bit-coded.
Assign this field for the filter criterion: MSG_FILTER_CLASS
dwMsgType
Message type per message class, bit-coded
Assign this field for the filter criterion: MSG_FILTER_CLASS
dwMsgState
Message status bit-coded.
Assign this field for the filter criterion: MSG_FILTER_STATE
wAGNr
AGNr from - to
Assign these fields for the filter criteria: MSG_FILTER_AG_FROM or MSG_FILTER_AG_TO
wAGSubNr
AGSubNr from - to
Assign this field for the filter criteria: MSG_FILTER_AGSUB_FROM or
MSG_FILTER_AGSUB_TO
dwArchivMode
Archiving / logging
Must be assigned 0.
szTB
Texts of the text blocks
Assign these fields for the filter criterion: MSG_FILTER_TEXT
dwTB
Active text blocks (from - to, bit-coded)
Assign this field for the filter criterion: MSG_FILTER_TEXT
dPValue
Process values from - to
Assign these fields for the filter criterion: MSG_FILTER_PVALUE
dwPValue
Active process values (from - to, bit-coded)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1613
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
Assign this field for the filter criterion: MSG_FILTER_PVALUE
dwMsgCounter
Internal message counter from - to
Assign these fields for the filter criteria: MSG_FILTER_COUNTER_FROM,
MSG_FILTER_COUNTER_TO
dwQuickSelect
Quick selection for hour, day, month
The parameter is reserved for future upgrades and must be preset to 0.
Assign this field for the filter criterion: MSG_FILTER_QUICKSELECT
LOWORD type:
MSG_FILTER_QUICK_MONTH Quick selection last n months
MSG_FILTER_QUICK_DAYS Quick selection last n days
MSG_FILTER_QUICK_HOUR Quick selection last n hours
HIWORD number: 1...n
The end time of the quick selection refers to the current system time of the local computer.
The start time is calucalted back n * ( months, days, hours ).
2.15.6.10 Structure definition MSG_RTDATA_STRUCT
typedef struct {
DWORD dwMsgState;
DWORD dwMsgNr;
SYSTEMTIME stMsgTime;
DWORD dwTimeDiff;
DWORD dwCounter;
DWORD dwFlags;
WORD wPValueUsed;
WORD wTextValueUsed;
double dPValue[MSG_MAX_PVALUE];
MSG_TEXTVAL_STRUCT mtTextValue[MSG_MAX_PVALUE];
}
MSG_RTDATA_STRUCT;
Members
dwMsgState
Message status
MSG_STATE_COME 0x00000001 Message came in
MSG_STATE_GO 0x00000002 Message went out
MSG_STATE_QUIT 0x00000003 Message acknowledged
WinCC: Scripting (VBS, ANSI-C, VBA)
1614 System Manual, 09/2018, A5E45518271-AA
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
MSG_STATE_LOCK 0x00000004 Message locked
MSG_STATE_UNLOCK 0x00000005 Message unlocked
MSG_STATE_QUIT_SYSTEM 0x00000010 Message acknowledged by system
MSG_STATE_QUIT_EMERGENCY 0x00000011 Emergency acknowledgement
MSG_STATE_QUIT_HORN 0x00000012 Horn acknowledgement
MSG_STATE_COMEGO 0x00000013 Message came in and went out, only display in message list
MSG_STATE_UPDATE 0x00010000 Bit for message update
MSG_STATE_RESET 0x00020000 Bit for message reset
MSG_STATE_SUMTIME 0x00040000 Bit active for daylight savings time
MSG_STATE_INSTANCE 0x00080000 Bit for instance message (n messages of a no.)
dwMsgNr
Message number
stMsgTime
Date/Time: Telegram time depending on the calling function
dwTimeDiff
Duration coming/Telegram time in seconds
dwCounter
Internal message counter
dwFlags
Message flags in the database
MSG_FLAG_SUMTIME 0x00000001 Daylight savings time active
MSG_FLAG_COMMENT 0x00000002 Message has comments
MSG_FLAG_ARCHIV 0x00000004 Archiving
MSG_FLAG_PROTOCOL 0x00000008 Logging
MSG_FLAG_TEXTVALUES 0x00000010 Message has values accompanying the text
MSG_FLAG_TIMEINVALID 0x00000020 Bit for invalid date/time stamp
MSG_FLAG_INSTANCE 0x00000040 Instance message identification (185269)
wPValueUsed
Process values used, bit-coded. Every bit may only be set in one of the two structure elements
"wPValueUsed" or "wTextValueUsed". An accompanying value may either be a number or a
text.
wTextValueUsed
text values used, bit-coded. Every bit may only be set in one of the two structure elements
"wPValueUsed" or "wTextValueUsed". An accompanying value may either be a number or a
text.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1615
ANSI-C for Creating Functions and Actions
2.15 ANSI-C function descriptions
WinCC: Scripting (VBS, ANSI-C, VBA)
1616 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration 3
3.1 Automated configuration
Contents
You can use VBA to automate configuration in Graphics Designer. This comprises:
● Adaptation of the Graphics Designer
● Editing of pictures
● Editing of objects
● Dynamizing with VBA
● Access to external applications
A VBA editor is available for this purpose in the "Graphics Designer" editor.
This chapter contains
● a brief introduction on how to use VBA in WinCC,
● basic information on using VBA in Graphics Designer and
● reference to the VBA object model in Graphics Designer.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1617
VBA for Automated Configuration
3.2 Introduction: Using VBA in WinCC
3.2 Introduction: Using VBA in WinCC
3.2.1 Introduction: Using VBA in WinCC
Introduction
You have a VBA editor available in Graphics Designer which allows you to configure pictures
automatically. The VBA editor is identical to the one from the products in the Microsoft Office
family. You can make direct use of your VBA programming experience.
Principle
With VBA you extend the functionality of the Graphics Designer and automate configuring.
You may use VBA in Graphics Designer as follows, including:
● Creating user-defined menus and toolbars
● Creating and editing Standard, Smart and Windows objects
● Adding dynamics to properties of pictures and objects
● Configuring actions in pictures and objects
● Accessing products that support VBA (e.g. products in the MS Office family)
A description of the VBA object model for the Graphics Designer is provided in this
documentation in the section under "VBA Reference".
See also
Organizing VBA Code in a WinCC Project (Page 1619)
VBA Reference (Page 1752)
VBA in the Graphics Designer (Page 1625)
Executing VBA Macros in Graphics Designer (Page 1623)
Differentiation: Using VBA (Page 1618)
3.2.2 Differentiation: Using VBA
Introduction
You can use VBA exclusively for configuration and functional enhancement in the Graphics
Designer. The following indicates where there are better options available for efficient
configuration or where VBA cannot be used.
WinCC: Scripting (VBS, ANSI-C, VBA)
1618 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.2 Introduction: Using VBA in WinCC
VB and C Scripts
VB and C scripts are active only at runtime and are used to dynamize picture and object
properties as well as in action configuration.
Dynamic Wizards
The dynamic wizards are not replaced by VBA. However, VBA allows you to enhance the
functionality of the dynamic wizards with ease.
ODK
ODK comprises function calls that enable access to all the functionality of WinCC both in the
configuration system and in runtime. In contrast to ODK, VBA offers simple object-oriented
access to the objects of the Graphics Designer.
See also
VBA in the Graphics Designer (Page 1625)
Executing VBA Macros in Graphics Designer (Page 1623)
Organizing VBA Code in a WinCC Project (Page 1619)
Introduction: Using VBA in WinCC (Page 1618)
3.2.3 Organizing VBA Code in a WinCC Project
Introduction
You organize the VBA code for your WinCC project in the VBA editor. This is where you specify
whether the VBA code is to be available in only one picture, in the entire project or in all projects.
Depending on where you place the VBA code, the term used to refer to the code is:
● global VBA code,
● project-specific VBA code or
● picture-specific VBA code.
Note
A picture in the Graphics Designer is known as a "document" in the VBA object model.
The VBA editor
To start the VBA editor in the Graphics Designer, press <ALT+F11> or choose "Tools" >
"Macros" > "Visual Basic Editor". If you have not yet opened a picture in the Graphics Designer,
you can only edit the global or project-specific VBA code.
The global and project-specific data and all open pictures are displayed in the VBA editor's
Project Explorer:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1619
VBA for Automated Configuration
3.2 Introduction: Using VBA in WinCC
Global VBA code (1)
Refers to VBA code that you write to the "GlobalTemplateDocument" in the VBA editor. This
VBA code is saved in the "@GLOBAL.PDT" file, which is located in the WinCC installation
directory.
The VBA code that you put in the "GlobalTemplateDocument" is the code that you want to be
made available in all WinCC projects on your computer. If you need the VBA code on a different
computer, use the export and import functions in the VBA editor.
A WinCC computer uses only the @GLOBAL.PDT stored locally in the WinCC installation
directory (…\Siemens\WinCC\Templates).
Note
When you perform an update installation, your global "@Global.pdt" template is saved in the
"@Global.sav" backup file. The backup file is saved in the …\Siemens\WinCC\Templates
directory. Your VBA code from the old global template is not automatically applied to the new
global template.
Applying the VBA Code from the Old Global Template:
WinCC: Scripting (VBS, ANSI-C, VBA)
1620 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.2 Introduction: Using VBA in WinCC
In order to apply the VBA code from the old template after an update installation, proceed as
follows:
1. If you have already entered VBA code into the new global template, open the VBA editor
in the Graphics Designer and copy the VBA code.
2. Close WinCC.
3. Open the …\Siemens\WinCC\Templates directory in Windows Explorer.
4. Delete the new global template "@Global.pdt".
5. Rename the "@Global.sav" backup file to "@Global.pdt".
6. If you have already copied VBA code from the new global template, open the VBA editor
in the Graphics Designer and insert the copied VBA code.
The VBA code from your old global template is available again.
Project-specific VBA code (2)
Refers to VBA code that you write to the "ProjectTemplateDocument" in the VBA editor. This
VBA code is saved in the @"PROJECT.PDT" file, which is located in the root directory of each
WinCC project.
The "@PROJECT.PDT" file has a reference to the "@GLOBAL.PDT" file. Functions and
procedures which you have saved in the "@GLOBAL.PDT" file can be called up directly in the
"ProjectTemplateDocument".
The "ProjectTemplateDocument" is where you put VBA code that you want to use in all pictures
in the open project. If you need the VBA code on a different computer, use the export and
import functions in the VBA editor.
You can open and edit the "@PROJECT.PDT" file in the same way as a PDL file. This will
allow you to use the "@PROJECT.PDT" file as a template: For example, you may create there
the basic picture of your system which will then be automatically transferred into each new
PDL file of the project. Picture properties such as layers or zoom are not copied to the PDL
file, nor is the VBA code.
Picture-specific VBA code (3)
Refers to VBA code that you write to the document "This Document" relating to the
corresponding picture in the VBA editor. This VBA code is saved as a PDL file together with
the picture.
The PDL file has a reference to the "@PROJECT.PDT" file. Functions and procedures which
you have saved in the "@PROJECT.PDT" file can be called up directly from the PDL file.
However, you do not have access to functions or procedures that are stored in the
"@GLOBAL.PDT" file.
Note
You can create modules, class modules and user forms in each document.
You can protect the VBA code of a module against unauthorized access by setting a password.
To do this, select the "Tools" > "VBAObject Properties" menu item in the VBA editor.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1621
VBA for Automated Configuration
3.2 Introduction: Using VBA in WinCC
Special features during the execution of VBA macros
For the execution of VBA macros, the following applies: Initially picture-specific VBA code is
executed, followed by project-specific VBA code. If therefore you call a VBA macro that is
contained for example both in the picture and in the project-specific VBA code, only the VBA
macro from the picture is executed. This has the effect of preventing VBA macros and functions
from being executed twice, which otherwise can lead to errors.
In connection with event handling the forwarding of events is activated by default. You can
prevent events from being forwarded if you want to respond to an event in the picture-specific
VBA code only.
Additional information on this topic is given under "Event Handling".
Testing with the Debugger
You can test your VB scripts at runtime with the VBA editor's debugger. You may find additional
information in the help system of the VBA editor.
See also
Event Handling (Page 1717)
VBA in the Graphics Designer (Page 1625)
Executing VBA Macros in Graphics Designer (Page 1623)
How to export and import VBA code (Page 1622)
3.2.4 How to export and import VBA code
Principle
In the VBA editor you can import and export VBA code, enabling you to transfer it to another
computer. References to procedures and functions which you call within the project are
therefore retained.
Note
When you import VBA code you must enter references to external libraries manually after the
import process, on the target computer.
Procedure
Exporting VBA code
1. In the VBA editor's Project Explorer, select the module, whose VBA code you want to export.
2. Choose the "File" > "Export File menu command".
WinCC: Scripting (VBS, ANSI-C, VBA)
1622 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.2 Introduction: Using VBA in WinCC
3. Select the path and enter the file name.
4. Click "Save".
The VBA code is exported to a file. The file type depends on the module from which the VBA
code was exported.
Importing VBA code
1. In the VBA editor's Project Explorer, select the document into which you want to import the
VBA code.
2. Choose the menu option "File" > "Import File".
3. Select the file and click "Open" in order to import the VBA code as "ThisDocument" into the
"Class Modules" folder.
4. In the "Class Modules" folder, open the document "ThisDocument" and copy the VBA code
into the document in the required project.
See also
Organizing VBA Code in a WinCC Project (Page 1619)
3.2.5 Executing VBA Macros in Graphics Designer
Introduction
Three possibilities are available to you for executing VBA macros in the Graphics Designer:
● Event Handling
● User-defined menu or toolbar
● VBA editor
Event Handling
Predefined events (such as the opening of a picture) can occur in the Graphics Designer, the
active picture or the component library, to which you can respond with VBA event handlers.
These events occur only during configuring in the Graphics Designer and have nothing to do
with the events of action configuring.
In this example, a brief message is to be issued when a picture is opened. The "Opened event"
is used for this:
Private Sub Document_Opened(CancelForwarding As Boolean)
MsgBox ("Picture was opened!")
End Sub
Further information on the subject of event handling is provided under "Event handling" and
"Events".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1623
VBA for Automated Configuration
3.2 Introduction: Using VBA in WinCC
User-defined menu or toolbar
VBA allows you to create user-defined menus and toolbars in the Graphics Designer. You can
assign a VBA macro to each user-defined menu entry or icon; this macro is then executed
when you click on the menu entry or the icon. This way you can extend the functionality of the
Graphics Designer to suit your requirements.
Further information on the creation of user-defined menus and toolbars is provided under
"Creating your own menus and toolbars".
VBA editor
You can start a VBA macro in the VBA editor by pressing <F5>. If you press <F8>, you can
execute a VBA macro step by step.
See also
VBA Reference (Page 1752)
Event Handling (Page 1717)
Creating Customized Menus and Toolbars (Page 1631)
VBA in the Graphics Designer (Page 1625)
Organizing VBA Code in a WinCC Project (Page 1619)
Introduction: Using VBA in WinCC (Page 1618)
WinCC: Scripting (VBS, ANSI-C, VBA)
1624 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3.3 VBA in the Graphics Designer
3.3.1 VBA in the Graphics Designer
Introduction
You use VBA in the Graphics Designer in order to automate frequently recurring steps during
configuring. You can create user-defined menus and toolbars in order to make it easier to
execute the VBA macros that you have created.
Basically, in the Graphics Designer you can replace all configuring work that you would
otherwise perform with the mouse with VBA macros. This applies in particular to the GUI (layers
and zoom) and the editing of objects in pictures including dynamics.
Adapting the Graphics Designer with VBA
The Graphics Designer is represented by the Application object in VBA. With VBA you can
carry out configuring in the Graphics Designer in several languages, create user-defined
menus and toolbars and access the component library.
Editing Pictures with VBA
A picture in the Graphics Designer is represented by the Document object.
With VBA you can access the properties of the picture and edit settings for layers and the
zoom factors. As well as this you can create picture-specific menus and toolbars. These are
only visible, however, for as long as the picture is active.
Editing Objects with VBA
An object in the picture is represented by the HMIObject object. With VBA you can create and
delete objects and access the object properties. For example, with VBA you can very quickly
create a large number of objects with identical properties for your plant display.
Creating Dynamics with VBA
VBA enables you to add dynamics to properties and events of pictures and objects.
Event Handling
With VBA you can respond to events that occur in the Graphics Designer or in a picture, for
example when you insert a new object into a picture. You use event handling in order to execute
VBA macros in certain program situations.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1625
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Access to external applications
You can use VBA to access programs which support VBA, for example products in the
Microsoft Office family. This means that you have an opportunity to read values from an Excel
table and then assign them to object properties.
Note
Access to applications that were compiled with .net
You need to recompile applications that were compiled with .net to enable access to VBA in
Graphics Designer.
See also
Editing Pictures with VBA (Page 1663)
SymbolLibrary Object (Page 2084)
HMIObject Object (Page 1992)
Document Object (Page 1954)
Application Object (Page 1915)
Accessing External Applications with VBA (Page 1721)
Event Handling (Page 1717)
Creating Dynamics with VBA (Page 1694)
Editing Objects with VBA (Page 1670)
Adapting the Graphics Designer with VBA (Page 1627)
Introduction: Using VBA in WinCC (Page 1618)
WinCC: Scripting (VBS, ANSI-C, VBA)
1626 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3.3.2 Adapting the Graphics Designer with VBA
3.3.2.1 Adapting the Graphics Designer with VBA
Introduction
In VBA the Application object represents the Graphics Designer:
Access to the component library
VBA gives you full access to the component library. You can extend the component library
with VBA by for example creating and deleting folders or copying objects and inserting them
into a picture.
User-defined menus and toolbars
You can create user-defined menus and toolbars in order to execute VBA macros in the
Graphics Designer. In this way you can extend the functionality of the Graphics Designer to
suit your particular requirements.
Language-dependent configuring
With VBA you can carry out configuring in the Graphics Designer in more than one language.
You therefore have access to the language-dependent object properties and you can create
the user-defined menus and toolbars in different languages.
See also
Editing Pictures with VBA (Page 1663)
Accessing the component library with VBA (Page 1650)
Creating Customized Menus and Toolbars (Page 1631)
Language-Dependent Configuration with VBA (Page 1628)
VBA in the Graphics Designer (Page 1625)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1627
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3.3.2.2 Language-Dependent Configuration with VBA
Introduction
With VBA you can carry out configuring in the Graphics Designer for several different
languages. This gives you access to the language-dependent properties of objects in the
Graphics Designer, while you can also make the user-defined menus and toolbars available
in different languages. In VBA, foreign-language texts are stored in a list of the
"LanguageTexts" type. The settings for language-dependent fonts are stored in a list of the
"LanguageFonts" type.
Further information about language-dependent configuring is also provided in the WinCC
documentation "Setting up multilingual projects".
User interface language
You can only switch to a different desktop language in WinCC, not with VBA. When you switch
desktop language in WinCC, the "DesktopLanguageChanged" event is triggered. You can
adapt the user-defined menus and toolbars to suit the user, for example, by replacing language-
dependent tool icons.
The following objects and the associated language-dependent properties react to the switching
of the user interface language:
● FolderItem Object
● Menu object and MenuItem object
● ToolbarItem Object
● Further information about the desktop language is provided in the WinCC documentation
"Setting up multilingual projects" under "Language terms in WinCC".
As of WinCC V7.3, VBA is installed in all languages that you have selected in the WinCC setup.
When you open the "VBA" editor in the Graphics Designer, the "VBA" editor opens in the same
user interface language as the Graphics Designer.
Project language
You can change the configuring language with VBA using the "CurrentDataLanguage"
property.
In this example the configuring language is changed to "English":
Sub ChangeCurrentDataLanguage()
'VBA1
Application.CurrentDataLanguage = 1033
MsgBox "The Data language has been changed to english"
Application.CurrentDataLanguage = 1031
MsgBox "The Data language has been changed to german"
End Sub
All language-dependent properties, such as ToolTipText, are affected by the change.
WinCC: Scripting (VBS, ANSI-C, VBA)
1628 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Configuring for more than one language in VBA
There are two possible ways for you to carry out configuring for several languages with VBA.
● Language switching: Text properties of objects.
● Text language lists: Text properties of user-defined menus and toolbars, and objects.
Language change
You can change the language-dependent properties (e.g., "Text") of objects with VBA. To do
this, assign the text to the corresponding property and then change the configuring language
in order to assign the text in the other language.
LanguageTexts listing
You can save the multilingual texts for the respective object directly in the associated listing
of the "LanguageTexts" type. To do this, enter the language ID for the language and the
associated text.
The list of language codes is available in the WinCC documentation (Index > Language Code).
In this example a German label and an English label are assigned to the button "myButton":
Sub AddLanguagesToButton()
'VBA2
Dim objLabelText As HMILanguageText
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
'
'Set defaultlabel:
objButton.Text = "Default-Text"
'
'Add english label:
Set objLabelText = objButton.LDTexts.Add(1033, "English Text")
'Add german label:
Set objLabelText = objButton.LDTexts.Add(1031, "German Text")
End Sub
See also
LanguageTexts Object (Listing) (Page 2004)
LanguageFonts Object (Listing) (Page 2001)
How to assign help texts to menus and toolbars (Page 1643)
How to create menus in multiple languages (Page 1637)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1629
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3.3.2.3 Creating Customized Menus and Toolbars
Configuring Menus and Toolbars
Introduction
You can "liven up" user-defined menus and toolbars so that they respond to certain program
situations in the Graphics Designer. For example, if an icon is not available because no object
is selected, you can gray out the icon. A check mark before a menu item can indicate, for
example, whether a selection is activated.
The following illustration shows you the configuration possibilities, using the example of a user-
defined menu:
Active (yes/no) (1)
Activates the entry or dims it. You can use the "Enabled" property for user-defined menus,
menu items and icons:
'VBA13
Application.ActiveDocument.CustomMenus(1).MenuItems(1).Enabled = False
Marked with check mark (yes/no) (2)
Marks the menu item with a check mark. You can only use the "Checked" property for user-
defined menu items:
'VBA14
Application.ActiveDocument.CustomMenus(1).MenuItems(2).Checked = True
Shortcut (3)
Defines a key combination for a menu item or an icon. You can only use the "Shortcut" property
for user-defined menu items and icons:
'VBA15
Application.ActiveDocument.CustomMenus(1).MenuItems(3).Shortcut = "Ctrl+G"
WinCC: Scripting (VBS, ANSI-C, VBA)
1630 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Visible (yes/no) (4)
Displays or hides the item. You can use the "Visible" property for user-defined menus, menu
items and toolbars and for their icons:
'VBA16
Application.ActiveDocument.CustomMenus(1).MenuItems(4).Visible = False
Creating Customized Menus and Toolbars
User-defined menus and toolbars in the Graphics Designer
You can use the following user-defined menus and toolbars in the Graphics Designer to run
VBA macros:
● User-defined menus and toolbars are always visible when the Graphics Designer is open.
You should use application-specific menus and toolbars when the VBA macros that are to
be executed from them have to be accessible at all times.
● Picture-specific menus and toolbars are linked to a specific picture and remain visible for
as long as the picture is active. You should use picture-specific menus and toolbars when
the VBA macros used there are relevant only for that particular picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1631
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Positioning of user-defined menus and toolbars
In the case of user-defined menus, the "Position" parameter determines the final positioning
in the menu bar:
Application-specific menus (1) are always positioned to the right of the "Windows" menu in the
Graphics Designer, while picture-specific menus (2) are always positioned to the left of the
"Help" menu in the Graphics Designer.
However, application-specific toolbars are not treated as "preferred". In this case, the
positioning is determined by the order in which you insert the toolbars. Toolbars are positioned
below the Graphics Designer toolbar.
Properties of user-defined menus and toolbars
In the case of user-defined menus and toolbars you can use hyphens to divide entries, for
example according to certain categories. As well as this you can also create submenus in a
user-defined menu.
The following configuration options are available to you for user-defined menus and toolbars
and their entries:
● Visible (yes/no): Displays or hides the item (visible property).
● Active (yes/no): Activates the entry or dims it (enabled property).
● Marked with check mark (yes/no) - only available for menu command (Checked property).
● Shortcut: Key combination for calling a menu command (ShortCut property).
WinCC: Scripting (VBS, ANSI-C, VBA)
1632 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
● Statustext: Text that is displayed in the status bar (StatusText property).
● Tooltip text - only available for an icon (ToolTipText property).
You can hide a menu command, for example, if the macro cannot be executed at a certain
time. In this way you can prevent inadvertent wrong operation.
You can create all texts and labels of user-defined menus and toolbars in multiple languages
so that the user-defined menus and toolbars can also react to a language change.
See also
How to assign VBA macros to menus and toolbars (Page 1645)
How to assign help texts to menus and toolbars (Page 1643)
How to Add a New Icon to the Toolbar (Page 1641)
How to Create an Application-specific Toolbar (Page 1639)
How to create menus in multiple languages (Page 1637)
How to add a new menu entry to a menu (Page 1635)
How to Create Picture-specific Menus and Toolbars (Page 1665)
How to Create a New Application-Specific Menu (Page 1633)
Configuring Menus and Toolbars (Page 1630)
Executing VBA Macros in Graphics Designer (Page 1623)
How to Create a New Application-Specific Menu
Introduction
Application-specific menus remain visible even when all pictures in Graphics Designer are
closed. You can use the Started event, for example, in order to insert an application-specific
menu at an early stage.
Position the VBA code either
● in the "GlobalTemplateDocument" if you want the menu to be available in all projects, or
● in the "ProjectTemplateDocument" if you want the menu to be available in the current
project.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1633
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
3. To create a user-defined menu in the Graphics Designer, you can for example insert a
"CreateApplicationMenus()" procedure in the document. In this example, two user-defined
menus are created:
Sub CreateApplicationMenus()
'VBA3
'Declaration of menus...:
Dim objMenu1 As HMIMenu
Dim objMenu2 As HMIMenu
'
'Add menus. Parameters are "Position", "Key" und "DefaultLabel":
Set objMenu1 = Application.CustomMenus.InsertMenu(1, "AppMenu1",
"App_Menu_1")
Set objMenu2 = Application.CustomMenus.InsertMenu(2, "AppMenu2",
"App_Menu_2")
End Sub
4. Start the procedure with <F5>.
Result
The two menus "App_Menu_1" and "App_Menu_2" are inserted to the right of the "Window"
menu:
See also
Creating Customized Menus and Toolbars (Page 1631)
InsertMenu Method (Page 1856)
How to assign VBA macros to menus and toolbars (Page 1645)
How to assign help texts to menus and toolbars (Page 1643)
WinCC: Scripting (VBS, ANSI-C, VBA)
1634 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
How to create menus in multiple languages (Page 1637)
How to add a new menu entry to a menu (Page 1635)
Configuring Menus and Toolbars (Page 1630)
Organizing VBA Code in a WinCC Project (Page 1619)
How to add a new menu entry to a menu
Requirements
You must have created the user-defined menu first.
Introduction
You can insert three different types of menu items in the user-defined menu:
● Menu entry: To call VBA macros.
● Separator line: For clearer design of user-defined menu.
● Submenu: Same as user-defined menu (e.g. command structuring).
The "Position" parameter determines the order of the menu items within the user-defined
menu.
The "Key" parameter is a unique identification of the menu item. This parameter is used if you
use the "MenuItemClicked" event for calling VBA macros.
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1635
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To create menu items in a previously created user-defined menu, you can for example
insert an "InsertMenuItems()" procedure in the document. In this example a number of menu
items are created in the user-defined menu "App_Menu_1":
Sub InsertMenuItems()
'VBA4
Dim objMenu1 As HMIMenu
Dim objMenu2 As HMIMenu
Dim objMenuItem1 As HMIMenuItem
Dim objSubMenu1 As HMIMenuItem
'Create Menu:
Set objMenu1 = Application.CustomMenus.InsertMenu(1, "AppMenu1",
"App_Menu_1")
'Next lines add menu-items to userdefined menu.
'Parameters are "Position", "Key" and DefaultLabel:
Set objMenuItem1 = objMenu1.MenuItems.InsertMenuItem(1,
"mItem1_1", "App_MenuItem_1")
Set objMenuItem1 = objMenu1.MenuItems.InsertMenuItem(2,
"mItem1_2", "App_MenuItem_2")
'
'Adds seperator to menu ("Position", "Key")
Set objMenuItem1 = objMenu1.MenuItems.InsertSeparator(3,
"mItem1_3")
'
'Adds a submenu into a userdefined menu
Set objSubMenu1 = objMenu1.MenuItems.InsertSubMenu(4, "mItem1_4",
"App_SubMenu_1")
'
'Adds a menu-item into a submenu
Set objMenuItem1 = objSubMenu1.SubMenu.InsertMenuItem(5,
"mItem1_5", "App_SubMenuItem_1")
Set objMenuItem1 = objSubMenu1.SubMenu.InsertMenuItem(6,
"mItem1_6", "App_SubMenuItem_2")
End Sub
4. Start the procedure with <F5>.
Result
The "InsertMenuItems()" procedure inserts the menu "App_Menu_1" with these menu items:
WinCC: Scripting (VBS, ANSI-C, VBA)
1636 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
See also
InsertSeparator Method (Page 1859)
InsertSubmenu Method (Page 1860)
InsertMenu Method (Page 1856)
How to assign VBA macros to menus and toolbars (Page 1645)
How to assign help texts to menus and toolbars (Page 1643)
How to create menus in multiple languages (Page 1637)
How to Create a New Application-Specific Menu (Page 1633)
Configuring Menus and Toolbars (Page 1630)
Creating Customized Menus and Toolbars (Page 1631)
How to create menus in multiple languages
Introduction
You can create a user-defined menu that responds to a change of language. To do this you
need to define the necessary number of labels in other languages for the menu and for each
menu item.
The foreign-language label comprises the language ID (LCID) and the foreign-language text
(DisplayName).
The list of language codes is available in the WinCC documentation (Index > Language Code).
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1637
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To define multilingual labels for a user-defined menu, you can for example insert a
"MultipleLanguagesForAppMenu1()" procedure in the document. In this example English
labels are defined for the "App_Menu_1" menu:
Sub InsertMenuItems()
'VBA5
'Execute this procedure first
Dim objMenu1 As HMIMenu
Dim objMenu2 As HMIMenu
Dim objMenuItem1 As HMIMenuItem
Dim objSubMenu1 As HMIMenuItem
'Insert Menu:
Set objMenu1 = Application.CustomMenus.InsertMenu(1, "AppMenu1",
"App_Menu_1")
'Next lines inserts menu-items to userdefined menu.
'parameters are "Position", "Key" and DefaultLabel:
Set objMenuItem1 = objMenu1.MenuItems.InsertMenuItem(1,
"mItem1_1", "App_MenuItem_1")
Set objMenuItem1 = objMenu1.MenuItems.InsertMenuItem(2,
"mItem1_2", "App_MenuItem_2")
'
'Inserts seperator into menu ("Position", "Key")
Set objMenuItem1 = objMenu1.MenuItems.InsertSeparator(3,
"mItem1_3")
'
'Inserts a submenu into a userdefined menu
Set objSubMenu1 = objMenu1.MenuItems.InsertSubMenu(4, "mItem1_4",
"App_SubMenu_1")
'
'Inserts a menu-item into a submenu
Set objMenuItem1 = objSubMenu1.SubMenu.InsertMenuItem(5,
"mItem1_5", "App_SubMenuItem_1")
Set objMenuItem1 = objSubMenu1.SubMenu.InsertMenuItem(6,
"mItem1_6", "App_SubMenuItem_2")
End Sub
Sub MultipleLanguagesForAppMenu1()
' execute this procedure after "InsertMenuItems()" was run
'Object "objLanguageTextMenu1" contains the
'foreign-language labels for the menu
Dim objLanguageTextMenu1 As HMILanguageText
'
'Object "objLanguageTextMenu1Item" contains the
'foreign-language labels for the menu-items
Dim objLanguageTextMenuItem1 As HMILanguageText
Dim objMenu1 As HMIMenu
Dim objSubMenu1 As HMIMenuItem
Set objMenu1 = Application.CustomMenus("AppMenu1")
Set objSubMenu1 =
Application.CustomMenus("AppMenu1").MenuItems("mItem1_4")
'
'Inserts foreign-language label into a menu:
'("Add(LCID, DisplayName)" method:
WinCC: Scripting (VBS, ANSI-C, VBA)
1638 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Set objLanguageTextMenu1 = objMenu1.LDLabelTexts.Add(1033,
"English_App_Menu_1")
'
'Inserts foreign-language label into a menuitem:
Set objLanguageTextMenuItem1 =
objMenu1.MenuItems("mItem1_1").LDLabelTexts.Add(1033, "My first
menu item")
'
'Adds a foreign-language label into a submenu:
Set objLanguageTextMenuItem1 =
objSubMenu1.SubMenu.Item("mItem1_5").LDLabelTexts.Add(1033, "My
first submenu item")
End Sub
4. Start the procedure with <F5>.
Result
If you now switch the configuring language to English, certain items in the user-defined menu
are shown in English.
See also
LanguageTexts Object (Listing) (Page 2004)
LDLabelTexts Property (Page 2305)
How to assign VBA macros to menus and toolbars (Page 1645)
How to assign help texts to menus and toolbars (Page 1643)
How to add a new menu entry to a menu (Page 1635)
How to Create a New Application-Specific Menu (Page 1633)
Configuring Menus and Toolbars (Page 1630)
Creating Customized Menus and Toolbars (Page 1631)
Language-Dependent Configuration with VBA (Page 1628)
How to Create an Application-specific Toolbar
Introduction
Application-specific toolbars remain visible even when all pictures in the Graphics Designer
are closed.
Position the VBA code either
● in the "GlobalTemplateDocument" if you want the toolbar to be available in all projects, or
● in the "ProjectTemplateDocument" if you want the toolbar to be available in the current
project.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1639
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
3. To create a user-defined toolbar in the Graphics Designer, you can for example insert a
"CreateApplicationToolbars()" procedure in the document. In this example two user-defined
toolbars are created:
Sub CreateApplicationToolbars()
'VBA6
'Declare toolbar-objects...:
Dim objToolbar1 As HMIToolbar
Dim objToolbar2 As HMIToolbar
'
'Add the toolbars with parameter "Key"
Set objToolbar1 = Application.CustomToolbars.Add("AppToolbar1")
Set objToolbar2 = Application.CustomToolbars.Add("AppToolbar2")
End Sub
4. Start the procedure with <F5>.
Result
The two toolbars are inserted beneath the Graphics Designer toolbars.
See also
Add Method (CustomToolbars Listing) (Page 1795)
How to assign VBA macros to menus and toolbars (Page 1645)
How to assign help texts to menus and toolbars (Page 1643)
How to Add a New Icon to the Toolbar (Page 1641)
Configuring Menus and Toolbars (Page 1630)
Creating Customized Menus and Toolbars (Page 1631)
WinCC: Scripting (VBS, ANSI-C, VBA)
1640 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
How to Add a New Icon to the Toolbar
Requirement
You must have created the user-defined toolbar first.
Introduction
You can insert two different types of objects in the user-defined toolbar:
● Symbol: To call VBA macros.
● Separator line: For clearer design of user-defined toolbars.
The "Position" parameter determines the order of the icons within the user-defined toolbar.
The "Key" parameter is a unique identification of the icon. This parameter is used if you use
the "ToolbarItemClicked" event for calling VBA macros.
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1641
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To create icons in a previously created user-defined toolbar, you can for example insert an
"InsertToolbarItems()" procedure in the document. In this example, two icons separated by
a separator line are created in the user-defined toolbar "AppToolbar1":
Sub InsertToolbarItems()
'VBA7
Dim objToolbar1 As HMIToolbar
Dim objToolbarItem1 As HMIToolbarItem
'
'Add a new toolbar:
Set objToolbar1 = Application.CustomToolbars.Add("AppToolbar1")
'Adds two toolbar-items to the toolbar
'("InsertToolbarItem(Position, Key, DefaultToolTipText)"-Methode):
Set objToolbarItem1 =
objToolbar1.ToolbarItems.InsertToolbarItem(1, "tItem1_1", "First
Symbol-Icon")
Set objToolbarItem1 =
objToolbar1.ToolbarItems.InsertToolbarItem(3, "tItem1_2", "Second
Symbol-Icon")
'
'Adds a seperator between the two toolbar-items
'("InsertSeparator(Position, Key)"-Methode):
Set objToolbarItem1 = objToolbar1.ToolbarItems.InsertSeparator(2,
"tSeparator1_3")
End Sub
4. Start the procedure with <F5>.
Result
The "InsertToolbarItems()" procedure adds a toolbar with two icons, separated by a dividing
line, to the Graphics Designer toolbars:
Note
Use the icon property in order to specify a graphic (*.ICO format) for a tool icon.
See also
Creating Customized Menus and Toolbars (Page 1631)
Icon Property (Page 2281)
InsertSeparator Method (Page 1859)
WinCC: Scripting (VBS, ANSI-C, VBA)
1642 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
InsertToolbarItem Method (Page 1862)
How to assign VBA macros to menus and toolbars (Page 1645)
How to assign help texts to menus and toolbars (Page 1643)
How to Create an Application-specific Toolbar (Page 1639)
Configuring Menus and Toolbars (Page 1630)
How to assign help texts to menus and toolbars
Requirements
You must have created the user-defined menu or the user-defined toolbar first.
Introduction
When the configuring engineer moves the mouse over a user-defined menu item or over a
user-defined icon, you can provide additional help text to explain the functionality in more detail:
● You can define a help text for user-defined menu items and icons; the help text is displayed
in the status bar.
● For user-defined icons, the default option is to create the help text as a tooltip.
You can also define status texts and tooltip texts for other languages.
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1643
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To assign a status text to a user-defined menu item, you can for example insert an
"AddStatusTextsToAppMenu1()" procedure in the document. In this example one status
text in German and one in English is assigned to the first menu item in the previously created
"AppMenu1" menu:
Sub AddStatusTextsToAppMenu1()
'VBA8
Dim objMenu1 As HMIMenu
'
'Object "objStatusTextMenuItem1" contains foreign-language texts
Dim objStatusTextMenuItem1 As HMILanguageText
Set objMenu1 = Application.CustomMenus("AppMenu1")
'
'Assign a statustext to a menuitem:
objMenu1.MenuItems("mItem1_1").StatusText = "Statustext the first
menuitem"
'
'Assign a foreign statustext to a menuitem:
Set objStatusTextMenuItem1 =
objMenu1.MenuItems("mItem1_1").LDStatusTexts.Add(1033, "This is
my first status text in English")
End Sub
4. To assign status and foreign-language tool tip text to a user-defined icon on the toolbar,
insert a "AddStatusAndTooltipTextsToAppToolbar1()" procedure in the document, for
example. In this example, the first icon on the toolbar created is assigned a status text
(German/English) and an English tool tip text:
Sub AddStatusAndTooltipTextsToAppToolbar1()
'VBA9
Dim objToolbar1 As HMIToolbar
'
'Variable "StatusTextToolbarItem1" for foreign statustexts
Dim objStatusTextToolbarItem1 As HMILanguageText
'
'Variable "TooltipTextToolbarItem1 for foreign tooltiptexts
Dim objTooltipTextToolbarItem1 As HMILanguageText
Set objToolbar1 = Application.CustomToolbars("AppToolbar1")
'
'Assign a statustext to a toolbaritem:
objToolbar1.ToolbarItems("tItem1_1").StatusText = "Statustext für
das erste Symbol-Icon"
'
'Assign a foreign statustext to a toolbaritem:
Set objStatusTextToolbarItem1 =
objToolbar1.ToolbarItems("tItem1_1").LDStatusTexts.Add(1033,
"This is my first status text in English")
'
'Assign a foreign tooltiptext to a toolbaritem:
Set objTooltipTextToolbarItem1 =
objToolbar1.ToolbarItems("tItem1_1").LDTooltipTexts.Add(1033,
"This is my first tooltip text in English")
End Sub
5. Start the procedure with <F5>.
WinCC: Scripting (VBS, ANSI-C, VBA)
1644 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Results
The status text is displayed when you move the mouse pointer over the user-defined menu
item or the icon.
See also
LDTooltipTexts Property (Page 2309)
LDStatusTexts Property (Page 2307)
LanguageTexts Object (Listing) (Page 2004)
Add Method (Page 1793)
How to assign VBA macros to menus and toolbars (Page 1645)
How to Add a New Icon to the Toolbar (Page 1641)
How to add a new menu entry to a menu (Page 1635)
Configuring Menus and Toolbars (Page 1630)
Creating Customized Menus and Toolbars (Page 1631)
How to assign VBA macros to menus and toolbars
Introduction
There are two possible ways for you to assign VBA macros to user-defined menus and toolbars:
● You can use either the VBA event handlers "MenuItemClicked" and "ToolbarItemClicked"
or
● "Macro" property.
Note
You will find the VBA code for creating the required user-defined menus and toolbars in
this documentation under "Adding a New Menu Item to a Menu" and "Adding a New Icon
to a Toolbar".
Procedure
Assigning a VBA macro with a VBA event handler
Note
You will find further information on VBA event handlers in this documentation under "Event
Handling".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1645
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
3. To start a VBA macro via the VBA event handlers, use the "MenuItemClicked" or
"ToolbarItemClicked" event:
4. Insert the VBA code from the "VBA10" table.
5. Start the procedure with <F5>.
Assigning a VBA Macro using the "Macro" property
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
WinCC: Scripting (VBS, ANSI-C, VBA)
1646 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To start a VBA macro via the Macro property, assign the VBA macro to each menu item or
icon. In the following example, a user-defined menu with two menu entries is created, which
retrieve two different VBA macros:
The VBA code of the following VBA11 example depends on the file type. The VBA code is
added as an example for a PDL and a PDT file. Both cases can be distinguished in the
following manner:
– PDL file:
The VBA code in a PDL file is only executed when this PDL file is being displayed.
– PDT file:
The VBA code in a PDT file is always executed when the Graphics Designer is open.
4. Insert the VBA code from the "VBA11" table. Sample code for PDL file or "VBA821: Sample
code for PDT file".
You can call the following two procedures via the menu items in the user-defined menu
"DocMenu1":
5. Insert the VBA code from the "VBA12" table.
6. Start the procedure with <F5>.
The following tables show the VBA codes for the example:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1647
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Start VBA via event handler (VBA10)
Option Explicit
'VBA10
'The next declaration has to be placed in the module section
Dim WithEvents theApp As grafexe.Application
Private Sub SetApplication()
'This procedure has to be executed (with "F5") first
Set theApp = grafexe.Application
End Sub
Private Sub theApp_MenuItemClicked(ByVal MenuItem As IHMIMenuItem)
Dim objClicked As HMIMenuItem
Dim varMenuItemKey As Variant
Set objClicked = MenuItem
'
'"varMenuItemKey" contains the value of parameter "Key"
'from clicked menu-item
varMenuItemKey = objClicked.Key
Select Case varMenuItemKey
Case "mItem1_1"
MsgBox "The first menuitem was clicked!"
End Select
End Sub
Private Sub theApp_ToolbarItemClicked(ByVal ToolbarItem As IHMIToolbarItem)
Dim objClicked As HMIToolbarItem
Dim varToolbarItemKey As Variant
Set objClicked = ToolbarItem
'
'"varToolbarItemKey" contains the value of parameter "Key"
'from clicked toolbar-item
varToolbarItemKey = objClicked.Key
Select Case varToolbarItemKey
Case "tItem1_1"
MsgBox "The first symbol-icon was clicked!"
End Select
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1648 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Creating a menu (VBA11: Sample code for PDL file)
Sub CreateDocumentMenusUsingMacroProperty()
'VBA11
Dim objDocMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Set objDocMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DocMenu1",
"Doc_Menu_1")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(1, "dmItem1_1",
"First Menuitem")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(2, "dmItem1_2",
"Second Menuitem")
'
'Assign a VBA-macro to every menu item
With ActiveDocument.CustomMenus("DocMenu1")
.MenuItems("dmItem1_1").Macro = "TestMacro1"
.MenuItems("dmItem1_2").Macro = "TestMacro2"
End With
End Sub
Creating a menu (VBA821: Sample code for PDT file)
Sub CreateDocumentMenusUsingMacroProperty()
'VBA821
Dim objDocMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Set objDocMenu = Application.CustomMenus.InsertMenu(1, "DocMenu1",
"Doc_Menu_1")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(1, "dmItem1_1",
"First Menuitem")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(2, "dmItem1_2",
"Second Menuitem")
'
'Assign a VBA-macro to every menu item
With Application.CustomMenus("DocMenu1")
.MenuItems("dmItem1_1").Macro = "TestMacro1"
.MenuItems("dmItem1_2").Macro = "TestMacro2"
End With
End Sub
Macros for user-defined menu entries (VBA12)
Sub TestMacro1()
'VBA12
MsgBox "TestMacro1 was executed"
End Sub
Sub TestMacro2()
MsgBox "TestMacro2 was executed"
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1649
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
See also
Macro Property (Page 2326)
ToolbarItemClicked Event (Page 1789)
MenuItemClicked Event (Page 1782)
How to Add a New Icon to the Toolbar (Page 1641)
How to add a new menu entry to a menu (Page 1635)
Event Handling (Page 1717)
Executing VBA Macros in Graphics Designer (Page 1623)
3.3.2.4 Access to WinCC libraries with VBA
Accessing the component library with VBA
Introduction
The component library contains a large selection of ready-made objects which you can use to
design your screens efficiently. The component library consists of a global library and a project-
related library:
● The "Global Library" contains prepared objects that are supplied with WinCC. The objects
are filed in folders, sorted according to subjects, such as valves, motors, cables and many
others.
● The "Project Library" contains neither objects nor folders when you have created a new
project. You can create objects which you need only in this particular project in the "Project
Library".
VBA gives you full access to the component library: You can create and delete folders and
save objects in the component library or insert them into pictures.
Access to the component library with VBA
WinCC: Scripting (VBS, ANSI-C, VBA)
1650 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
The component library is represented in VBA by the "SymbolLibraries" listing. The listing
contains two elements, which represent the "Global Library" and the "Project Library". The
"FolderItems" listing contains elements, which represent folders as well as objects.
Note
To address an object in the "SymbolLibraries" listing you use either the index number or the
internal name.
You can find out the internal name by clicking the right mouse button on the relevant object in
the component library and then choosing the "Copy path" command in the pop-up menu.
The path to the object within the component library is then copied to the clipboard.
Global Library (1)
The "Global Library" is the first element in the SymbolLibraries listing, which you address using
index number "1". You address the "Project Library" using index number "2".
Access to the "Global Library" with VBA:
'VBA17
Application.SymbolLibraries(1)
Folder (2)
A folder in the component library contains either other folders or the objects of a particular
subject area. In VBA a folder corresponds to the "FolderItem" object and its type is "Folder".
The folders are contained in the "FolderItems" listing. With VBA you can create a new folder
or delete an existing one, and add an object to the folder via the clipboard.
Access to the "Plant Components" folder with VBA:
'VBA18
Application.SymbolLibraries(1).FolderItems("Folder2")
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1651
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Object (3)
In VBA an object corresponds to the "FolderItem" object and its type is "Item". The objects are
contained in the "Folder" listing. With VBA you can delete an object or copy it to the clipboard.
Access to the "PC" object with VBA:
'VBA19
Application.SymbolLibraries(1).FolderItems("Folder2").Folder("Folder2").Folder.Item("Objec
t1").DisplayName
Creating or deleting folders in the component library
Use the following methods to create or delete folders:
● "AddFolder(DefaultName)" Method: Creates a new folder in the components library. A
newly created folder receives the internal name "FolderX", where "X" stands for a
consecutive number.
● "Delete()" Method: Deletes an existing folder (including all folders and objects that it
contains) from the component library.
Inserting or deleting an object in the component library
You can copy objects within the component library (for example from the "Global Library" to
the "Project Library"), insert an object from a picture into the component library or delete an
object from the component library:
● Methoden "CopyToClipboard()" und "AddFromClipboard()": Copies an object to the
clipboard within the component library.
● "AddItem(DefaultName, pHMIObject)" method: Copies an existing object in the picture into
a folder in the component library.
● "Delete()" Method: Deletes an object.
Finding an object or folder in the component library
Use the "FindByDisplayName("DisplayName") method to search for an object or folder. The
specified display name is dependent on which language is currently set. The search ends with
the first occurrence of the object or folder that you are looking for.
Inserting an object into a picture from the component library
Use the "CopyToClipboard()" and "PasteClipboard()" methods to insert an object from the
component library into the current picture.
See also
CopyToClipboard Method (Page 1830)
PasteClipboard Method (Page 1874)
WinCC: Scripting (VBS, ANSI-C, VBA)
1652 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
GetItemByPath Method (Page 1853)
FindByDisplayName Method (Page 1848)
Delete Method (Page 1837)
AddItem Method (Page 1809)
AddFromClipboard Method (Page 1806)
AddFolder Method (Page 1805)
SymbolLibrary Object (Page 2084)
SymbolLibraries Object (Listing) (Page 2082)
How to paste an object from the object library into a picture with VBA (Page 1656)
How to edit the component library with VBA (Page 1653)
How to edit the component library with VBA
Introduction
Here you will find the following instructions for editing the component library with VBA:
● Creating a new folder
● Copying an object within the component library
● Copying an object from the active picture into the component library
● Deleting an object from the component library
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1653
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To create a new folder in the component library, you can for example insert an
"AddNewFolderToProjectLibrary()" procedure in the document. In this example the folder
"My folder" is created:
Sub AddNewFolderToProjectLibrary()
'VBA20
Dim objProjectLib As HMISymbolLibrary
Set objProjectLib = Application.SymbolLibraries(2)
'
'("AddFolder(DefaultName)"-Methode):
objProjectLib.FolderItems.AddFolder ("Custom Folder")
End Sub
4. In order to copy an object from the "global library" to the "library project", insert a
"CopyObjectFromGlobalLibraryToProjectLibrary()" procedure in the document, for
example. In this example, the object "Object1" is copied:
Sub CopyObjectFromGlobalLibraryToProjectLibrary()
'VBA21
Dim objGlobalLib As HMISymbolLibrary
Dim objProjectLib As HMISymbolLibrary
Set objGlobalLib = Application.SymbolLibraries(1)
Set objProjectLib = Application.SymbolLibraries(2)
'
'Copies object "PC" from the "Global Library" into the clipboard
objGlobalLib.FolderItems("Folder2").Folder("Folder2").Folder.Item(
"Object1").CopyToClipboard
'
'The folder "Custom Folder" has to be available
objProjectLib.FolderItems("Folder1").Folder.AddFromClipBoard
("Copy of PC/PLC")
End Sub
5. In order to copy an object from the active picture to the "Project Library", insert a procedure
like "AddObjectFromPictureToProjectLibrary()" into document. In this example, the object
"Circle1" is created in the active picture and then copied to the folder "Folder1":
Sub AddObjectFromPictureToProjectLibrary()
'VBA22
Dim objProjectLib As HMISymbolLibrary
Dim objCircle As HMICircle
Set objProjectLib = Application.SymbolLibraries(2)
'
'Insert new object "Circle1"
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle1",
"HMICircle")
'
'The folder "Custom Folder" has to be available
'("AddItem(DefaultName, pHMIObject)"-Methode):
objProjectLib.FolderItems("Folder1").Folder.AddItem "ProjectLib
Circle", ActiveDocument.HMIObjects("Circle1")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1654 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
6. To delete an object from the component library, insert a "DeleteObjectFromProjectLibrary()"
procedure in the document, for example. In this example the previously created folder
"Folder1" is deleted:
Sub DeleteObjectFromProjectLibrary()
'VBA23
Dim objProjectLib As HMISymbolLibrary
Set objProjectLib = Application.SymbolLibraries(2)
'
'The folder "Custom Folder" has to be available
"Delete" Method:
objProjectLib.FolderItems("Folder1").Delete
End Sub
7. Start the procedure with <F5>.
See also
SymbolLibrary Object (Page 2084)
SymbolLibraries Object (Listing) (Page 2082)
PasteClipboard Method (Page 1874)
Delete Method (Page 1837)
CopyToClipboard Method (Page 1830)
AddItem Method (Page 1809)
AddFromClipboard Method (Page 1806)
AddFolder Method (Page 1805)
How to paste an object from the object library into a picture with VBA (Page 1656)
Accessing the component library with VBA (Page 1650)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1655
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
How to paste an object from the object library into a picture with VBA
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
WinCC: Scripting (VBS, ANSI-C, VBA)
1656 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To insert an object from the "Global Library" into the active picture, you can for example
insert a "CopyObjectFromGlobalLibraryToActiveDocument()" procedure in the document.
In this example the object "Object1" is inserted
Sub CopyObjectFromGlobalLibraryToActiveDocument()
'VBA24
Dim objGlobalLib As HMISymbolLibrary
Dim objHMIObject As HMIObject
Dim iLastObject As Integer
Set objGlobalLib = Application.SymbolLibraries(1)
'
'Copy object "PC" from "Global Library" to clipboard
objGlobalLib.FolderItems("Folder2").Folder("Folder2").Folder.Item(
"Object1").CopyToClipboard
'
'Get object from clipboard and add it to active document
ActiveDocument.PasteClipboard
'
'Get last object
iLastObject = ActiveDocument.HMIObjects.Count
Set objHMIObject = ActiveDocument.HMIObjects(iLastObject)
'
'Set position of the object:
With objHMIObject
.Left = 40
.Top = 40
End With
End Sub
4. Start the procedure with <F5>.
Note
iLastObject
Via "iLast Object" you select the object inserted last if only the same objects were inserted.
If several different objects are inserted, the internal sequence might change.
See also
PasteClipboard Method (Page 1874)
CopyToClipboard Method (Page 1830)
How to edit the component library with VBA (Page 1653)
Accessing the component library with VBA (Page 1650)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1657
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
How to create and export an SVG library with VBA
Introduction
This example contains instructions on creating, importing and exporting an SVG library with
VBA:
● Create new, empty SVG library (Step 3)
● Import SVG library from a ZIP file (Step 4)
● Create new SVG library by importing a folder path (Step 5)
● Import global SVG library for the current WinCC project into the project SVG library (Step
6)
● Disable write protection of an SVG library (Step 7)
● Enable write protection of an SVG library (Step 8)
● Export SVG library (Step 9)
Procedure
1. Open the VBA editor in Graphics Designer:
<Alt+F11> or "Tools > Macros > Visual Basic Editor".
2. In Project Explorer, open the document in which you want to write the VBA code:
3. To create a new SVG library, insert a "CreateEmptyProjectSVGlibrary()" procedure, for
example, into the document.
In this example, the project SVG library "NewSVGLibrary" is created:
Sub CreateEmptyProjectSVGlibrary()
'VBA916
Dim objProjectLib As HMISVGLibrary
Set objProjectLib = Application.SVGAddLibrary("NewSVGLibrary")
End Sub
4. To import SVG graphics from a ZIP file as new project SVG library, insert an
"ImportZIPProjectSVGlibrary()" procedure, for example, into the document.
A ZIP file with SVG graphics must be available for this purpose. This ZIP file can contain
either an exported SVG library or a compressed folder structure with SVG graphics.
In this example, the "SVGImages.ZIP" file is imported and the SVG library "SVGImages"
is thereby created.
In this example, the ZIP file is located in the following folder: C:\Temp\SVG_folder
Sub ImportZIPProjectSVGlibrary()
'VBA917
Dim objProjectLib As HMISVGLibrary
Set objProjectLib = Application.SVGImportLibrary("C:\Temp
\SVG_folder\SVGImages.ZIP")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1658 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
5. To create a new project SVG library when importing SVG graphics from a folder, insert an
"ImportFolderProjectSVGlibrary()" procedure, for example, into the document.
The project SVG library cannot yet contain a project library with the name of the imported
folder.
In this example, the "FolderSVGImages" folder is imported and the SVG library
"FolderSVGImages" is thereby created.
In this example, the following folder is imported: C:\Temp\SVG_folder\FolderSVGImages
Sub ImportFolderProjectSVGlibrary()
'VBA918
Dim objProjectLib As HMISVGLibrary
Set objProjectLib = Application.SVGImportLibrary("C:\Temp
\SVG_Folder\FolderSVGImages")
End Sub
6. To import the contents of a global SVG library in a project SVG library, insert a
"UseInProjectSVGlibrary()" procedure, for example, into the document.
In this example, the contents of the global SVG library are imported as new project library:
Sub UseInProjectSVGlibrary()
'VBA919
Dim objGlobalLib As HMISVGLibrary
Set objGlobalLib = Application.SVGLibraries(1)
objGlobalLib.UseInProject
End Sub
7. The new project library is created write-protected when a global SVG library is imported.
To disable write protection, insert an "UndoReadOnlyProjectSVGlibrary()" procedure, for
example, into the document.
In this example, the write protection of the new project library is disabled when the global
SVG library is imported:
Sub UndoReadOnlyProjectSVGlibrary()
'VBA920
Dim objGlobalLib As HMISVGLibrary
Dim objProjectLib As HMISVGLibrary
Set objGlobalLib = Application.SVGLibraries(1)
objGlobalLib.UseInProject
Set objProjectLib = Application.SVGLibraries(2)
objProjectLib.UndoReadOnly
End Sub
8. To enable write protection of a project library, insert a "ReadOnlyProjectSVGlibrary()"
procedure, for example, into the document.
The SVG objects of the project library can be used in the WinCC project, but they cannot
be changed. In a write-protected project library, objects cannot be added, deleted or
renamed.
In this example, write protection of the imported project library is enabled:
Sub ReadOnlyProjectSVGlibrary()
'VBA921
Dim objProjectLib As HMISVGLibrary
Set objProjectLib = Application.SVGLibraries(2)
objProjectLib.MakeReadOnly
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1659
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
9. To export a project library into a ZIP file, insert an "ExportZIPProjectSVGlibrary()"
procedure, for example, into the document.
In this example, the contents of the project library "SVGLibraries(2)" are exported into a
ZIP file in the following folder: C:\Temp\SVG_folder
Sub ExportProjectSVGlibrary()
'VBA922
Dim objProjectLib As HMISVGLibrary
Set objProjectLib = Application.SVGLibraries(2)
objProjectLib.ExportLibrary ("C:\Temp\SVG_folder")
End Sub
10.Start the procedure with <F5>.
See also
SVGLibraries object (list) (Page 2077)
SVGLibrary object (Page 2078)
How to edit an SVG library with VBA (Page 1660)
How to edit an SVG library with VBA
Introduction
Here you will find the following instructions for editing the SVG library with VBA:
● Create new folder (Step 3)
● Copy object within the SVG library (Step 4)
● Copy from the active picture into the SVG library (Step 5)
● Delete object in the SVG library (Step 6)
● Import folder and SVG graphics into a project library (Step 7)
● Import SVG graphic from a folder into a project library (Step 8)
Procedure
1. Open the VBA editor in Graphics Designer:
<Alt+F11> or "Tools > Macros > Visual Basic Editor".
2. In Project Explorer, open the document in which you want to write the VBA code:
WinCC: Scripting (VBS, ANSI-C, VBA)
1660 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To create a new folder in the project SVG library, insert an
"AddNewFolderToProjectSVGLibrary()" procedure, for example, into the document.
In this example, the "CustomFolder" folder is created:
Sub AddNewFolderToProjectSVGLibrary()
'VBA923
Dim objProjectLib As HMISVGLibrary
Set objProjectLib = Application.SVGLibraries(2)
'
'("AddFolder(DefaultName)"-Methode):
objProjectLib.FolderItems.AddFolder ("CustomFolder")
End Sub
4. To copy an object from the "Global SVG Library" to the "Project SVG Library", insert a
"CopyObjectFromGlobaSVGlLibraryToProjectSVGLibrary()" procedure, for example, into
the document.
In this example, the "ProjectLib SVG" object is copied:
Sub CopyObjectFromGlobaSVGlLibraryToProjectSVGLibrary()
'VBA924
Dim objGlobalLib As HMISVGLibrary
Dim objProjectLib As HMISVGLibrary
Set objGlobalLib = Application.SVGLibraries(1)
Set objProjectLib = Application.SVGLibraries(2)
'
'Copies object "PC" from the "Global SVG Library" into the
clipboard
objGlobalLib.FolderItems("Folder1").Folder.Item("ProjectLib
SVG").CopyToClipboard
'
'The folder "CustomFolder" has to be available.
objProjectLib.FolderItems("Folder1").Folder.AddFromClipBoard
("Copy of ProjectLib SVG")End Sub
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1661
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
5. To copy an object from the active picture to the "Project SVG Library", insert an
"AddObjectFromPictureToProjectSVGLibrary()" procedure, for example, into the document.
In this example, an SVG object is created in the active picture, connected with a
"CompanyLogo.svg" SVG graphic and then copied to "Folder1".
In this example, the SVG graphic is located in the following folder: C:\Temp\SVG_folder
Sub AddObjectFromPictureToProjectSVGLibrary()
'VBA925
Dim objProjectLib As HMISVGLibrary
Dim objSVG As HMISVGObject
Dim objCircle As HMICircle
Set objProjectLib = Application.SVGLibraries("LibSVG5")
'
'Insert new object "SVG object - objSVG"
Set objSVG = ActiveDocument.HMIObjects.AddHMIObject("objSVG",
"HMISVGObject")
objSVG.PictureName = "C:\Temp\SVG_folder\CompanyLogo.svg"
'
'The folder "CustomFolder" has to be available.
'("AddItem(DefaultName, pHMIObject)"-Methode):
objProjectLib.FolderItems("Folder2").Folder.AddItem "ProjectLib
HMISVGObject11", ActiveDocument.HMIObjects("objSVG")
End Sub
6. To delete an object from the SVG library, insert a "DeleteObjectFromProjectSVGLibrary()"
procedure, for example, into the document.
In this example the previously created folder "Folder1" is deleted:
Sub DeleteObjectFromProjectSVGLibrary()
'VBA926
Dim objProjectLib As HMISVGLibrary
Set objProjectLib = Application.SVGLibraries(2)
'
'The folder "CustomFolder" has to be available.
"Delete" Method:
objProjectLib.FolderItems("Folder1").Delete
End Sub
7. To import a folder with SVG graphics into a project library, insert an
"ImportFolderItemsProjectSVGlibrary()" procedure, for example, into the document.
In this example, the following folder and the contained SVG graphics are imported into the
"NewSVGLibrary" project library: C:\Temp\SVG_folder\NewSVGImages
Sub ImportFolderItemsProjectSVGlibrary()
'VBA927
Dim objProjectLib As HMISVGLibrary
Set objProjectLib = Application.SVGLibraries("NewSVGLibrary")
' Import folder directly under the root library
objProjectLib.ImportFolder ("C:\Temp\SVG_folder\NewSVGImages")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1662 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
8. To import an SVG graphic into a project library, insert an
"ImportItemFromFolderProjectSVGlibrary()" procedure, for example, into the
document.
In this example, the SVG graphic "UserGraphic.svg" is imported from the following path
into the project library "NewSVGLibrary": C:\Temp\SVG_folder\NewSVGImages
Sub ImportItemFromFolderProjectSVGlibrary()
'VBA928
Dim objProjectLib As HMISVGLibrary
Set objProjectLib = Application.SVGLibraries("NewSVGLibrary")
' traverse folders and then import
objProjectLib.FolderItems("Folder1").Folder.ImportFolder ("C:\Temp
\SVG_folder\UserGraphic.svg")
End Sub
9. Start the procedure with <F5>.
See also
SVGLibraries object (list) (Page 2077)
SVGLibrary object (Page 2078)
How to create and export an SVG library with VBA (Page 1658)
3.3.3 Editing Pictures with VBA
3.3.3.1 Editing Pictures with VBA
Introduction
Pictures visualize the process to be executed and observed. They display the important
process steps or plant parts and present the production process in a schematic manner. In
VBA the picture is represented by the Document object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1663
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Picture-specific menus and toolbars
In contrast with the application-specific menus and toolbars, the picture-specific menus and
toolbars are coupled to a specific picture. The picture-specific menus and toolbars remain
visible for as long as the picture is active.
You should use picture-specific menus and toolbars when the called VBA macros are only
used in that picture.
Layers
You can access the layers in the Graphics Designer with VBA. Each layer is represented by
the Layer object. By changing the properties of the Layer object you can specify among other
things the layer names and the zoom settings.
You control the visibility of the RT layers via the Document object. You control the visibility of
the CS layers via the View object.
Copies of the picture
You can create copies of a picture with VBA in order to display different views of a picture. The
copy of a picture is represented in VBA by the View object.
In the properties of the View object you can among other things set the zoom factor and specify
which picture section is to be displayed.
Note
If you want to run VBA code in a picture saved in WinCC V7.0 SP1 under WinCC V7.0, you
need to deactivate the "CCHMIDotNetObj 1.0 Type Library" in the VBA Editor under "Tools >
References".
The VBA program will then be executed within the usual functional scope of WinCC V7.0. In
this case, you cannot use the new functions of WinCC V7.0 SP1.
See also
Editing a Copy of a Picture with VBA (Page 1668)
How to Create Picture-specific Menus and Toolbars (Page 1665)
Editing Layers with VBA (Page 1666)
Editing Objects with VBA (Page 1670)
Adapting the Graphics Designer with VBA (Page 1627)
WinCC: Scripting (VBS, ANSI-C, VBA)
1664 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3.3.3.2 How to Create Picture-specific Menus and Toolbars
Introduction
Picture-specific menus and toolbars are linked to a specific picture and remain visible for as
long as the You should use picture-specific menus and toolbars when the VBA macros used
there are relevant only for that particular picture.
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor").
2. Open the document "ThisDocument" in the Project Explorer:
3. To create a picture-specific menu, you can for example insert a "CreateDocumentMenus()"
procedure in the document "ThisDocument":
Sub CreateDocumentMenus()
'VBA25
'Declare menuobjects:
Dim objMenu1 As HMIMenu
Dim objMenu2 As HMIMenu
'Insert Menus ("InsertMenu"-Methode) with
'Parameters - "Position", "Key", "DefaultLabel":
Set objMenu1 = ActiveDocument.CustomMenus.InsertMenu(1,
"DocMenu1", "Doc_Menu_1")
Set objMenu2 = ActiveDocument.CustomMenus.InsertMenu(2,
"DocMenu2", "Doc_Menu_2")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1665
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
4. In order to create a picture-specific toolbar, insert a procedure like
"CreateDocumentToolbars()" into the document "ThisDocument":
Sub CreateDocumentToolbars()
'VBA26
'Declare required number of toolbarobjects:
Dim objToolbar1 As HMIToolbar
Dim objToolbar2 As HMIToolbar
'
'Insert toolbars ("Add"-Methode) with
'Parameter - "Key":
Set objToolbar1 = ActiveDocument.CustomToolbars.Add("DocToolbar1")
Set objToolbar2 = ActiveDocument.CustomToolbars.Add("DocToolbar2")
End Sub
5. Always start the procedure with <F5>.
See also
Add Method (CustomToolbars Listing) (Page 1795)
InsertMenu Method (Page 1856)
How to assign VBA macros to menus and toolbars (Page 1645)
How to assign help texts to menus and toolbars (Page 1643)
How to Add a New Icon to the Toolbar (Page 1641)
How to create menus in multiple languages (Page 1637)
How to add a new menu entry to a menu (Page 1635)
Creating Customized Menus and Toolbars (Page 1631)
Configuring Menus and Toolbars (Page 1630)
3.3.3.3 Editing Layers with VBA
Introduction
You can arrange objects in 32 layers in the Graphics Designer. The layers are differentiated
according to CS layers and RT layers so that the visibility of the layers in the picture (CS) and
in runtime (RT) can be controlled separately. In VBA a layer is represented by the Layer object:
In the Graphics Designer the lowest layer is "Layer 0". To give back the lowest layer with VBA,
use the index "1":
WinCC: Scripting (VBS, ANSI-C, VBA)
1666 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
ActiveDocument.Layers(1)
Using the Layer object
You use the Layer object in order to specify the minimum and maximum zoom for a layer and
to assign a name. In the following example the settings for the lowest layer are configured in
the active picture:
Sub ConfigureSettingsOfLayer
'VBA27
Dim objLayer As HMILayer
Set objLayer = ActiveDocument.Layers(1)
With objLayer
'Configure "Layer 0"
.MinZoom = 10
.MaxZoom = 100
.Name = "Configured with VBA"
End With
End Sub
Controlling the visibility of CS and RT layers
You control the visibility of the CS layers via the View object. Use the Document object in order
to determine which layers are to be displayed or hidden in runtime. You can control the visibility
of the CS and RT layers with the following methods:
● Methode "IsCSLayerVisible(Index)": Checks whether the specified CS layer is displayed.
● Methode "SetCSLayerVisible(Index, Val)": Shows or hides the specified CS layer.
Use the IsRTLayerVisible and SetRTLayerVisible methods for the RT layers in the same way.
See also
IsRTLayerVisible Method (Page 1864)
SetRTLayerVisible Method (Page 1893)
SetCSLayerVisible Method (Page 1891)
IsCSLayerVisible Method (Page 1863)
Layers Object (Listing) (Page 2006)
Editing Pictures with VBA (Page 1663)
Language-Dependent Configuration with VBA (Page 1628)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1667
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3.3.3.4 Editing a Copy of a Picture with VBA
Introduction
You can create copies of a picture with VBA in order to display different views of a picture.
Each view is shown in a separate window. The copy of a picture is represented in VBA by the
View object:
In the properties of the View object you can among other things set the zoom factor and specify
which picture section is to be displayed.
Creating a copy of a picture
Use the Add method to create a copy of the specified picture. In this example a copy of the
active picture is created and activated:
Sub CreateAndActivateView()
'VBA28
Dim objView As HMIView
Set objView = ActiveDocument.Views.Add
objView.Activate
End Sub
Editing a copy of a picture
You can edit each copy of a screen as follows:
● Adjust zoom factor: Use the zoom property.
● Specify picture zoom area: Specify the picture section: use the "ScrollPosX" and
"ScrollPosY" properties to specify the picture zoom area using the scroll bars.
● Showing and Hiding CS layers: You can use the SetCSLayerVisible(Index) method for
example to show or hide the specified layer. You can select the layer on which you want
to edit the objects with the ActiveLayer property.
WinCC: Scripting (VBS, ANSI-C, VBA)
1668 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
In the following example a copy of the active picture is created and activated. The zoom factor
is set to 150% and the position of the scrollbars is changed:
Sub SetZoomAndScrollPositionInActiveView()
'VBA29
Dim objView As HMIView
Set objView = ActiveDocument.Views.Add
With objView
.Activate
.ScrollPosX = 40
.ScrollPosY = 10
.Zoom = 150
End With
End Sub
See also
Add Method (Views Listing) (Page 1800)
ScrollPosY Property (Page 2414)
ScrollPosX Property (Page 2413)
ActiveLayer Property (Page 2117)
View Object (Page 2111)
SetCSLayerVisible Method (Page 1891)
IsCSLayerVisible Method (Page 1863)
Activate Method (Page 1792)
Editing Layers with VBA (Page 1666)
Editing Pictures with VBA (Page 1663)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1669
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3.3.4 Editing Objects with VBA
3.3.4.1 Editing Objects with VBA
Access to objects in the Graphics Designer
In VBA all object types of the current picture are contained in the "HMIObjects" listing. They
are not divided according to object type (Standard, Smart, Windows and Controls objects) as
in the Graphics Designer. With VBA you can therefore run through all objects in one or more
pictures with a loop.
When you have selected objects in the picture, these objects are contained in the "Selection"
listing. Use the "HMIDefaultObjects" listing if you want to change the default settings of the
properties of an object.
To address an object in a picture with VBA, use either the object name, e.g.
"ActiveDocument.HMIObjects("Circle1"), or the index number. "
ActiveDocument.HMIObjects(1)" references for example the first object in the active picture.
Editing objects with VBA
You have the following possibilities for editing objects with VBA:
● Create a new object in a picture
● Delete an existing object
● Copy an existing object
● Group existing objects or cancel the grouping
● Search for objects
● Display or change object properties
When you insert a new object into a picture with VBA, the object behaves in the same way as
if you double-clicked it in the Graphics Designer object palette.
The object is given the predefined property values and is inserted in the top left-hand corner
of the picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
1670 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Access to the object properties is dependent on how you created the object. Two examples
illustrate this:
Example 1:
In this example a circle of the type "HMIObject" is inserted into the current picture. You can
use a VBA object of the "HMIObject" type or all objects in the Graphics Designer. However,
you have to address individual properties of the respective object explicitly via the
"Properties(Index)" property:
Sub AddObject()
'VBA30
Dim objObject As HMIObject
Set objObject = ActiveDocument.HMIObjects.AddHMIObject("CircleAsHMIObject", "HMICircle")
'
'standard-properties (e.g. the position) are available every time:
objObject.Top = 40
objObject.Left = 40
'
'non-standard properties can be accessed using the Properties-collection:
objObject.Properties("FlashBackColor") = True
End Sub
Example 2:
In this example a circle of the type "HMICircle" is inserted into the current picture. In contrast
with Example 1 you can only use the "objCircle" object for objects of the "HMICircle" type,
however:
Sub AddCircle()
'VBA31
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("CircleAsHMICircle", "HMICircle")
'
'The same as in example 1, but here you can set/get direct the
'specific properties of the circle:
objCircle.Top = 80
objCircle.Left = 80
objCircle.FlashBackColor = True
End Sub
See also
LanguageFonts Object (Listing) (Page 2001)
VBA Reference (Page 1752)
Underlined Property (Page 2463)
Size Property (Page 2422)
Parent Property (Page 2364)
LanguageID Property (Page 2296)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1671
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Italic Property (Page 2288)
Family Property (Page 2236)
Bold Property (Page 2158)
Application Property (Page 2129)
3.3.4.2 Default objects, Smart objects, Windows objects and Tube objects
Default objects, Smart objects, Windows objects and Tube objects
Introduction
You use the Standard, Smart and Windows objects to design your pictures. In the Graphics
Designer, these objects are available in the "Default" selection window:
VBA enables you to access these objects in all pictures in your project. If, for example, you
want to change the background color of all circles in a project with several pictures, you can
do this with a VBA macro.
Paste Object into Picture
Use the "AddHMIObject(ObjectName, ProgID)" method to insert a new object in a picture.
"ObjectName" stands for the name of the object (e.g. "my Circle"), and "ProgID" for the VBA
object designation (e.g. "HMICircle"):
Sub AddCircle()
'VBA32
'Creates object of type "HMICircle"
Dim objCircle As HMICircle
'
'Add object in active document
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("My Circle", "HMICircle")
End Sub
Edit Object
VBA gives you access to all object properties, which you can edit via the object's properties
dialog. You can change and output object properties, and select objects in the picture. If you
have not selected an object, you can use the following methods:
● "Find()" method: Searches for an object in the "HMIObjects" listing
● "Delete()" Method: Deletes an HMIObject object.
WinCC: Scripting (VBS, ANSI-C, VBA)
1672 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
If you have selected objects, you can edit them via the "Selection" listing with the following
methods, among others:
● "AlignLeft()", "AlignRight()", "AlignTop()", "AlignBottom()": These methods align objects.
● "CreateGroup()", "CreateCustomizedObject()": These methods create a group object or
customized object.
● "DeselectAll()" method: Cancels the selection of all objects
Remove VBA:references with "Nothing"
Always remove the references used for the Controls, the standard objects, and for the
document after you closed the document. For this purpose, set the objects to "Nothing". The
following example shows the code for a Control:
Public Sub DrawNewControl
'VBA861
Const strFct = "CreatePdls"
Dim objControl As HMIObject
Dim objDoc As Document
On Local Error GoTo errorhandler
'open the document
Set objDoc =
grafexe.Application.Documents.Open(grafexe.Application.ApplicationDa
taPath & "PDL1.pdl", hmiOpenDocumentTypeInvisible)
'create new object
Set objControl = objDoc.HMIObjects.AddActiveXControl("Control1",
"CCAxUserArchiveControl.AxUserArchiveControl.1")
If objControl Is Nothing Then
GoTo errorhandler
End If
'doing something with the control
'......
'delete reference to new control
Set objControl = Nothing
'saving PDL and deleting reference to it
objDoc.Save
objDoc.Close
Set objDoc = Nothing
Exit Sub
' errorhandler
errorhandler:
If MsgBox("Error occurred" & vbNewLine & "Yes - resume next" &
vbNewLine & "No - stop script", vbOKCancel + vbCritical, strFct) =
vbOK Then
Resume Next
End If
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1673
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
See also
Parent Property (Page 2364)
Item Property (Page 2289)
Count Property (Page 2208)
Application Property (Page 2129)
How to edit Default objects, Smart objects, Windows objects and Tube objects
Introduction
Here you will find the following instructions for editing Standard, Smart and Windows objects:
● Define properties of a specific object
● Define properties of a nonspecific object
● Select an object in the active picture
● Find objects in the active picture
● Delete object
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. Open the document "ThisDocument" in the Project Explorer:
WinCC: Scripting (VBS, ANSI-C, VBA)
1674 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To define the properties of a specific object type (e.g. "HMICircle"), you can for example
insert an "EditDefinedObjectType()" procedure in the document "ThisDocument". In this
example a circle is inserted in the active picture and its line weight and color are modified:
Sub EditDefinedObjectType()
'VBA33
Dim objCircle As HMICircle
Set objCircle =
ActiveDocument.HMIObjects.AddHMIObject("myCircleAsCircle",
"HMICircle")
With objCircle
'direct calling of objectproperties available
.BorderWidth = 4
.BorderColor = RGB(255, 0, 255)
End With
End Sub
4. To change the properties of a nonspecific object type ("HMIObject"), insert a
"EditHMIObject()" procedure in the document "ThisDocument", for example. In this example
a circle is inserted in the active picture and its line weight and color are modified:
Sub EditHMIObject()
'VBA34
Dim objObject As HMIObject
Set objObject =
ActiveDocument.HMIObjects.AddHMIObject("myCircleAsObject",
"HMICircle")
With objObject
'Access to objectproperties only with property "Properties":
.Properties("BorderWidth") = 4
.Properties("BorderColor") = RGB(255, 0, 0)
End With
End Sub
5. To select an object in the current picture, insert a "SelectObject()" procedure in the
document "ThisDocument", for example. In this example, a circle will be inserted in the
active picture and selected:
Sub SelectObject()
'VBA35
Dim objObject As HMIObject
Set objObject =
ActiveDocument.HMIObjects.AddHMIObject("mySelectedCircle",
"HMICircle")
ActiveDocument.HMIObjects("mySelectedCircle").Selected = True
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1675
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
6. To search for an object in the current picture, insert a "FindObjectsByName()",
"FindObjectsByType()," or "FindObjectsByProperty()" procedure in the document
"ThisDocument", for example. In this example, objects containing the string "Circle" in their
name are searched for:
Sub FindObjectsByName()
'VBA36
Dim colSearchResults As HMICollection
Dim objMember As HMIObject
Dim iResult As Integer
Dim strName As String
'
'Wildcards (?, *) are allowed
Set colSearchResults =
ActiveDocument.HMIObjects.Find(ObjectName:="*Circle*")
For Each objMember In colSearchResults
iResult = colSearchResults.Count
strName = objMember.ObjectName
MsgBox "Found: " & CStr(iResult) & vbCrLf & "Objectname: " &
strName
Next objMember
End Sub
In this example a search is run in the active picture for objects of the type "HMICircle":
Sub FindObjectsByType()
'VBA37
Dim colSearchResults As HMICollection
Dim objMember As HMIObject
Dim iResult As Integer
Dim strName As String
Set colSearchResults =
ActiveDocument.HMIObjects.Find(ObjectType:="HMICircle")
For Each objMember In colSearchResults
iResult = colSearchResults.Count
strName = objMember.ObjectName
MsgBox "Found: " & CStr(iResult) & vbCrLf & "Objektname: " &
strName
Next objMember
End Sub
In this example a search is run in the active picture for objects with the property "BackColor":
Sub FindObjectsByProperty()
'VBA38
Dim colSearchResults As HMICollection
Dim objMember As HMIObject
Dim iResult As Integer
Dim strName As String
Set colSearchResults =
ActiveDocument.HMIObjects.Find(PropertyName:="BackColor")
For Each objMember In colSearchResults
iResult = colSearchResults.Count
strName = objMember.ObjectName
MsgBox "Found: " & CStr(iResult) & vbCrLf & "Objectname: " &
strName
Next objMember
WinCC: Scripting (VBS, ANSI-C, VBA)
1676 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
End Sub
7. To delete an object, you can for example insert a "DeleteObject()" procedure in the
document "ThisDocument". In this example the first object in the active picture will be
deleted.
Sub DeleteObject()
'VBA39
'Delete first object in active document:
ActiveDocument.HMIObjects(1).Delete
End Sub
8. Start the procedure with <F5>.
See also
Find Method (Page 1847)
Delete Method (Page 1837)
AddHMIObject Method (Page 1807)
How to edit Default objects, Smart objects, Windows objects and Tube objects (Page 1674)
Editing Objects with VBA (Page 1670)
OLE Objects
Introduction
You can use VBA to insert OLE Elements into a picture. The OLE Element belongs to the
Smart objects. In the Graphics Designer, the object is available in the "Default" selection
window:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1677
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Paste OLE Element in Picture
Use the "AddOLEControl(ObjectName, ServerName, [CreationType], [UseSymbol]) method
to insert an OLE Element into a picture. ObjectName" stands for the object name, and
"ServerName" for the application that is to be contained in the OLE Element. The
"ServerName" parameter corresponds to the object type in the "object insertion dialog. The
last two parameters are optional and represent the possible settings" in the dialog displayed:
6HUYHU1DPH
You will find further information on the parameters in this documentation under "AddOLEObject
method".
In the following example an OLE Element containing a Wordpad document will be inserted
into the active picture:
Sub AddOLEObjectToActiveDocument()
'VBA40
Dim objOLEObject As HMIOLEObject
Set objOLEObject = ActiveDocument.HMIObjects.AddOLEObject("MS Wordpad Document1",
"Wordpad.Document.1")
End Sub
The OLEObject object is added to the "HMIObjects" listing as the last element and inherits the
properties of the HMIObject object.
See also
OLEObject Object (Page 2027)
AddOLEObject Method (Page 1810)
How to edit Default objects, Smart objects, Windows objects and Tube objects (Page 1674)
Default objects, Smart objects, Windows objects and Tube objects (Page 1672)
Editing Objects with VBA (Page 1670)
WinCC: Scripting (VBS, ANSI-C, VBA)
1678 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
ActiveX controls
Introduction
You can use VBA to insert ActiveX controls into a picture. In the Graphics Designer, you can
find the ActiveX controls supplied with WinCC in the "Controls" selection window:
Further information is provided under "AddActiveXControl method" in this documentation and
under "Working with controls" in the WinCC documentation.
Integrating standard ActiveX controls
As well as the ActiveX controls supplied with WinCC, you can insert all standard ActiveX
controls registered in the operating system into a picture. This means that you also have the
option of using ActiveX controls that you have programmed yourself in your pictures. A list of
the standard ActiveX controls tested with WinCC is given in the WinCC documentation.
Inserting an ActiveX control into a picture
Use the "AddActiveXControl(ObjectName, ProgID)" method to insert a new ActiveX control
into a picture. ObjectName" stands for the name of the ActiveX control (e.g. "WinCC Gauge"),
and "ProgID" for the VBA object designation (e.g. "XGauge.XGauge.1"):
Sub AddActiveXControl()
'VBA41
Dim objActiveXControl As HMIActiveXControl
Set objActiveXControl = ActiveDocument.HMIObjects.AddActiveXControl("WinCC_Gauge",
"XGAUGE.XGaugeCtrl.1")
End Sub
The ActiveXControl object is added to the "HMIObjects" listing as the last element and inherits
the properties of the HMIObject object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1679
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Access to the properties of the ActiveX control
You must address the object-specific properties of the ActiveX control via the
"Properties(Index)" property. You can find out which properties a ActiveX control possesses
from the "Object Properties" dialog in the Graphics Designer or from the Properties listing:
Sub AddActiveXControl()
'VBA42
Dim objActiveXControl As HMIActiveXControl
Set objActiveXControl = ActiveDocument.HMIObjects.AddActiveXControl("WinCC_Gauge2",
"XGAUGE.XGaugeCtrl.1")
'
'move ActiveX-control:
objActiveXControl.Top = 40
objActiveXControl.Left = 60
'
'Change individual property:
objActiveXControl.Properties("BackColor").value = RGB(255, 0, 0)
End Sub
Restricted access to background graphics of Controls
The background graphic cannot be configured in VBA for the following Controls:
Control Attribute
WinCC Digital/Analog Clock Control Background graphic
WinCC Gauge Control Background picture
Frame picture
WinCC Pushbutton Control (up to WinCC V7.3) PictureSelected
PictureUnselected
WinCC slider control Background picture
Slider picture
See also
ActiveXControl Object (Page 1906)
AddActiveXControl Method (Page 1802)
How to edit Default objects, Smart objects, Windows objects and Tube objects (Page 1674)
Default objects, Smart objects, Windows objects and Tube objects (Page 1672)
Editing Objects with VBA (Page 1670)
.Net controls
Introduction
You can use VBA to insert .Net controls into a picture. In the Graphics Designer, you can find
the .Net controls in the "Controls" selection window.
WinCC: Scripting (VBS, ANSI-C, VBA)
1680 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Additional information is provided under "AddDotNetControl method" in this documentation
and under "Creating process pictures > Working with controls > .Net controls" in the WinCC
documentation.
Inserting a .Net control into a picture
Use the "AddDotNetControl(ObjectName, ControlType, InGAC, AssemblyInfo)" method to
insert a new .Net control into a picture. "ObjectName" represents the name of the .Net control.
"ControlType" shows the name space of the object. If "InGAC" is "TRUE", the object is
registered in the Global Assembly Cache and the associated information is available in
"AssemblyInfo".
Sub AddDotNetControl()
'VBA851
Dim DotNetControl As HMIDotNetControl
Set DotNetControl = ActiveDocument.HMIObjects.AddDotNetControl("MyVBAControl",
"System.Windows.Forms.Label", True,"Assembly=System.Windows.Forms, Version=2.0.0.0,
Culture=neutral, PublicKeyToken=b77a5c561934e089")
End Sub
The .Net control object is added to the "HMIObjects" listing as an element and inherits the
properties of the HMIObject object.
Access to the properties of the .Net control
You can find out which properties a .Net control has from the "Object Properties > Control
Properties" dialog in Graphics Designer.
WPF controls
Introduction
You can use VBA to insert WPF controls into a picture. In the Graphics Designer, you can find
the WPF controls in the "Controls" selection window.
Additional information is provided under "AddWPFControl method" in this documentation and
under "Creating process pictures > Working with controls > WPF controls" in the WinCC
documentation.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1681
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Inserting a WPF control into a picture
Use the "AddWPFControl(ObjectName, ControlType, InGAC, AssemblyInfo)" method to insert
a new WPF control into a picture. "ObjectName" represents the name of the .Net control.
"ControlType" shows the name space of the object. If "InGAC" is "TRUE", the object is
registered in the Global Assembly Cache and the associated information is available in
"AssemblyInfo".
Sub AddWPFControl()
'VBA852
Dim WPFControl As HMIWPFControl
Set WPFControl = ActiveDocument.HMIObjects.AddWPFControl("MyWPFVBAControl",
"WinCCWPFControl.TestControl", False, "Assembly=Z:\TestControl\WinCCWPFControl.dll")
End Sub
The ActiveXControl object is added to the "HMIObjects" listing as an element and inherits the
properties of the HMIObject object.
Access to the properties of the WPF control
You can find out which properties a WPF control has from the "Object Properties > Control
Properties" dialog in Graphics Designer.
3.3.4.3 Group Objects
Group Objects
Introduction
With VBA you can create a group object from selected objects in the Graphics Designer. You
can add objects to the group object, or remove objects, without having to ungroup the group
object itself. You have unrestricted access to the object properties of the individual objects in
the group object. You can also ungroup a group object again, or delete it entirely.
The following object types cannot be part of a group object:
● CustomizedObject (Customized object)
● ActiveXControl
● OLEObject
Further information regarding group objects can be found in the WinCC documentation under
"Group Object".
WinCC: Scripting (VBS, ANSI-C, VBA)
1682 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Creating a group object
To create a group object, select the objects that you want to be part of the group object in the
Graphics Designer. The selected objects are then contained in the "Selection" listing. You
create the group with the "CreateGroup()" method:
Sub CreateGroup()
'VBA43
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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
objGroup.ObjectName = "myGroup"
End Sub
The group object is inserted at the end of the "HMIObjects" listing. The objects that are
contained in the group object retain their index numbers and continue to be available in the
"HMIObjects" listing.
The objects in the group object are also included in the "GroupedHMIObjects" listing, although
the index numbers are reassigned.
Give the group object a name (objGroup.Name = "My Group") so that you can uniquely identify
it. If you do not assign a name, the group object is given the default designation for the group
object (e.g. "Group1").
The group object has the same properties as the objects of the "Object" type.
Editing a group object
You can edit a group object as follows:
● Methode "Add(Index)": Adds a new object to the group object.
● Methode "Remove(Index)": Removes a object from the group object.
● "UnGroup()" method: Ungroups the group object (ungroup).
● "Delete()" Method: Deletes the group object and the objects that it contains.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1683
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Editing objects in a group object
Use the "GroupedHMIObjects" listing in order to select an object in the group object. In order
to access its object property you must access the name of the object property via the
"Properties" property, for example:
Sub ModifyPropertyOfObjectInGroup()
'VBA44
Dim objGroup As HMIGroup
Set objGroup = ActiveDocument.HMIObjects("myGroup")
objGroup.GroupedHMIObjects(1).Properties("BorderColor") = RGB(255, 0, 0)
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
GroupedObjects Object (Listing) (Page 1988)
Ungroup Method (Page 1898)
Remove Method (Page 1876)
Delete Method (Page 1837)
Add Method (GroupedObjects Listing) (Page 1798)
How to Edit Objects in Group Objects Using VBA (Page 1687)
How to Edit the Group Objects Using VBA (Page 1684)
Editing Objects with VBA (Page 1670)
VBA in the Graphics Designer (Page 1625)
How to Edit the Group Objects Using VBA
Requirements
You must have created at least two graphic objects in the Graphics Designer and you must
have selected them.
WinCC: Scripting (VBS, ANSI-C, VBA)
1684 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor").
2. Open the document "ThisDocument" in the Project Explorer:
3. To create a group object from selected objects, you can for example insert a
"CreateGroup()" procedure in the document "ThisDocument". In this example the group
object "My Group" is created from a number of objects.
Sub CreateGroup()
'VBA45
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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
'The name identifies the group-object
objGroup.ObjectName = "My Group"
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1685
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
4. To add an object to the "My Group" group object, insert a "AddObjectToGroup()" procedure
in the document "ThisDocument", for example. In this example, an ellipse is added to the
"My Group" group object:
Sub AddObjectToGroup()
'VBA46
Dim objGroup As HMIGroup
Dim objEllipseSegment As HMIEllipseSegment
'Adds new object to active document
Set objEllipseSegment =
ActiveDocument.HMIObjects.AddHMIObject("EllipseSegment",
"HMIEllipseSegment")
Set objGroup = ActiveDocument.HMIObjects("My Group")
'Adds the object to the group
objGroup.GroupedHMIObjects.Add ("EllipseSegment")
End Sub
5. To remove an object from the "My Group" group object, insert a
"RemoveObjectFromGroup()" procedure in the document "ThisDocument", for example. In
this example the first object will be removed from the "My Group" group object:
Sub RemoveObjectFromGroup()
'VBA47
Dim objGroup As HMIGroup
Set objGroup = ActiveDocument.HMIObjects("My Group")
'delete first object of the group-object
objGroup.GroupedHMIObjects.Remove (1)
End Sub
6. To ungroup the "My Group" group object again, insert a procedure "UnGroup()" into the
document "ThisDocument". In this example, the "My Group" group object is ungrouped:
Sub UnGroup()
'VBA48
Dim objGroup As HMIGroup
Set objGroup = ActiveDocument.HMIObjects("My Group")
objGroup.UnGroup
End Sub
7. To delete the "My Group" group object, insert a procedure "DeleteGroup()" into the
document "ThisDocument". In this example, the "My Group" group object is deleted,
together with the objects it contains:
Sub DeleteGroup()
'VBA49
Dim objGroup As HMIGroup
Set objGroup = ActiveDocument.HMIObjects("My Group")
objGroup.Delete
End Sub
8. Always start the procedure with <F5>.
See also
Ungroup Method (Page 1898)
Remove Method (Page 1876)
Delete Method (Page 1837)
WinCC: Scripting (VBS, ANSI-C, VBA)
1686 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
CreateGroup Method (Page 1835)
Add Method (GroupedObjects Listing) (Page 1798)
SelectedObjects object (Listing) (Page 2063)
GroupedObjects Object (Listing) (Page 1988)
Group Object (Page 1983)
How to Edit Objects in Group Objects Using VBA (Page 1687)
Group Objects (Page 1682)
Editing Objects with VBA (Page 1670)
VBA in the Graphics Designer (Page 1625)
How to Edit Objects in Group Objects Using VBA
Introduction
Here you will find the following instructions for editing objects in a group object with VBA:
● Editing a property of an object in the group object
● Editing a property of all objects in the group object
Requirement
You must have created at least two graphic objects in the Graphics Designer and you must
have grouped them.
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor").
2. Open the document "ThisDocument" in the Project Explorer:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1687
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To edit a property of an object within the group object, you can for example insert a
"ChangePropertiesOfGroupMembers()" procedure into the document "ThisDocument". In
this example the properties of three different objects are modified in the group object "My
Group":
Sub ChangePropertiesOfGroupMembers()
'VBA50
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objEllipse As HMIEllipse
Dim objGroup As HMIGroup
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle",
"HMICircle")
Set objRectangle =
ActiveDocument.HMIObjects.AddHMIObject("sRectangle",
"HMIRectangle")
Set objEllipse =
ActiveDocument.HMIObjects.AddHMIObject("sEllipse", "HMIEllipse")
With objCircle
.Top = 40
.Left = 40
.Selected = True
End With
With objRectangle
.Top = 80
.Left = 80
.Selected = True
End With
With objEllipse
.Top = 120
.Left = 120
.Selected = True
End With
MsgBox "Objects selected!"
Set objGroup = ActiveDocument.Selection.CreateGroup
objGroup.ObjectName = "My Group"
'Set bordercolor of 1. object = "red":
objGroup.GroupedHMIObjects(1).Properties("BorderColor") =
RGB(255, 0, 0)
'set x-coordinate of 2. object = "120" :
objGroup.GroupedHMIObjects(2).Properties("Left") = 120
'set x-coordinate of 3. object = "90" :
objGroup.GroupedHMIObjects(3).Properties("Top") = 90
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1688 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
4. To change the properties of all the objects in the group object, insert a
"ChangePropertiesOfAllGroupMembers()" procedure in the document In this example, the
"BorderColor" property of each object in the "My Group" group object is changed. This
example will not work unless you have created the "My Group" group object:
Sub ChangePropertiesOfAllGroupMembers()
'VBA51
Dim objGroup As HMIGroup
Dim iMaxMembers As Integer
Dim iIndex As Integer
Set objGroup = ActiveDocument.HMIObjects("My Group")
iIndex = 1
'
'Get number of objects in group-object:
iMaxMembers = objGroup.GroupedHMIObjects.Count
'
'set linecolor of all objects = "yellow":
For iIndex = 1 To iMaxMembers
objGroup.GroupedHMIObjects(iIndex).Properties("BorderColor") =
RGB(255, 255, 0)
Next iIndex
End Sub
5. Always start the procedure with <F5>.
See also
Properties Object (Listing) (Page 2045)
GroupedObjects Object (Listing) (Page 1988)
Ungroup Method (Page 1898)
Remove Method (Page 1876)
Delete Method (Page 1837)
Add Method (GroupedObjects Listing) (Page 1798)
How to Edit the Group Objects Using VBA (Page 1684)
Group Objects (Page 1682)
Editing Objects with VBA (Page 1670)
VBA in the Graphics Designer (Page 1625)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1689
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3.3.4.4 Customized Objects
Customized Objects
Introduction
You can use VBA to create a customized object from selected objects in the Graphics Designer.
In contrast to the group object, in the case of a customized object only those object properties
are available which you have selected in the "Configuration Dialog" for the customized object.
It is not possible to configure a customized object with VBA.
Further information regarding customized objects can be found in the WinCC documentation
under "Customized Object".
Creating a customized object with VBA
Use the "CreateCustomizedObject()" method to create a customized object from selected
objects:
Sub CreateCustomizedObject()
'VBA52
Dim objCustomizedObject As HMICustomizedObject
Set objCustomizedObject = ActiveDocument.Selection.CreateCustomizedObject
objCustomizedObject.ObjectName = "My Customized Object"
End Sub
When you apply the "CreateCustomizedObject()" method, the "Configuration Dialog" appears
in which you select the object properties. The customized object that you have created is added
to the "HMIObjects" listing. Give the customized object an appropriate name
(objCustomizedObject.Name = "My Customized Object") so that you can uniquely identify it.
Note
If you open a document as invisible, do not create a user object there with a VBA script.
Program execution will otherwise be interrupted by a configuration dialog.
Editing Customized Objects
You can edit a customized object as follows:
● "Destroy" method: Ungroups the customized object.
● "Delete" Method: Deletes the customized object and the objects that it contains.
WinCC: Scripting (VBS, ANSI-C, VBA)
1690 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Editing objects in a customized object
Use the "Properties" property to access the selected object properties of the objects contained
in the customized object.
Sub EditCustomizedObjectProperty()
'VBA53
Dim objCustomizedObject As HMICustomizedObject
Set objCustomizedObject = ActiveDocument.HMIObjects(1)
objCustomizedObject.Properties("BackColor") = RGB(255, 0, 0)
End Sub
If you have selected more than one identical property (for example the background color of a
circle and of a rectangle), these properties will be numbered ("BackColor" and "BackColor1").
See also
HMIObject Object (Page 1992)
CustomizedObject Object (Page 1943)
Destroy Method (Page 1841)
Delete Method (Page 1837)
CreateCustomizedObject Method (Page 1831)
How to Edit a Customized Object with VBA (Page 1691)
How to Edit the Group Objects Using VBA (Page 1684)
Group Objects (Page 1682)
Editing Objects with VBA (Page 1670)
How to Edit a Customized Object with VBA
Introduction
Here you will find the following instructions for editing a customized object with VBA:
● Creating a customized object from selected objects
● Ungrouping Customized Objects
● Deleting a customized object
Note
It is not possible to configure a customized object with VBA.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1691
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor").
2. Open the document "ThisDocument" in the Project Explorer:
3. To create a customized object from selected objects, you can for example insert a
"CreateCustomizedObject()" procedure in the document "ThisDocument". In this example
the customized object "My Customized Object" is created from selected objects:
Sub CreateCustomizedObject()
'VBA54
Dim objCustomizedObject As HMICustomizedObject
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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 objCustomizedObject =
ActiveDocument.Selection.CreateCustomizedObject
'
'*** The "Configurationdialog" started. ***
'*** Configure the costumize-object with the "configurationdialog"
***
'
objCustomizedObject.ObjectName = "My Customized Object"
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1692 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
4. To delete an object, you can for example insert a "DeleteObject()" procedure in the
document "ThisDocument". In this example the customized object "My Customized Object"
created beforehand is deleted again:
Sub DestroyCustomizedObject()
'VBA55
Dim objCustomizedObject As HMICustomizedObject
Set objCustomizedObject = ActiveDocument.HMIObjects("My
Customized Object")
objCustomizedObject.Destroy
End Sub
5. To delete a customized object, you can for example insert a "DeleteCustomizedObject()"
procedure in the document "ThisDocument". In this example the customized object "My
Customized Object" created beforehand is deleted:
Sub DeleteCustomizedObject()
'VBA56
Dim objCustomizedObject As HMICustomizedObject
Set objCustomizedObject = ActiveDocument.HMIObjects("My
Customized Object")
objCustomizedObject.Delete
End Sub
6. Always start the procedure with <F5>.
See also
Destroy Method (Page 1841)
Delete Method (Page 1837)
CreateCustomizedObject Method (Page 1831)
Customized Objects (Page 1690)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1693
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3.3.5 Creating Dynamics with VBA
3.3.5.1 Creating Dynamics with VBA
Introduction
VBA allows you to add dynamics to properties of pictures and objects and to configure event-
controlled actions. VBA provides you with the ActionDynamic object for this purpose:
The ActionDynamic object represents an interface that is dependent on the object type:
● When you configure a dynamic for a property (Property object), the ActionDynamic object
inherits the properties of the ScriptInfo, Trigger and DynamicDialog objects.
● When you configure an event-controlled action (Event object), the ActionDynamic object
inherits the properties of the ScriptInfo and DirectConnection objects.
WinCC: Scripting (VBS, ANSI-C, VBA)
1694 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Adding dynamics to properties of pictures and objects
VBA enables you to add dynamics to properties of pictures and objects. You can use tags,
scripts or the Dynamic dialog to add dynamics. Using dynamics enables you for example to
configure a color change for an object in runtime when the value of a variable changes.
Configuring event-controlled actions
You can configure event-controlled actions with VBA. An action (script or direct connection) is
triggered then the defined event occurs in runtime. An event may be a change to an object
property, for example, or the clicking of a button.
Editing Triggers
You can edit triggers with VBA. Triggers are required when you use dynamics. They determine
when a dynamic value is updated in runtime. This may occur at regular intervals, for example,
or in the event of a picture change.
When you configure event-controlled actions, the event is the trigger.
See also
Editing Triggers (Page 1715)
Configuring Event-Driven Actions with VBA (Page 1707)
Configuring Dynamics in the Properties of Pictures and Objects (Page 1695)
3.3.5.2 Configuring Dynamics in the Properties of Pictures and Objects
Configuring Dynamics in the Properties of Pictures and Objects
Introduction
VBA enables you to add dynamics to properties of pictures and objects. Dynamic object
properties can be changed as a function of a variable value in Runtime, for example. The
following methods of adding dynamics are possible:
● Tag connection
● Dynamic dialog
● Scripts
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1695
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Principle
The following example illustrates the principle of the procedure for adding dynamics to an
object property:
Sub CreateDynamicOnProperty()
'VBA57
Dim objVariableTrigger As HMIVariableTrigger
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle1", "HMICircle")
'
'Create dynamic with type "direct Variableconnection" at the
'property "Radius":
Set objVariableTrigger =
objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeVariableDirect, "'NewDynamic1'")
'
'To complete dynamic, e.g. define cycle:
With objVariableTrigger
.CycleType = hmiVariableCycleType_2s
End With
End Sub
Note
Note that a variable is not created simply by specifying the variable name. Use the variable
selection dialog to create the variable.
Tag connection
Use the VariableTrigger object to add a dynamic to a property with a direct or indirect variable
connection. The dynamic property then responds in runtime to a change in value to the
specified variable. To allow this, in VBA you need to specify the variable name (VarName
property) and the cycle (CycleTime property).
Dynamic dialog
Use the DynamicDialog object to add a dynamic to a property with the aid of the Dynamic
dialog. The dynamic property responds in runtime to a variable's value ranges. The following
objects are available for specifying the value range:
● AnalogResultInfos-Objekt: Use this object to assign a fixed value to value ranges of a
variable or a script. The fixed value is assigned to the dynamic property when the variable
value or return value of the script is within the specified value range.
● BinaryResultInfo Object: Use this object to assign a fixed value to binary value ranges (zero
and non-zero) of a variable or a script. The fixed value is assigned to the dynamic property
when the variable value or return value of the script returns one of the two values.
● VariableStateValue Object Use this object to assign a fixed value to the state (e.g. "Upper
limit exceeded") of a specified variable. The fixed value is then allocated to the dynamic
property when the state occurs.
WinCC: Scripting (VBS, ANSI-C, VBA)
1696 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Scripts
Use the ScriptInfo object to add a dynamic to a property with a C or VB script. The property
with the dynamic reacts to a script in Runtime and is controlled via a trigger. Use the Trigger
object for configuring the trigger.
See also
VariableTrigger Object (Page 2108)
VariableStateValue Object (Page 2105)
Trigger Object (Page 2096)
ScriptInfo Object (Page 2062)
BinaryResultInfo Object (Page 1924)
AnalogResultInfos Object (Listing) (Page 1914)
How to dynamize a property with a VB script (Page 1705)
How to dynamize a property with a C script (Page 1702)
How to dynamize a property with the Dynamic dialog (Page 1699)
How to dynamize a property with a tag connection (Page 1697)
Creating Dynamics with VBA (Page 1694)
How to dynamize a property with a tag connection
Introduction
Here you will find the following instructions for dynamizing a property with tag connection:
● Dynamizing a property with direct tag connection
● Dynamizing a property with indirect tag connection
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1697
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
3. To dynamize an object property with a direct tag connection, you can for example insert an
"AddDynamicAsVariableDirectToProperty()" procedure in the document. "In this example
a circle property "Top" will be made dynamic with the aid of the tag Otto:
Sub AddDynamicAsVariableDirectToProperty()
'VBA58
Dim objVariableTrigger As HMIVariableTrigger
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle1",
"HMICircle")
'Create dynamic at property "Top"
Set objVariableTrigger =
objCircle.Top.CreateDynamic(hmiDynamicCreationTypeVariableDirect,
"Otto")
'
'define cycle-time
With objVariableTrigger
.CycleType = hmiVariableCycleType_2s
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1698 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
4. To dynamize an object property with an indirect tag connection, you can for example insert
an "AddDynamicAsVariableInDirectToProperty"() procedure in the document. "In this
example a circle property Left" will be made dynamic with the aid of the tag "Anton":
Sub AddDynamicAsVariableIndirectToProperty()
'VBA59
Dim objVariableTrigger As HMIVariableTrigger
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle2",
"HMICircle")
'Create dynamic on property "Left":
Set objVariableTrigger =
objCircle.Left.CreateDynamic(hmiDynamicCreationTypeVariableIndirec
t, "Anton")
'
'Define cycle-time
With objVariableTrigger
.CycleType = hmiVariableCycleType_2s
End With
End Sub
5. Start the procedure with <F5>.
See also
CycleType Property (Page 2216)
VarName Property (Page 2551)
VariableTrigger Object (Page 2108)
CreateDynamic Method (Page 1833)
How to dynamize a property with a VB script (Page 1705)
How to dynamize a property with a C script (Page 1702)
How to dynamize a property with the Dynamic dialog (Page 1699)
Configuring Dynamics in the Properties of Pictures and Objects (Page 1695)
Creating Dynamics with VBA (Page 1694)
How to dynamize a property with the Dynamic dialog
Introduction
You can use the Dynamic dialog to dynamize properties of pictures and objects depending on
certain value ranges or variable states. The following value ranges are available for selection:
● Analog
● Binary
● Bit
● Direct
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1699
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
With VBA you specify the type of value range with the ResultType property. These instructions
illustrate the addition of dynamics to an object property with analog value ranges. Additional
information dynamization with the dynamic dialog is provided under "DynamicDialog object"
in the VBA reference in this documentation.
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
3. To dynamize an object property with the Dynamic dialog, you can for example insert an
"AddDynamicDialogToCircleRadiusTypeAnalog()" procedure in the document. In the
following example the radius of a circle will be dynamically configured using the Dynamic
dialog, a tag name will be assigned and three analog value ranges will be created:
4. Start the procedure with <F5>.
WinCC: Scripting (VBS, ANSI-C, VBA)
1700 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA60
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_A", "HMICircle")
'
'Create dynamic
Set objDynDialog = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeDynamicDialog, "'NewDynamic1'")
'
'Configure dynamic. "ResultType" defines the type of valuerange:
With objDynDialog
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.Add 50, 40
.AnalogResultInfos.Add 100, 80
.AnalogResultInfos.ElseCase = 100
End With
End Sub
New VBA method to configure dynamization using the Dynamic Dialog
For optimization reasons, an additional new method has been provided:
● CreateDynamicDialog([Code as String], iResultType as Long) as HMIActionDynamic
The parameter "IResultType" has the following constants:
● hmiResultTypeDirect = 0
● hmiResultTypeAnalog= 1
● hmiResultTypeBool = 2
● hmiResultTypeBit = 3
In the following example the radius of a circle is given dynamics with the A tag name and a
"ResultType" are assigned to the dynamic dialog.
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA820
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
'Create Object
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("myCircle","HMICircle")
'Create dynamic (Tag "myTest" must exist")
Set objDynDialog = objCircle.Radius.CreateDynamicDialog("'myTest'",0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1701
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Initializing a string property
A string property must be initialized before being made dynamic by assigning a text to it. In
the following ToolTipText example, this is done in "objCircle.ToolTipText = "Text".
Sub Dyn()
'VBA823
Dim objCircle As HMICircle
Dim doc As Document
Dim objDynDialog As HMIDynamicDialog
Set doc = ActiveDocument
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle","HMICircle")
objCircle.ObjectName = "Circle1"
objCircle.BorderColor = RGB(255, 0, 0)
objCircle.BackColor = RGB(0, 255, 0)
objCircle.ToolTipText = "Text"
Set objDynDialog = objCircle.ToolTipText.CreateDynamic(hmiDynamicCreationTypeDynamicDialog, "'Var'")
End Sub
See also
How to dynamize a property with a tag connection (Page 1697)
ResultType Property (Page 2402)
DynamicDialog Object (Page 1960)
CreateDynamic Method (Page 1833)
How to dynamize a property with a VB script (Page 1705)
How to dynamize a property with a C script (Page 1702)
Configuring Dynamics in the Properties of Pictures and Objects (Page 1695)
Creating Dynamics with VBA (Page 1694)
ToolTipText Property (Page 2448)
How to dynamize a property with a C script
Introduction
When you dynamize a property with a C script, you can assign the C code to the "SourceCode"
property. The C script is compiled in the background. The "Compiled" property returns "True"
when the C code has been successfully compiled.
WinCC: Scripting (VBS, ANSI-C, VBA)
1702 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1703
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To add dynamics to an object property with a C script, you can for example insert an
"AddDynamicAsCScriptToProperty()" procedure in the document. In this example the
height of a circle is increased by 5 pixels every two seconds in runtime:
Sub AddDynamicAsCSkriptToProperty()
'VBA61
Dim objCScript As HMIScriptInfo
Dim objCircle As HMICircle
Dim strCode As String
strCode = "long lHeight;" & vbCrLf & "int check;" & vbCrLf
strCode = strCode & "GetHeight(""events.PDL"",""myCircle"");" &
vbCrLf
strCode = strCode & "lHeight = lHeight+5;" & vbCrLf
strCode = strCode & "check = SetHeight(""events.PDL"",
""myCircle"", lHeight );"
strCode = strCode & vbCrLf & "//Return-Type: BOOL" & vbCrLf
strCode = strCode & "return check;"
Set objCircle =
ActiveDocument.HMIObjects.AddHMIObject("myCircle", "HMICircle")
'Create dynamic for Property "Height":
Set objCScript =
objCircle.Height.CreateDynamic(hmiDynamicCreationTypeCScript)
'
'set Sourcecode and cycletime:
With objCScript
.SourceCode = strCode
.Trigger.Type = hmiTriggerTypeStandardCycle
.Trigger.CycleType = hmiCycleType_2s
.Trigger.Name = "Trigger1"
End With
End Sub
4. Start the procedure with <F5>.
See also
Trigger Property (Page 2452)
ScriptType Property (Page 2409)
SourceCode Property (Page 2426)
CycleType Property (Page 2216)
ScriptInfo Object (Page 2062)
CreateDynamic Method (Page 1833)
How to dynamize a property with a VB script (Page 1705)
How to dynamize a property with the Dynamic dialog (Page 1699)
How to dynamize a property with a tag connection (Page 1697)
Configuring Dynamics in the Properties of Pictures and Objects (Page 1695)
Creating Dynamics with VBA (Page 1694)
WinCC: Scripting (VBS, ANSI-C, VBA)
1704 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
How to dynamize a property with a VB script
Introduction
When you dynamize a property with a VB script, you can assign the VB code to the
"SourceCode" property. The VB script is compiled in the background. The "Compiled" property
returns "True" if the VB code is syntactically correct.
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1705
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To add dynamics to an object property with a VB script, you can for example insert an
"AddDynamicAsVBScriptToProperty()" procedure in the document. In this example the
radius of a circle is increased by 5 pixels every two seconds in Runtime:
Sub AddDynamicAsVBSkriptToProperty()
'VBA62
Dim objVBScript As HMIScriptInfo
Dim objCircle As HMICircle
Dim strCode As String
strCode = "Dim myCircle" & vbCrLf & "Set myCircle = "
strCode = strCode &
"HMIRuntime.ActiveScreen.ScreenItems(""myCircle"")"
strCode = strCode & vbCrLf & "myCircle.Radius = myCircle.Radius +
5"
Set objCircle =
ActiveDocument.HMIObjects.AddHMIObject("myCircle", "HMICircle")
'
'Create dynamic of property "Radius":
Set objVBScript =
objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeVBScript)
'
'Set SourceCode and cycletime:
With objVBScript
.SourceCode = strCode
.Trigger.Type = hmiTriggerTypeStandardCycle
.Trigger.CycleType = hmiCycleType_2s
.Trigger.Name = "Trigger1"
End With
End Sub
4. Start the procedure with <F5>.
See also
How to dynamize a property with a C script (Page 1702)
Trigger Property (Page 2452)
SourceCode Property (Page 2426)
CycleType Property (Page 2216)
ScriptInfo Object (Page 2062)
CreateDynamic Method (Page 1833)
How to dynamize a property with the Dynamic dialog (Page 1699)
How to dynamize a property with a tag connection (Page 1697)
Configuring Dynamics in the Properties of Pictures and Objects (Page 1695)
Creating Dynamics with VBA (Page 1694)
WinCC: Scripting (VBS, ANSI-C, VBA)
1706 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3.3.5.3 Configuring Event-Driven Actions with VBA
Configuring Event-Driven Actions with VBA
Introduction
With VBA you can configure actions for pictures and objects which are triggered when
predefined events occur. For example, when the mouse is clicked on an object in Runtime a
C script is called whose return value is used for the dynamics of an object property. The
following methods of adding dynamics are possible:
● Direct connection
● Scripts
The events that are used for configuring event-controlled actions occur only in Runtime and
have nothing to do with the VBA event handlers.
General Procedure
You use the Events property for configuring event-controlled actions with VBA. The way this
property is used depends on whether you are configuring an action on an object or picture or
a property.
Configuring an action on an object or picture
An action that you configure on a picture or object is triggered when a predefined event occurs,
for example when the object is clicked on with the mouse. You configure an action on an object
with VBA by using the "Events(Index)" property, where "Index" stands for the triggering event:
Sub AddActionToObjectTypeCScript()
'VBA63
Dim objEvent As HMIEvent
Dim objCScript As HMIScriptInfo
Dim objCircle As HMICircle
'Create circle. Click on object executes an C-action
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_AB", "HMICircle")
Set objEvent = objCircle.Events(1)
Set objCScript = objEvent.Actions.AddAction(hmiActionCreationTypeCScript)
'
'Assign a corresponding custom-function to the property "SourceCode":
objCScript.SourceCode = ""
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1707
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Configuring an action on a property
An action that you configure on a property of a picture or object is triggered when the property
value changes. You configure an action on a property with VBA by using the "Events(1)"
property, where the index "1" stands for the event "Upon change":
Sub AddActionToPropertyTypeCScript()
'VBA64
Dim objEvent As HMIEvent
Dim objCScript As HMIScriptInfo
Dim objCircle As HMICircle
'Create circle. Changing of the Property
'"Radius" should be activate C-Aktion:
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_AB", "HMICircle")
Set objEvent = objCircle.Radius.Events(1)
Set objCScript = objEvent.Actions.AddAction(hmiActionCreationTypeCScript)
'
'Assign a corresponding custom-function to the property "SourceCode":
objCScript.SourceCode = ""
End Sub
Direct connection
Use the DirectConnection object to configure a direct connection.
Scripts
Use the ScriptInfo object if you want an event to trigger a C or VB action.
See also
How to configure a VB action with VBA on an event (Page 1713)
Events Property (Page 2230)
ScriptInfo Object (Page 2062)
Event Object (Page 1971)
How to configure a C action with VBA on an event (Page 1711)
How to configure a direct connection with VBA (Page 1709)
Event Handling (Page 1717)
Creating Dynamics with VBA (Page 1694)
WinCC: Scripting (VBS, ANSI-C, VBA)
1708 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
How to configure a direct connection with VBA
Introduction
These instructions show you how to configure a direct connection on the basis of two object
properties. Further information on the configuring of direct connections with VBA is given in
the VBA reference in this documentation under "AutomationName property" and "ObjectName
property"
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1709
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To configure a direct connection to an object property, you can for example insert an
"AddDirectConnectionToObject()" procedure in the document. In the following example the
X position of "Rectangle_A" is copied to the Y position of "Rectangle_B" in Runtime by
clicking on the button:
Sub DirectConnection()
'VBA65
Dim objButton As HMIButton
Dim objRectangleA As HMIRectangle
Dim objRectangleB As HMIRectangle
Dim objEvent As HMIEvent
Dim objDConnection As HMIDirectConnection
'
'Create objects:
Set objRectangleA =
ActiveDocument.HMIObjects.AddHMIObject("Rectangle_A",
"HMIRectangle")
Set objRectangleB =
ActiveDocument.HMIObjects.AddHMIObject("Rectangle_B",
"HMIRectangle")
Set objButton =
ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objRectangleA
.Top = 100
.Left = 100
End With
With objRectangleB
.Top = 250
.Left = 400
.BackColor = RGB(255, 0, 0)
End With
With objButton
.Top = 10
.Left = 10
.Text = "SetPosition"
End With
'
'Directconnection is initiated by mouseclick:
Set objDConnection =
objButton.Events(1).Actions.AddAction(hmiActionCreationTypeDirectC
onnection)
With objDConnection
'Sourceobject: Property "Top" of Rectangle_A
.SourceLink.Type = hmiSourceTypeProperty
.SourceLink.ObjectName = "Rectangle_A"
.SourceLink.AutomationName = "Top"
'
'Destinationobject: Property "Left" of Rectangle_B
.DestinationLink.Type = hmiDestTypeProperty
.DestinationLink.ObjectName = "Rectangle_B"
.DestinationLink.AutomationName = "Left"
End With
WinCC: Scripting (VBS, ANSI-C, VBA)
1710 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
End Sub
4. Start the procedure with <F5>.
See also
ObjectName Property (Page 2353)
AutomationName Property (Page 2133)
SourceLink Object (Page 2069)
DestLink Object (Page 1950)
DirectConnection Object (Page 1952)
Configuring Event-Driven Actions with VBA (Page 1707)
How to configure a C action with VBA on an event
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1711
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To configure a C action on an event with VBA, you can for example insert a
"CreateCActionToClickedEvent()" procedure in the document. In this example a button and
a circle will be inserted in the active picture. In Runtime the height increases every time you
click the button:
Sub CreateCActionToClickedEvent()
'VBA66
Dim objButton As HMIButton
Dim objCircle As HMICircle
Dim objEvent As HMIEvent
Dim objCScript As HMIScriptInfo
Dim strCode As String
strCode = "long lHeight;" & vbCrLf & "int check;" & vbCrLf
strCode = strCode & "lHeight = GetHeight (""events.PDL"",
""myCircle"");"
strCode = strCode & vbCrLf & "lHeight = lHeight+5;" & vbCrLf &
"check = "
strCode = strCode & "SetHeight(""events.PDL"",
""myCircle"",lHeight);"
strCode = strCode & vbCrLf & "//Return-Type: Void"
Set objCircle =
ActiveDocument.HMIObjects.AddHMIObject("myCircle", "HMICircle")
Set objButton =
ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objCircle
.Top = 100
.Left = 100
.BackColor = RGB(255, 0, 0)
End With
With objButton
.Top = 10
.Left = 10
.Text = "Increase height"
End With
'Configure directconnection:
Set objCScript =
objButton.Events(1).Actions.AddAction(hmiActionCreationTypeCScript
)
With objCScript
'
'Note: Replace "events.PDL" with your picturename
.SourceCode = strCode
End With
End Sub
4. Start the procedure with <F5>.
See also
ScriptInfo Object (Page 2062)
Events Object (Listing) (Page 1972)
WinCC: Scripting (VBS, ANSI-C, VBA)
1712 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Actions Object (Listing) (Page 1904)
Configuring Event-Driven Actions with VBA (Page 1707)
How to configure a VB action with VBA on an event
Procedure
1. Open the VBA editor in Graphics Designer (<ALT+F11> or "Tools" > "Macros" > "Visual
Basic Editor")
2. In Project Explorer, open the document in which you want to write the VBA code:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1713
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3. To configure an event-oriented VB action with VBA, you can for example insert a
"CreateVBActionToClickedEvent()" procedure in the document. In this example a button
and a circle will be inserted in the active picture. In Runtime the radius of the circle enlarges
every time you click the button:
Sub CreateVBActionToClickedEvent()
'VBA67
Dim objButton As HMIButton
Dim objCircle As HMICircle
Dim objEvent As HMIEvent
Dim objVBScript As HMIScriptInfo
Dim strCode As String
strCode = "Dim myCircle" & vbCrLf & "Set myCircle = "
strCode = strCode &
"HMIRuntime.ActiveScreen.ScreenItems(""Circle_VB"")"
strCode = strCode & vbCrLf & "myCircle.Radius = myCircle.Radius +
5"
Set objCircle =
ActiveDocument.HMIObjects.AddHMIObject("Circle_VB", "HMICircle")
Set objButton =
ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objCircle
.Top = 100
.Left = 100
.BackColor = RGB(255, 0, 0)
End With
With objButton
.Top = 10
.Left = 10
.Width = 120
.Text = "Increase Radius"
End With
'Define event and assign sourcecode:
Set objVBScript =
objButton.Events(1).Actions.AddAction(hmiActionCreationTypeVBScrip
t)
With objVBScript
.SourceCode = strCode
End With
End Sub
4. Start the procedure with <F5>.
See also
Actions Object (Listing) (Page 1904)
ScriptInfo Object (Page 2062)
Events Object (Listing) (Page 1972)
Configuring Event-Driven Actions with VBA (Page 1707)
WinCC: Scripting (VBS, ANSI-C, VBA)
1714 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
3.3.5.4 Editing Triggers
Editing Triggers
Introduction
You use triggers in connection with dynamics for graphics objects and for triggering actions
on object properties. Examples of triggers include:
● Tags: When the value of a tag is changed or its limit is exceeded at either extreme
● Standard cycle: Cyclic execution of the action. The length of the cycles is selectable
between 250 ms and 1 h. In addition, you can also use customized cycles that you define
yourself.
● Picture cycle: A cyclic trigger is used as the trigger. This cycle provides the option of defining
the cycles of all the actions, tag connections and dynamic dialogs used in a picture centrally.
● Window Cycle: A cyclic trigger is used as the trigger. This values applies to all actions, tag
links and dynamic dialogs, which were configured with the trigger type "Window cycle".
When you configure an action that responds to an event on a graphics object, the triggering
event is the trigger.
Configuring triggers with VBA
Use the Trigger object to configure a trigger with VBA. If you intend to use a variable as the
trigger, use the VariableTrigger object:
You determine the type of trigger with the Type property. Use the VariableTriggers property
when you configure a variable as the trigger.
See also
Examples of Editing Triggers with VBA (Page 1716)
VariableTrigger Object (Page 2108)
Trigger Object (Page 2096)
ScriptInfo Object (Page 2062)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1715
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Examples of Editing Triggers with VBA
Introduction
The four examples below illustrate how you can create the following triggers with VBA:
● Standard cycle
● Tag
● Picture cycle
● Window Cycle
In all of these examples a circle is inserted into the active picture, with the radius of the circle
being dynamized with a VB action.
The procedure for adding dynamics to a property with variable connection is explained under
"Adding dynamics to a property with a variable connection" in this documentation.
Example 1: Standard cycle
Sub DynamicWithStandardCycle()
'VBA68
Dim objVBScript As HMIScriptInfo
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_Standard", "HMICircle")
Set objVBScript = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeVBScript)
With objVBScript
.Trigger.Type = hmiTriggerTypeStandardCycle
'"CycleType"-specification is necessary:
.Trigger.CycleType = hmiCycleType_10s
.Trigger.Name = "VBA_StandardCycle"
.SourceCode = ""
End With
End Sub
Example 2: 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
WinCC: Scripting (VBS, ANSI-C, VBA)
1716 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Example 3: Picture cycle
Sub DynamicWithPictureCycle()
'VBA70
Dim objVBScript As HMIScriptInfo
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_Picture", "HMICircle")
Set objVBScript = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeVBScript)
With objVBScript
.Trigger.Type = hmiTriggerTypePictureCycle
.Trigger.Name = "VBA_PictureCycle"
.SourceCode = ""
End With
End Sub
Example 4: Window Cycle
Sub DynamicWithWindowCycle()
'VBA71
Dim objVBScript As HMIScriptInfo
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_Window", "HMICircle")
Set objVBScript = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeVBScript)
With objVBScript
.Trigger.Type = hmiTriggerTypeWindowCycle
.Trigger.Name = "VBA_WindowCycle"
.SourceCode = ""
End With
End Sub
See also
VariableTrigger Object (Page 2108)
Trigger Object (Page 2096)
ScriptInfo Object (Page 2062)
Editing Triggers (Page 1715)
3.3.6 Event Handling
Introduction
In the Graphics Designer, events occur when certain actions are taken (for example when a
picture is opened). You can respond to an event with a predefined VBA event handler in order
to execute instructions.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1717
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
The events occur only during configuring in the Graphics Designer and are not available in
Runtime. These events must not be confused with the events (e.g. mouse click, property
change) occurring on graphic objects and pictures.
Note
When the Graphics Designer is open, events are also triggered by other editors.
. This applies, for example, to the modification of picture properties in WinCCExplorer. Close
the Graphics Designer when you are making changes to pictures in other editors. This prevents
events from being executed when you do not want them to be.
Note
If you open a picture in Graphics Designer, not only the "DocumentOpened event" of the active
picture but also that of the "Project Template" and of the "Global Template" are triggered. The
VBA code of the "DocumentOpened event" is thereby executed twice.
You must intercept this behavior with the event handler.
General Procedure
In event handling there are events with and without forwarding. You can recognize an event
with forwarding by the presence of the "CancelForwarding" parameter. An event without
forwarding does not have this parameter. When an event occurs, it is sent to the active picture
and then forwarded to the "Global Template".
An event with forwarding is therefore forwarded by default via the document "Project Template"
to the document "Global Template".
Preventing forwarding
You can prevent the forwarding of an event by setting the "CancelForwarding" parameter to
"True" in the VBA event handler:
Sub Document_HMIObjectPropertyChanged(ByVal Property As IHMIProperty, CancelForwarding As
Boolean)
'VBA72
CancelForwarding = True
MsgBox "Object's property has been changed!"
End Sub
Picture-specific and application-specific events
Quite apart from the information given above about events with and without forwarding, the
Graphics Designer differentiates between picture-specific and application-specific events:
WinCC: Scripting (VBS, ANSI-C, VBA)
1718 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Picture-specific events
Picture-specific events always respond to actions that occur in the active picture in the
Graphics Designer. Such actions include, for example, the changing of object properties or
saving the active picture. You can obtain a list of available picture-specific events by choosing
"Document" in the VBA editor:
Application-specific events
Application-specific events respond to actions that occur in the "Graphics Designer"
application. Such actions include, for example, starting the Graphics Designer or creating an
object in the component library.
To make the application-specific events available, write the following statement in the VBA
editor at the start of the document (preferably the "Project Template" or "Global Template"):
Dim WithEvents <Name> As grafexe.Application
The effect of this statement is that it will now also be possible to select the application-specific
events from the list in the Graphics Designer:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1719
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Example 1: Occurrence of an event with forwarding
The illustration shows the sequence that follows from the occurrence of an event with
forwarding:
Note
There are events which are both picture-specific and application-specific (for example
BeforeDocumentSave). When such an event occurs, the program checks whether the
corresponding application-specific event handler has been defined. The sequence shown
above does not begin until after that.
Example 2: Occurrence of an event without forwarding
The illustration shows the sequence that follows from the occurrence of an event without
forwarding:
WinCC: Scripting (VBS, ANSI-C, VBA)
1720 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Disabling event handling
You can disable event handling by setting the "DisableVBAEvents" property for the Application
object to "True".
See also
DisableVBAEvents Property (Page 2221)
Organizing VBA Code in a WinCC Project (Page 1619)
3.3.7 Accessing External Applications with VBA
3.3.7.1 Accessing External Applications with VBA
Introduction
You can use VBA to access programs which support VBA, for example products in the
Microsoft Office family. This enables you, for example, to read out values from an MS Excel
worksheet and then assign these to object properties.
Note
No direct usage of Unicode in Excel VBA and Word VBA
Excel VBA and Word VBA supports the use of Unicode characters only by means of
<ChrW(unicode-id) function.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1721
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Registering an external application
You have to integrate an external application in the VBA editor in order to make its object library
available. To do this, select the "References" option in the "Tools" menu in the VBA editor. In
the "References" dialog you can then select the required object library:
Note
You must attach the external application to all projects which you want to be able to access
the external application; do this in the VBA editor Project Explorer.
See also
Example: Accessing MS Excel with VBA (Page 1722)
3.3.7.2 Example: Accessing MS Excel with VBA
Introduction
The following three examples illustrate how to access MS Excel. For these examples to work,
the MS Excel object library must be integrated via a reference.
WinCC: Scripting (VBS, ANSI-C, VBA)
1722 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Note
No direct usage of Unicode in Excel VBA and Word VBA
Excel VBA and Word VBA supports the use of Unicode characters only by means of
<ChrW(unicode-id) function.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1723
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Example 1
In this example the default object list of the Graphics Designer is exported in an Excel
worksheet. The object properties are taken into account, as is the question of whether
dynamics can be used with these properties. The VBA data type is also displayed.
WinCC: Scripting (VBS, ANSI-C, VBA)
1724 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Sub ExportDefObjListToXLS()
'VBA73
'Microsoft Excel Object Library needs to be referenced
Dim objGDApplication As grafexe.Application
Dim objHMIObject As grafexe.HMIObject
Dim objProperty As grafexe.HMIProperty
Dim objXLS As Excel.Application
Dim objWSheet As Excel.Worksheet
Dim objWBook As Excel.Workbook
Dim rngSelection As Excel.Range
Dim lRow As Long
Dim lRowGroupStart As Long
'define local errorhandler
On Local Error GoTo LocErrTrap
'Set references to the applications Excel and GraphicsDesigner
Set objGDApplication = grafexe.Application
Set objXLS = New Excel.Application
'Create workbook
Set objWBook = objXLS.Workbooks.Add()
objWBook.SaveAs objGDApplication.ApplicationDataPath & "DefaultObjekte.xls"
'Adds new worksheet to the new workbook
Set objWSheet = objWBook.Worksheets.Add
objWSheet.Name = "DefaultObjekte"
lRow = 1
'Every object of the DefaultHMIObjects-collection will be written
'to the worksheet with their objectproperties.
'For better overview the objects will be grouped.
For Each objHMIObject In objGDApplication.DefaultHMIObjects
DoEvents
objWSheet.Cells(lRow, 1).value = objHMIObject.ObjectName
objWSheet.Cells(lRow, 2).value = objHMIObject.Type
lRow = lRow + 1
lRowGroupStart = lRow
For Each objProperty In objHMIObject.Properties
'Write displayed name and automationname of property
'into the worksheet
objWSheet.Cells(lRow, 2).value = objProperty.DisplayName
objWSheet.Cells(lRow, 3).value = objProperty.Name
'Write the value of property, datatype and if their dynamicable
'into the worksheet
If Not IsEmpty(objProperty.value) Then _
objWSheet.Cells(lRow, 4).value = objProperty.value
objWSheet.Cells(lRow, 5).value = objProperty.IsDynamicable
objWSheet.Cells(lRow, 6).value = TypeName(objProperty.value)
objWSheet.Cells(lRow, 7).value = VarType(objProperty.value)
lRow = lRow + 1
Next objProperty
'Select and groups the range of object-properties in the worksheet
Set rngSelection = objWSheet.Range(objWSheet.Rows(lRowGroupStart), _
objWSheet.Rows(lRow - 1))
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1725
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
rngSelection.Select
rngSelection.Group
Set rngSelection = Nothing
'Insert empty row
lRow = lRow + 1
Next objHMIObject
objWSheet.Columns.AutoFit
Set objWSheet = Nothing
objWBook.Save
objWBook.Close
Set objWBook = Nothing
objXLS.Quit
Set objXLS = Nothing
Set objGDApplication = Nothing
Exit Sub
LocErrTrap:
MsgBox Err.Description, , Err.Source
Resume Next
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1726 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Example 2
In this example all objects of the active picture are exported to an Excel worksheet. The
properties taken into account are Position X, Position Y, Width, Height and Layer:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1727
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Sub ExportObjectListToXLS()
'VBA74
Dim objGDApplication As grafexe.Application
Dim objDoc As grafexe.Document
Dim objHMIObject As grafexe.HMIObject
Dim objProperty As grafexe.HMIProperty
Dim objXLS As Excel.Application
Dim objWSheet As Excel.Worksheet
Dim objWBook As Excel.Workbook
Dim lRow As Long
'Define local errorhandler
On Local Error GoTo LocErrTrap
'Set references on the applications Excel and GraphicsDesigner
Set objGDApplication = grafexe.Application
Set objDoc = objGDApplication.ActiveDocument
Set objXLS = New Excel.Application
'Create workbook
Set objWBook = objXLS.Workbooks.Add()
objWBook.SaveAs objGDApplication.ApplicationDataPath & "Export.xls"
'Create worksheet in the new workbook and write headline
'The name of the worksheet is equivalent to the documents name
Set objWSheet = objWBook.Worksheets.Add
objWSheet.Name = objDoc.Name
objWSheet.Cells(1, 1) = "Objektname"
objWSheet.Cells(1, 2) = "Objekttyp"
objWSheet.Cells(1, 3) = "ProgID"
objWSheet.Cells(1, 4) = "Position X"
objWSheet.Cells(1, 5) = "Position Y"
objWSheet.Cells(1, 6) = "Width"
objWSheet.Cells(1, 7) = "Höhe"
objWSheet.Cells(1, 8) = "Ebene"
lRow = 3
'Every objects will be written with their objectproperties width,
'height, pos x, pos y and layer to Excel. If the object is an
'ActiveX-Control the ProgID will be also exported.
For Each objHMIObject In objDoc.HMIObjects
DoEvents
objWSheet.Cells(lRow, 1).value = objHMIObject.ObjectName
objWSheet.Cells(lRow, 2).value = objHMIObject.Type
If UCase(objHMIObject.Type) = "HMIACTIVEXCONTROL" Then
objWSheet.Cells(lRow, 3).value = objHMIObject.ProgID
End If
objWSheet.Cells(lRow, 4).value = objHMIObject.Left
objWSheet.Cells(lRow, 5).value = objHMIObject.Top
objWSheet.Cells(lRow, 6).value = objHMIObject.Width
objWSheet.Cells(lRow, 7).value = objHMIObject.Height
objWSheet.Cells(lRow, 8).value = objHMIObject.Layer
lRow = lRow + 1
Next objHMIObject
objWSheet.Columns.AutoFit
WinCC: Scripting (VBS, ANSI-C, VBA)
1728 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Set objWSheet = Nothing
objWBook.Save
objWBook.Close
Set objWBook = Nothing
objXLS.Quit
Set objXLS = Nothing
Set objDoc = Nothing
Set objGDApplication = Nothing
Exit Sub
LocErrTrap:
MsgBox Err.Description, , Err.Source
Resume Next
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1729
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Example 3
In this example objects are imported from the Excel worksheet created in example 2. The
properties taken into account are Position X, Position Y, Width, Height and Layer:
WinCC: Scripting (VBS, ANSI-C, VBA)
1730 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Sub ImportObjectListFromXLS()
'VBA75
Dim objGDApplication As grafexe.Application
Dim objDoc As grafexe.Document
Dim objHMIObject As grafexe.HMIObject
Dim objXLS As Excel.Application
Dim objWSheet As Excel.Worksheet
Dim objWBook As Excel.Workbook
Dim lRow As Long
Dim strWorkbookName As String
Dim strWorksheetName As String
Dim strSheets As String
'define local errorhandler
On Local Error GoTo LocErrTrap
'Set references on the applications Excel and GraphicsDesigner
Set objGDApplication = Application
Set objDoc = objGDApplication.ActiveDocument
Set objXLS = New Excel.Application
'Open workbook. The workbook have to be in datapath of GraphicsDesigner
strWorkbookName = InputBox("Name of workbook:", "Import of objects")
Set objWBook = objXLS.Workbooks.Open(objGDApplication.ApplicationDataPath &
strWorkbookName)
If objWBook Is Nothing Then
MsgBox "Open workbook fails!" & vbCrLf & "This function is cancled!", vbCritical, "Import
od objects"
Set objDoc = Nothing
Set objGDApplication = Nothing
Set objXLS = Nothing
Exit Sub
End If
'Read out the names of all worksheets contained in the workbook
For Each objWSheet In objWBook.Sheets
strSheets = strSheets & objWSheet.Name & vbCrLf
Next objWSheet
strWorksheetName = InputBox("Name of table to import:" & vbCrLf & strSheets, "Import of
objects")
Set objWSheet = objWBook.Sheets(strWorksheetName)
lRow = 3
'Import the worksheet as long as in actual row the first column is empty.
'Add with the outreaded data new objects to the active document and
'assign the values to the objectproperties
With objWSheet
While (.Cells(lRow, 1).value <> vbNullString) And (Not IsEmpty(.Cells(lRow, 1).value))
'Add the objects to the document as its objecttype,
'do nothing by groups, their have to create before.
If (UCase(.Cells(lRow, 2).value) = "HMIGROUP") Then
Else
If (UCase(.Cells(lRow, 2).value) = "HMIACTIVEXCONTROL") Then
Set objHMIObject = objDoc.HMIObjects.AddActiveXControl(.Cells(lRow,
1).value, .Cells(lRow, 3).value)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1731
VBA for Automated Configuration
3.3 VBA in the Graphics Designer
Else
Set objHMIObject = objDoc.HMIObjects.AddHMIObject(.Cells(lRow, 1).value, .Cells(lRow,
2).value)
End If
objHMIObject.Left = .Cells(lRow, 4).value
objHMIObject.Top = .Cells(lRow, 5).value
objHMIObject.Width = .Cells(lRow, 6).value
objHMIObject.Height = .Cells(lRow, 7).value
objHMIObject.Layer = .Cells(lRow, 8).value
End If
Set objHMIObject = Nothing
lRow = lRow + 1
Wend
End With
objWBook.Close
Set objWBook = Nothing
objXLS.Quit
Set objXLS = Nothing
Set objDoc = Nothing
Set objGDApplication = Nothing
Exit Sub
LocErrTrap:
MsgBox Err.Description, , Err.Source
Resume Next
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1732 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.4 VBA in the WinCC Configuration Studio
3.4 VBA in the WinCC Configuration Studio
3.4.1 VBA in the WinCC Configuration Studio
The WinCC Configuration Studio supports the VBA interface.
With VBA, you can access all editors in the WinCC Configuration Studio, for example, to create,
change, or delete data. VBA access is also supported for editors of WinCC options that are
integrated in the WinCC Configuration Studio.
You open the VBA editor in the WinCC Configuration Studio with "Tools > Visual Basic Editor".
VBA in the WinCC editors
The WinCC editors, objects and data records in the WinCC Configuration Studio can be
selected either by name or by index.
A structure for the WinCC Configuration Studio is already created in Visual Basic Editor:
Executing VBA macros
To execute the created VBA scripts, select "Tools > Macros" in the menu bar in the WinCC
Configuration Studio.
The "Macros" dialog lists the created VBA macros. Select a macro and click "Execute".
You can find more information in "Working with WinCC > Working with projects > The WinCC
Configuration Studio > How to use the data area > Using macros".
Note
Notes on VBA scripts in the WinCC Configuration Studio
Note the following when creating VBA scripts:
● To access columns and tabs, note the respective WinCC user interface language.
● Hidden columns can result in incorrect index assignments when editing via scripts.
● A sequential index over all hierarchical levels is created with an enumeration.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1733
VBA for Automated Configuration
3.4 VBA in the WinCC Configuration Studio
NOTICE
Deleting objects
If you delete individual objects in the Configuration Studio with VBA scripts, associated objects
are deleted as well.
Examples:
● Message classes and message types including within
● Tag groups and contained tags
Important Functions
DataGrid.Tabs Enumerate tabs
DataGrid.UsedRang Detect number of data records or rows used
e When UsedRange.EntireColumn or UsedRange.EntireRow is used in
an empty data grid, the "Count" property still returns the value "1".
DataGrid.Rows.Nam Detect object type in a DataGrid, e.g. "Tag"
e
The following script examples introduce other important functions.
Show hidden columns
To avoid incorrect index assignments, expand the hidden columns.
Sub ShowAllColumns()
For i = 1 To DataGrid.EntireColumns.Count
DataGrid.EntireColumns(i).Visible = True
Next i
End Sub
Example "Tag Management, User Administrator, Graphics Designer"
You can find a detailed example under "Example: VBA in the WinCC Configuration Studio
(Page 1735)".
The example contains the following functions:
● Change the WinCC interface language
To run a script for a specific language, set the user interface language at the beginning of
the script.
● Select editor in the WinCC Configuration Studio
● Navigation area: Select tree node
● Data area: Use of row names to detect the object type
To ensure that the script is accesses the correct tab, for example, check the "Name"
property of the desired row.
● Data area: Select tab
WinCC: Scripting (VBS, ANSI-C, VBA)
1734 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.4 VBA in the WinCC Configuration Studio
● Data area: Create new data record
You determine the row for the new data record and write the values in the cells of this row.
● Data area: Change value
● Data area: Delete entry
To delete a tag in the data area, for example, check if the tag exists and then delete the
entire row.
When you delete an object, all associated objects are deleted. If you delete a tag group,
for example, all tags of the group are deleted.
● Create objects in the Graphics Designer
To access the class "HMIGO" with VBA, reference the "HMI General Objects 1.0 Type
Library" in the VBA script. For each created object, you need in the VBA script to reference
the respective block library.
3.4.2 Example: VBA in the WinCC Configuration Studio
This example illustrates the object model used.
In the WinCC Configuration Studio you can execute the individual steps of the example in the
"Macros" dialog. To execute the example fully, select the entry "ConfigStudio.FullDemo".
The following actions are performed:
Example Action
AddTag Create a tag in Tag Management
ModifyTag Change the start value of a newly created tag
RemoveTag Delete a created tag again
AddGroup Create a user group in the User Administrator
RemoveGroup Delete a created user group again
AddUserAndGroup Create a user and user group in the User Administrator
AddUser Creating users in an existing user group in the User Administrator
RemoveUser Delete a created user again
DemoUsageGraphics‐ Access to the Graphics Designer
Designer A process picture is created with the "Static text" object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1735
VBA for Automated Configuration
3.4 VBA in the WinCC Configuration Studio
Example: Tag Management, User Administrator, Graphics Designer
'VBA907
' Version of this sample: V1.0
'
' With WinCC V7.4 CCConfigStudio supports a VBA interface.
' The following examples should help understanding the provided objectmodel.
'
' Warning:
' When deleting objects which are containers/parent objects for other objects (message
classes -> message types, tag groups -> tags, ...),
' all child objects will be deleted, too.
'
' Remarks:
' User Administrator -> Setting password: Not supported due to security issues.
Option Explicit
'This method will run all available sample methods
'Please use a new/empty WinCC project
Sub FullDemo()
AddTag
MsgBox "Tag created", vbOKOnly, "VBA-Demo"
ModifyTag
MsgBox "Tag modified", vbOKOnly, "VBA-Demo"
RemoveTag
MsgBox "Tag removed", vbOKOnly, "VBA-Demo"
AddGroup
MsgBox "User group created", vbOKOnly, "VBA-Demo"
AddUserAndGroup
MsgBox "User and user group created", vbOKOnly, "VBA-Demo"
AddUser
MsgBox "User created in the existing user group", vbOKOnly, "VBA-Demo"
RemoveUser
MsgBox "User removed", vbOKOnly, "VBA-Demo"
RemoveGroup
MsgBox "User group removed", vbOKOnly, "VBA-Demo"
DemoUsageGraphicsDesigner
MsgBox "Demo finished.", vbOKOnly, "VBA-Demo"
End Sub
'Add a tag in Tag Management
Sub AddTag()
Dim currLang, i, newRowNo
WinCC: Scripting (VBS, ANSI-C, VBA)
1736 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.4 VBA in the WinCC Configuration Studio
'Save currently selected language
currLang = ConfigStudio.Language
'Set language to English
ConfigStudio.Language = 1033
'Select editor "Tag Management"
' Valid parameters for specifying editor are names and IDs
ConfigStudio.Editors("Tag Management").Select
'Select treenode "Internal tags"
' Valid parameters for specifying treenodes are names and IDs
NavigationTree.Nodes("Internal tags").Select
'Make sure that the correct tab of DataGrid is selected
'One possibility is to check the object type of the rows object with its name property:
'Property "Name" reflects the object type of the currently selected DataGrid
If DataGrid.Rows.Name = "Tag" Then
'UsedRange.EntireRow returns the number of used rows in DataGrid.
newRowNo = DataGrid.UsedRange.EntireRow.Count + 1
'Add tag via entering values into cells of the first empty row in DataGrid
' Valid parameters for specifying columns are names and IDs
DataGrid.Cells(newRowNo, 1) = "NewTag"
DataGrid.Cells(newRowNo, "Data type") = "Text tag 16-bit character set"
End If
'Reset language
ConfigStudio.Language = currLang
End Sub
'Changes the start value of the previously created tag
Sub ModifyTag()
Dim currLang, i
currLang = ConfigStudio.Language
ConfigStudio.Language = 1033
ConfigStudio.Editors("Tag Management").Select
NavigationTree.Nodes("Internal tags").Select
If DataGrid.Rows.Name = "Tag" Then
'Modify tag property via usage of tag name to specify the row
DataGrid.Cells("NewTag", "Start Value") = "abc"
End If
ConfigStudio.Language = currLang
End Sub
'Removes previously created tag
Sub RemoveTag()
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1737
VBA for Automated Configuration
3.4 VBA in the WinCC Configuration Studio
Dim currLang, i
currLang = ConfigStudio.Language
ConfigStudio.Language = 1033
ConfigStudio.Editors("Tag Management").Select
NavigationTree.Nodes("Internal tags").Select
If DataGrid.Rows.Name = "Tag" Then
'Check if tag exists via enumerating rows
For i = 1 To DataGrid.UsedRange.EntireRow.Count
If DataGrid.Cells(i, "Name") = "NewTag" Then
'Select the row first before deleting it
DataGrid.Rows("NewTag").Select
'Delete the whole row
DataGrid.Rows("NewTag").EntireRow.Delete
End If
Next
End If
ConfigStudio.Language = currLang
End Sub
'Add a group in User Administrator
Sub AddGroup()
Dim currLang, i
currLang = ConfigStudio.Language
ConfigStudio.Language = 1033
ConfigStudio.Editors("User Administrator").Select
NavigationTree.Nodes("User Administrator").Select
'Add user group / Example for enumeration of tabs
For i = 1 To DataGrid.Tabs.Count
If DataGrid.Tabs(i).Name = "Groups" Then
DataGrid.Tabs(i).Select
DataGrid.Cells(DataGrid.UsedRange.EntireRow.Count + 1, 1) = "NewGroup"
End If
Next i
ConfigStudio.Language = currLang
End Sub
'Delete previously created user group
Sub RemoveGroup()
Dim currLang, i
currLang = ConfigStudio.Language
WinCC: Scripting (VBS, ANSI-C, VBA)
1738 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.4 VBA in the WinCC Configuration Studio
ConfigStudio.Language = 1033
ConfigStudio.Editors("User Administrator").Select
NavigationTree.Nodes("User Administrator").Select
For i = 1 To DataGrid.Tabs.Count
If DataGrid.Tabs(i).Name = "Groups" Then
DataGrid.Tabs(i).Select
DataGrid.Rows("NewGroup").Select
DataGrid.Rows("NewGroup").EntireRow.Delete
End If
Next i
ConfigStudio.Language = currLang
End Sub
'Add an user and a group in User Administrator
Sub AddUserAndGroup()
Dim currLang, i, newRowNo
currLang = ConfigStudio.Language
ConfigStudio.Language = 1033
ConfigStudio.Editors("User Administrator").Select
NavigationTree.Nodes("User Administrator").Select
'Add user
For i = 1 To DataGrid.Tabs.Count
If DataGrid.Tabs(i) = "Users" Then
DataGrid.Tabs(i).Select
newRowNo = DataGrid.UsedRange.EntireRow.Count + 1
DataGrid.Cells(newRowNo, "User Name") = "NewUser"
'NOT SUPPORTED: DataGrid.Cells(newRowNo, "Password") = "MySuperSavePassword"
DataGrid.Cells(newRowNo, "WebNavigator") = True
DataGrid.Cells(newRowNo, "Group name") = "NewGroup"
Exit For
End If
Next i
ConfigStudio.Language = currLang
End Sub
'Add an user in an existing group
Sub AddUser()
Dim currLang, i, newRowNo
currLang = ConfigStudio.Language
ConfigStudio.Language = 1033
ConfigStudio.Editors("User Administrator").Select
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1739
VBA for Automated Configuration
3.4 VBA in the WinCC Configuration Studio
NavigationTree.Nodes("NewGroup").Select
'Add user
For i = 1 To DataGrid.Tabs.Count
If DataGrid.Tabs(i) = "Users" Then
DataGrid.Tabs(i).Select
If DataGrid.Cells(1, 1) = "" Then
newRowNo = 1
Else
newRowNo = DataGrid.UsedRange.EntireRow.Count + 1
End If
DataGrid.Cells(newRowNo, "User Name") = "NewUser"
DataGrid.Cells(newRowNo, "Group name") = "NewGroup"
Exit For
End If
Next i
ConfigStudio.Language = currLang
End Sub
'Delete previously created user
Sub RemoveUser()
Dim currLang, i
currLang = ConfigStudio.Language
ConfigStudio.Language = 1033
ConfigStudio.Editors("User Administrator").Select
NavigationTree.Nodes("User Administrator").Select
'Remove user
For i = 1 To DataGrid.Tabs.Count
If DataGrid.Tabs(i) = "Users" Then
DataGrid.Tabs(i).Select
DataGrid.Rows("NewUser").Select
DataGrid.Rows("NewUser").EntireRow.Delete
Exit For
End If
Next i
ConfigStudio.Language = currLang
End Sub
'Sample for using VBA in Graphics Designer via CCConfigStudio
Sub DemoUsageGraphicsDesigner()
'Method 1:
'Use this code to create programmatically a reference to Graphics Designer Type Library
Dim appGD, screen
Set appGD = CreateObject("grafexe.Application")
'or
WinCC: Scripting (VBS, ANSI-C, VBA)
1740 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.4 VBA in the WinCC Configuration Studio
'Method 2:
'Add reference to "WinCC Graphics Designer Type Library V1.0" via menu -> Extras ->
References
'This will also enable IntelliSense functionality
'Dim appGD As New grafexe.Application
'Dim screen As grafexe.Document
appGD.Visible = True
Set screen = appGD.Documents.Add(1) 'hmiOpenDocumentTypeVisible
'To be able to add screenitems it is necessary to reference the corresponding type library
for each object
'Dim statTxtObj As HMIStaticText 'add reference "HMI StaticText Object 1.0 Library"
Dim statTxtObj
Set statTxtObj = screen.HMIObjects.AddHMIObject("Static Text", "HMIStaticText")
With statTxtObj
.Top = 50
.Left = 50
.Width = 260
.Height = 60
.AlignmentTop = 1
.AlignmentLeft = 1
.Text = "Screen created and saved." + vbNewLine + "Please close Graphics Designer
manually."
End With
screen.SaveAs appGD.ApplicationDataPath + "SampleScreen.pdl"
Set statTxtObj = Nothing
Set screen = Nothing
Set appGD = Nothing
End Sub
See also
VBA in the WinCC Configuration Studio (Page 1733)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1741
VBA for Automated Configuration
3.5 AddIns
3.5 AddIns
3.5.1 AddIns
Introduction
An AddIn is a code which cannot be viewed and is stored as a DLL. Addins can make new
functions available by registering the DLL concerned in the operating system and loading
To you as a user, the advantage of addins is that they provide functions which are tailor made
for the associated application. For example if you working on different computers during
configuration and frequently use VBA macros, you can combine these VBA macros in one or
more addins. When you change to a different computer you need only copy the addin and you
can then access the customary functions on the new workstation.
As a developer, you can use the Graphics Designer program library in a development
environment to create MS Visual Studio 6.0 addins, for example, and protect your code from
intrusion.
Addins in the Graphics Designer
In the Graphics Designer you can use all the addins that have been developed for the Graphics
Designer and registered in the operating system of the computer you are using for
configuration.
You can automatically load an addin when you start the Graphics Designer if you frequently
need the functions the addins contain.
When you no longer need the functions of an addin, you can unload it again at any time.
See also
How to Configure an AddIn in the Graphics Designer (Page 1744)
Example: Creating Add Ins (Page 1746)
Linking Add Ins (Page 1742)
3.5.2 Linking Add Ins
Introduction
In the Graphics Designer use the Addin Manager to define the way addins that can be used
in the Graphics Designer will behave on loading.
WinCC: Scripting (VBS, ANSI-C, VBA)
1742 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.5 AddIns
Requirements
● An add-in must be registered in the operating system, e.g. by entering the "regsvr32
filename.dll" command at the input prompt.
● To register VBA addins, "Microsoft Visual Basic for Applications" must be installed. The
installation is available in the following ways:
– Microsoft Office: During installation of Microsoft Office products, for example MS Excel
or MS Word, Visual Basic for Applications is automatically installed at the same time.
– Later installation from Microsoft Office Setup: You can select to only install Visual Basic
for Applications in Microsoft Office Setup with the user-defined installation.
– Download of the VBA Runtime environment: Microsoft offers a download of the VBA
Runtime environment at the following links:
"VBRun60sp6.exe" file for V6.0 SP6: http://support.microsoft.com/kb/290887/ (http://
support.microsoft.com/kb/290887/)
● Make sure that the current file "MSAddndr.DLL" is integrated together with the VB6 add-in
DLL. For more detailed information, refer to:
– http://support.microsoft.com/kb/2792179/ (http://support.microsoft.com/kb/2792179/)
– http://support.microsoft.com/kb/957924/ (http://support.microsoft.com/kb/957924/)
Starting AddIn Manager
To start the Addin Manager, go to the Graphics Designer and select the command "Macros >
AddIn Manager":
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1743
VBA for Automated Configuration
3.5 AddIns
Automatically Loading an Addin
If the addin contains new functions that you always need in the Graphics Designer, you can
load the addin automatically when you open the Graphics Designer.
To do this go to the Addin Manager, select the addin and enable the "Load on Startup"
checkbox.
Note
Depending on how the addin is programmed, the function contained in the addin can also be
entered in the menu "Tools > Macros > AddIns".
You can then start the function just by clicking on it.
Manually Loading or Unloading an Addin
You can also load an addin manually if you need its functions for particular purposes only (such
as test routines).
To load or unload an addin manually, go to the Addin Manager, select the addin and enable
the "Loaded/Unloaded" checkbox.
See also
How to Configure an AddIn in the Graphics Designer (Page 1744)
Example: Creating Add Ins (Page 1746)
AddIns (Page 1742)
3.5.3 How to Configure an AddIn in the Graphics Designer
Requirements
An add-in must be registered in the operating system, e.g. by entering the "regsvr32
filename.dll" command at the input prompt.
WinCC: Scripting (VBS, ANSI-C, VBA)
1744 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.5 AddIns
Procedure
1. Start the Graphics Designer and open the project to which you want to link the addin.
2. To call the Addin Manager, select the menu command "Tools" > "AddIn Manager".
The Addin Manager opens. The "Available Add-Ins" list shows all the addins that are
available, together with their current load status:
3. For each addin define whether it is to be loaded and if so when. To do this select the addin
concerned and enable the appropriate checkbox under "Load Behavior".
4. To unload an addin, select the addin concerned and disable the "Load/Unload" checkbox
under "Load Behavior".
5. Click OK.
Result
Depending how the addin is programmed, the function contained in the addin is either listed
in the "Tools" > "AddIns" menu or reacts to an event handler in the Graphics Designer.
If the addin is started by means of an event handler (e.g. Started Event), the "On Startup"
checkbox should be enabled for the addin.
See also
Linking Add Ins (Page 1742)
AddIns (Page 1742)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1745
VBA for Automated Configuration
3.5 AddIns
3.5.4 Example: Creating Add Ins
3.5.4.1 Example: Creating Add Ins
Introduction
In order to create Addins, this documentation contains an example for Visual Basic 6.0, which
creates a runable Addin for use in the Graphic Designer.
Requirements
MS Visual Studio 6.0 must be installed on the configuration computer.
You should have programming experience if you wish to use the sample code as a basis for
developing addins of your own.
Example: Program Template for Visual Basic 6.0
Use the event handler "AddInInstance_OnConnection" to generate an instance of the Graphics
Designer. In order for the addin to be able to access the Graphics Designer, it is mandatory
to declare the application.
See also
Example: Creating an Add In with Visual Basic 6.0 (Page 1746)
Linking Add Ins (Page 1742)
3.5.4.2 Example: Creating an Add In with Visual Basic 6.0
Introduction
The program code in this example produces a file called "MyAddIn.DLL". So that the add-in
will work in Graphics Designer, you must enable the "Load on Startup" checkbox for this add-
in in the AddIn Manager of Graphics Designer. For this purpose you can also use the
"LoadOnStartup" function in the add-in.
When you open Graphics Designer the add-in generates a user-defined menu. You can also
use the "Tools" > "AddIns" menu to call the function contained in the add-in.
WinCC: Scripting (VBS, ANSI-C, VBA)
1746 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.5 AddIns
Requirement
In order to create an executable add-in from the sample code, "MS Visual Studio 6.0" must be
installed on your computer. You must also have referenced "WinCC Graphics Designer 1.0
Type Library" in "MS Visual Studio 6.0":
Procedure
1. Open "MS Visual Studio 6.0" and create a new project. To create a project, go to the "New
Project" dialog, select the "AddIn" entry and click on OK.
2. In Project Explorer, open the "Designer" folder and double click the entry called "Connect".
The "Connect (AddIn Designer)" dialog opens.
3. Under "Application", select the entry for "Graphics Designer" and select the "Initial Behavior
on Loading" for the add-in. Close the "Connect (AddIn Designer)" dialog.
4. In Project Explorer, open the "Designer" folder and use the shortcut menu to select the
command "Display Code" for the "Connect" entry.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1747
VBA for Automated Configuration
3.5 AddIns
5. Replace the entire program code with the following program code:
Option Explicit
'-----------------------------------------------------
'Member Variables
'-----------------------------------------------------
'Reference to the add-in connection
Dim WithEvents ThisAddin As grafexe.AddInHook
'Reference to the Graphics Designer Application
Dim WithEvents GrafApp As grafexe.Application
'-----------------------------------------------------
'WithEvents AddInInstance IDTExtensibility2 (automatic)
'-----------------------------------------------------
'------------------------------------------------------
'This method connects the add-in to the Graphic Designer
Application
'------------------------------------------------------
Private Sub AddInInstance_OnConnection(ByVal Application As
Object, _
ByVal ConnectMode As
AddInDesignerObjects.ext_ConnectMode, _
ByVal AddInInst As Object,
custom() As Variant)
On Error GoTo AddInInstance_OnConnection_Error
'--------------------------------------------------------
' Hook up to the Graphics Designer application.IAddInHookEvents
interface.
' It is necessary referencing the application this add-in hooks
up to
'--------------------------------------------------------
Dim GDApplication As grafexe.Application
Set GDApplication = Application
If (Not GDApplication Is Nothing) Then
'----------------------------------------------------
' Explanation on filters ( first parameter to
AddIns.Attach() )
'
' sbAddInFilterExecute : Add-in is not shown in the AddIn
menu
' (ThisAddin_Execute() is NOT called)
' sbAddInFilterNone : Add-in is shown in the AddIn menu
and by
' clicking on the AddIn's menu entry
ThisAddin_Execute()
' is called (see the figure below)
'------------------------------------------------------
Set ThisAddin =
GDApplication.AddIns.Attach(sbAddInFilterNone, "Create Rectangle")
Set GrafApp = GDApplication
RegisterApplicationMenus
End If
WinCC: Scripting (VBS, ANSI-C, VBA)
1748 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.5 AddIns
Exit Sub
AddInInstance_OnConnection_Error:
MsgBox Err.Description
End Sub
'------------------------------------------------------------
'This method removes the add-in from VB by event disconnect
'------------------------------------------------------------
Private Sub AddInInstance_OnDisconnection(ByVal RemoveMode As
AddInDesignerObjects.ext_DisconnectMode, _
custom() As Variant)
On Error GoTo AddInInstance_OnDisconnection_Error
If (RemoveMode = ext_dm_UserClosed) Then
RemoveApplicationMenus
End If
' -----------------------------------------------------------
' Release reference to IAddInHookEvents interface - Important
' -----------------------------------------------------------
Set ThisAddin = Nothing
Set GrafApp = Nothing
Exit Sub
AddInInstance_OnDisconnection_Error:
MsgBox Err.Description
End Sub
'----------------------------------------------------------------
'This method describes the 2nd way to make add-in functions
available in Graphics Designer
'
'By adding an application menu in Graphics Designer the menu click
events can be catched by
'the MenuItemClicked event from the application object
'----------------------------------------------------------------
Private Sub RegisterApplicationMenus()
Dim objDocMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Set objDocMenu = GrafApp.CustomMenus.InsertMenu(1, "DocMenu1",
"Doc_Menu_1")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(1,
"dmItem1_1", "My first menu entry")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(2,
"dmItem1_2", "My second menu entry")
Set objMenuItem = Nothing
Set objDocMenu = Nothing
End Sub
'---------------------------------------------------------------
'This method removes the AddIn menus available in Graphics Designer
'---------------------------------------------------------------
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1749
VBA for Automated Configuration
3.5 AddIns
Private Sub RemoveApplicationMenus()
Dim objDocMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
For Each objMenuItem In
GrafApp.CustomMenus("DocMenu1").MenuItems
Set objMenuItem = Nothing
Next objMenuItem
GrafApp.CustomMenus("DocMenu1").Delete
Set objMenuItem = Nothing
Set objDocMenu = Nothing
End Sub
Private Sub AddInInstance_Terminate()
' --------------------------------------------------
' Release reference to IAddInHookEvents interface - Important
' --------------------------------------------------
Set ThisAddin = Nothing
Set GrafApp = Nothing
End Sub
Private Sub GrafApp_MenuItemClicked(ByVal MenuItem As
grafexe.IHMIMenuItem)
Select Case MenuItem.Key
Case "dmItem1_1"
TestCall1
Case "dmItem1_2"
TestCall2
Case Else
Debug.Assert False
End Select
End Sub
'----------------------------------------------------------
'You can call both of the following procedures by clicking the menu
command in the "DocMenu1"
'----------------------------------------------------------
Sub TestCall1()
Call MsgBox("AddIn Menu: dmItem1_1 Clicked", vbInformation,
"GrafApp_MenuItemClicked")
End Sub
Sub TestCall2()
Call MsgBox("AddIn Menu: dmItem1_2 Clicked", vbInformation,
"GrafApp_MenuItemClicked")
End Sub
'--------------------------------------------------------
'Registering an AddInHook creates an object which event
'can be executed by clicking "Extras\Macros\AddIns\<Registered
Name>"
'--------------------------------------------------------
Private Sub ThisAddin_Execute()
MsgBox ("AddIn : Execute! Will create a new Rectangle now")
WinCC: Scripting (VBS, ANSI-C, VBA)
1750 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.5 AddIns
Dim NewShape As HMIObject
Set NewShape =
GrafApp.ActiveDocument.HMIObjects.AddHMIObject("Rectangle1",
"HMIRectangle")
With NewShape
.Top = 40
.Left = 40
.BackColor = 255
End With
MsgBox (NewShape.ObjectName)
End Sub
6. Create the add-in, and load it in the Graphics Designer.
Result
The next time you open it, Graphics Designer contains a user-defined menu titled
"Doc_Menu_1". The menu "Tools > AddIns" contains an entry called "Create Rectangle", which
pastes a rectangle into the active picture:
See also
How to Configure an AddIn in the Graphics Designer (Page 1744)
Example: Creating Add Ins (Page 1746)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1751
VBA for Automated Configuration
3.6 VBA Reference
3.6 VBA Reference
3.6.1 The object model of the Graphics Designer
3.6.1.1 VBA Reference
VBA Object Model
When you click an object name, you are shown a detailed description.
Note
The prefix "HMI" will be omitted from the following descriptions. Note that in the code you must
prefix objects with "HMI", e.g. "HMISymbolLibrary".
WinCC: Scripting (VBS, ANSI-C, VBA)
1752 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
Events Object (Listing) (Page 1972)
SymbolLibraries Object (Listing) (Page 2082)
Actions Object (Listing) (Page 1904)
Application Object (Page 1915)
DataLanguage Object (Page 1946)
DataLanguages Object (Listing) (Page 1947)
Document Object (Page 1954)
Documents Object (Listing) (Page 1957)
Event Object (Page 1971)
HMIDefaultObjects Object (Listing) (Page 1989)
HMIObject Object (Page 1992)
HMIObjects Object (Listing) (Page 1994)
FolderItem Object (Page 1977)
FolderItems Object (Listing) (Page 1978)
VBA Reference: ActionDynamic (Page 1754)
VBA Reference: HMIObjects (Page 1756)
VBA Reference: Languages (Page 1758)
Layer Object (Page 2005)
Layers Object (Listing) (Page 2006)
Menu Object (Page 2013)
Menus Object (Listing) (Page 2015)
MenuItem Object (Page 2017)
MenuItems Object (Listing) (Page 2019)
Properties Object (Listing) (Page 2045)
Toolbar Object (Page 2089)
Toolbars Object (Listing) (Page 2090)
ToolbarItem Object (Page 2092)
ToolbarItems Object (Listing) (Page 2094)
View Object (Page 2111)
Views Object (Listing) (Page 2112)
SelectedObjects object (Listing) (Page 2063)
SymbolLibrary Object (Page 2084)
Property Object (Page 2046)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1753
VBA for Automated Configuration
3.6 VBA Reference
3.6.1.2 VBA Reference: ActionDynamic
VBA Object Model: ActionDynamic
"ActionDynamic" represents the interface port for dynamics and actions such as scripts, the
dynamic dialog, the direct connection and the triggers.
When you click an object name, you are shown a detailed description.
See also
VBA Reference (Page 1752)
AnalogResultInfo Object (Page 1913)
AnalogResultInfos Object (Listing) (Page 1914)
BinaryResultInfo Object (Page 1924)
WinCC: Scripting (VBS, ANSI-C, VBA)
1754 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
BitResultInfo Object (Page 1925)
Actions Object (Listing) (Page 1904)
DestLink Object (Page 1950)
DirectConnection Object (Page 1952)
DynamicDialog Object (Page 1960)
QualityCodeStateValue Object (Page 2048)
QualityCodeStateValues Object (Listing) (Page 2050)
ScriptInfo Object (Page 2062)
SourceLink Object (Page 2069)
Trigger Object (Page 2096)
VariableStateValue Object (Page 2105)
VariableStateValues Object (Listing) (Page 2106)
VariableTrigger Object (Page 2108)
VariableTriggers Object (Listing) (Page 2110)
ActionType property (Page 2116)
DynamicStateType property (Page 2225)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1755
VBA for Automated Configuration
3.6 VBA Reference
3.6.1.3 VBA Reference: HMIObjects
VBA Object Model: HMIObjects
When you click an object name, you are shown a detailed description.
+0,'HIDXOW2EMHFWV 6HOHFWLRQ +0,2EMHFWV
+0,2EMHFW
6WDQGDUGREMHFWV :LQGRZVREMHFWV 6SHFLDOREMHFWV 6PDUWREMHFWV
&LUFOH %XWWRQ &XVWRPL]HG2EMHFW '%DU*UDSK
&LUFOH$UF &KHFN%R[ *URXS $FWLYH;&RQWURO
(OOLSVH 2SWLRQ*URXS $SSOLFDWLRQ:LQGRZ
(OOLSVH$UF 5RXQG%XWWRQ *URXS2EMHFWV %DU*UDSK
(OOLSVH6HJPHQW 6OLGHU &RPER%R[
/LQH )DFHSODWH2EMHFW
3LH6HJPHQW 7XEHREMHFWV *UDSKLF2EMHFW
3RO\JRQ 7XEH$UF2EMHFW *URXS'LVSOD\
3RO\/LQH 7XEH'RXEOH7HH2EMHFW ,2)LHOG
5HFWDQJOH 7XEH7HH2EMHFW /LVW%R[
5RXQG5HFWDQJOH 7XEH3RO\OLQH 0XOWL/LQH(GLW
6WDWLF7H[W 2/(2EMHFW
3LFWXUH:LQGRZ
6WDWXV'LVSOD\
7H[W/LVW
Object and List
Object
Detail view available.
Multilingual object configuration is possible.
* Not in DefaultObjects list.
WinCC: Scripting (VBS, ANSI-C, VBA)
1756 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
VBA Reference (Page 1752)
PolyLine Object (Page 2042)
GroupDisplay Object (Page 1985)
3DBarGraph Object (Page 1900)
ActiveXControl Object (Page 1906)
ApplicationWindow Object (Page 1917)
Button Object (Page 1926)
CheckBox Object (Page 1930)
Circle Object (Page 1933)
CircularArc Object (Page 1936)
Line Object (Page 2008)
OLEObject Object (Page 2027)
OptionGroup Object (Page 2029)
PictureWindow Object (Page 2033)
PieSegment Object (Page 2036)
Polygon Object (Page 2039)
Property Object (Page 2046)
Rectangle Object (Page 2053)
RoundButton Object (Page 2055)
RoundRectangle Object (Page 2059)
Slider object (Page 2066)
StaticText Object (Page 2071)
StatusDisplay Object (Page 2074)
TextList Object (Page 2085)
Ellipse Object (Page 1962)
EllipseArc Object (Page 1965)
EllipseSegment Object (Page 1968)
GraphicObject Object (Page 1980)
Group Object (Page 1983)
HMIDefaultObjects Object (Listing) (Page 1989)
HMIObject Object (Page 1992)
HMIObjects Object (Listing) (Page 1994)
IOField Object (Page 1996)
BarGraph Object (Page 1920)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1757
VBA for Automated Configuration
3.6 VBA Reference
GroupedObjects Object (Listing) (Page 1988)
VBA Reference: Languages (Page 1758)
SelectedObjects object (Listing) (Page 2063)
CustomizedObject Object (Page 1943)
FaceplateObject object (Page 1974)
AdvancedAnalogDisplay object (Page 1907)
AdvancedStateDisplay object (Page 1911)
3.6.1.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 1752)
LanguageFont Object (Page 2000)
LanguageFonts Object (Listing) (Page 2001)
LanguageText Object (Page 2003)
LanguageTexts Object (Listing) (Page 2004)
WinCC: Scripting (VBS, ANSI-C, VBA)
1758 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
3.6.1.5 Events
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)
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 1752)
Event Handling (Page 1717)
BeforeClose Events
Description
Occurs immediately before a picture is closed.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1759
VBA for Automated Configuration
3.6 VBA Reference
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".
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 1752)
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)
WinCC: Scripting (VBS, ANSI-C, VBA)
1760 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
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()
'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 1752)
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)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1761
VBA for Automated Configuration
3.6 VBA Reference
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()
'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 1752)
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)
WinCC: Scripting (VBS, ANSI-C, VBA)
1762 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
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".
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 1752)
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>.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1763
VBA for Automated Configuration
3.6 VBA Reference
objGDApplication_BeforeLibraryFolderDelete(LibObject As
HMIFolderItem, Cancel As Boolean)
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 1752)
BeforeLibraryObjectDelete event
Description
Occurs immediately before an object in the components library is deleted.
WinCC: Scripting (VBS, ANSI-C, VBA)
1764 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
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_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 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1765
VBA for Automated Configuration
3.6 VBA Reference
BeforeQuit Event
Description
Occurs immediately before the Graphics Designer 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_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 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
1766 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
BeforeSave Event
Description
Occurs immediately before a picture is saved.
syntax
Document_BeforeSave(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:
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 1752)
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)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1767
VBA for Automated Configuration
3.6 VBA Reference
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:
--
See also
VBA Reference (Page 1752)
ConnectionEvent Event
Description
Occurs when two objects are connected via the connector.
syntax
ConnectionEvent(eConnEventType, HMIConnector, HMIConnectedObject,
CancelProcess, CancelForwarding)
Parameter (Optional)
Parameter (Data Type) Description
eConnEventType (HMIConnectionEventType) --
HMIConnector (HMIObject) --
HMIConnectedObject (HMIObject) --
CancelProcess (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:
--
See also
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
1768 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
DataLanguageChanged Event
Description
Occurs when the project language has been changed.
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_DataLanguageChanged(lCID As Long)
Parameters
Parameter (Data Type) Description
lCID (Long) The project language identifier
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 newly set project language is output:
Private Sub objGDApplication_DataLanguageChanged(ByVal lCID As Long)
'VBA87
MsgBox "The datalanguage is changed to " & Application.CurrentDataLanguage & "."
End Sub
See also
Language-Dependent Configuration with VBA (Page 1628)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1769
VBA for Automated Configuration
3.6 VBA Reference
DesktopLanguageChanged event
Description
Occurs when the user interface language has been changed.
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_DesktopLanguageChanged(lCID As Long)
Parameters
Parameter (Data Type) Description
lCID (Long) The user interface language identifier
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 newly set desktop language is output:
Private Sub objGDApplication_DesktopLanguageChanged(ByVal lCID As Long)
'VBA88
MsgBox "The desktop-language is changed to " & Application.CurrentDesktopLanguage & "."
End Sub
See also
VBA Reference (Page 1752)
Language-Dependent Configuration with VBA (Page 1628)
WinCC: Scripting (VBS, ANSI-C, VBA)
1770 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
DocumentActivated Event
Description
Occurs when a picture is activated in the Graphics Designer. This happens when you switch
between two pictures, for example.
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_DocumentActivated(Document As HMIDocument)
Parameters
Parameter (Data Type) Description
Document (HMIDocument) The picture that is to be activated.
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 identifying the picture that has been activated:
Private Sub objGDApplication_DocumentActivated(ByVal Document As IHMIDocument)
'VBA89
MsgBox "The document " & Document.Name & " got the focus." & vbCrLf &_
"This event is raised by the application."
End Sub
See also
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1771
VBA for Automated Configuration
3.6 VBA Reference
DocumentCreated Event
Description
Occurs when a new picture has been created in the Graphics Designer.
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_DocumentCreated(Document As HMIDocument)
Parameters
Parameter (Data Type) Description
Document (HMIDocument) The picture that has been created.
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 name of the newly created picture is output:
Private Sub objGDApplication_DocumentCreated(ByVal Document As IHMIDocument)
'VBA90
MsgBox Document.Name & " will be created."
End Sub
See also
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
1772 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
DocumentOpened Event
Description
Occurs when a picture has been opened.
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_DocumentOpened(Document As HMIDocument)
Parameters
Parameter (Data Type) Description
Document (HMIDocument) The picture that has been opened.
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 identifying the picture that has been opened:
Private Sub objGDApplication_DocumentOpened(ByVal Document As IHMIDocument)
'VBA91
MsgBox Document.Name & " is opened."
End Sub
See also
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1773
VBA for Automated Configuration
3.6 VBA Reference
DocumentSaved Event
Description
Occurs when a picture has been saved in the Graphics Designer.
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_DocumentSaved(Document As HMIDocument)
Parameters
Parameter (Data Type) Description
Document (HMIDocument) The picture that has been saved.
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 identifying the picture that has been saved:
Private Sub objGDApplication_DocumentSaved(ByVal Document As IHMIDocument)
'VBA92
MsgBox Document.Name & " is saved."
End Sub
See also
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
1774 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
DocumentPropertyChanged event
Description
Occurs when a picture property is changed.
syntax
Document_DocumentPropertyChanged(ByVal Property As IHMIProperty,
CancelForwarding As Boolean)
Parameters
Parameter (Data Type) Description
Property (IHMIProperty) Identifies the changed property.
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 identifying the picture property being changed:
Private Sub Document_DocumentPropertyChanged(ByVal Property As IHMIProperty,
CancelForwarding As Boolean)
'VBA93
Dim strPropName As String
'"strPropName" contains the name of the modified property
strPropName = Property.Name
MsgBox "The picture-property " & strPropName & " is modified..."
End Sub
See also
VBA Reference (Page 1752)
F-Z
HMIObjectAdded Event
Description
Occurs when an object is added.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1775
VBA for Automated Configuration
3.6 VBA Reference
syntax
Document_HMIObjectAdded(ByVal HMIObject As IHMIObject,
CancelForwarding As Boolean)
Parameters
Parameter (Data Type) Description
HMIObject (IHMIObject) Identifies the object being added.
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 identifying the object that has been added:
Private Sub Document_HMIObjectAdded(ByVal HMIObject As IHMIObject, CancelForwarding As
Boolean)
'VBA94
Dim strObjName As String
'
'"strObjName" contains the name of the added object
strObjName = HMIObject.ObjectName
MsgBox "Object " & strObjName & " is added..."
End Sub
See also
VBA Reference (Page 1752)
HMIObjectMoved Event
Description
Occurs when an object is moved.
syntax
Document_HMIObjectMoved(ByVal HMIObject As IHMIObject,
CancelForwarding As Boolean)
WinCC: Scripting (VBS, ANSI-C, VBA)
1776 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameters
Parameter (Data Type) Description
HMIObject (IHMIObject) Identifies the object being moved.
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 identifying the object that has been moved:
Private Sub Document_HMIObjectMoved(ByVal HMIObject As IHMIObject, CancelForwarding As
Boolean)
'VBA95
Dim strObjName As String
'
'"strObjName" contains the name of the moved object
strObjName = HMIObject.ObjectName
MsgBox "Object " & strObjName & " was moved..."
End Sub
See also
VBA Reference (Page 1752)
HMIObjectPropertyChanged Event
Description
Occurs when an object property is changed.
syntax
Document_HMIObjectPropertyChanged(ByVal Property As IHMIProperty,
CancelForwarding As Boolean)
Parameters
Parameter (Data Type) Description
Property (IHMIProperty) Identifies the changed property.
CancelForwarding (Boolean) TRUE if the event is not intended to be forwarded.
Default setting is "False".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1777
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example a message is output identifying the object property that has been
changed:
Private Sub Document_HMIObjectPropertyChanged(ByVal Property As IHMIProperty,
CancelForwarding As Boolean)
'VBA96
Dim strObjProp As String
Dim strObjName As String
Dim varPropValue As Variant
'
'"strObjProp" contains the name of the modified property
'"varPropValue" contains the new value
strObjProp = Property.Name
varPropValue = Property.value
'
'"strObjName" contains the name of the selected object,
'which property is modified
strObjName = Property.Application.ActiveDocument.Selection(1).ObjectName
MsgBox "The property " & strObjProp & " of object " & strObjName & " is modified... " &
vbCrLf & "The new value is: " & varPropValue
End Sub
See also
VBA Reference (Page 1752)
HMIObjectResized Event
Description
Occurs when the size of an object is changed.
syntax
Document_HMIObjectResized(ByVal HMIObject As IHMIObject,
CancelForwarding As Boolean)
Parameters
Parameter (Data Type) Description
HMIObject (IHMIObject) Identifies the object that is being resized.
CancelForwarding (Boolean) TRUE if the event is not intended to be forwarded.
Default setting is "False".
WinCC: Scripting (VBS, ANSI-C, VBA)
1778 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example a message is output when an object has been resized:
Private Sub Document_HMIObjectResized(ByVal HMIObject As IHMIObject, CancelForwarding As
Boolean)
'VBA97
Dim strObjName As String
'
'"strObjName" contains the name of the modified object
strObjName = HMIObject.ObjectName
MsgBox "The size of " & strObjName & " was modified..."
End Sub
See also
VBA Reference (Page 1752)
LibraryFolderRenamed Event
Description
Occurs when a folder in the components library has been renamed.
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_LibraryFolderRenamed(LibObject As HMIFolderItem,
OldName As String)
Parameters
Parameter (Data Type) Description
LibObject (HMIFolderItem) The renamed folder.
OldName (String) The original name of the renamed folder.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1779
VBA for Automated Configuration
3.6 VBA Reference
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 old and new folder names are output:
Private Sub objGDApplication_LibraryFolderRenamed(ByVal LibObject As HMIFolderItem, ByVal
OldName As String)
'VBA98
MsgBox "The Library-folder " & OldName & " is renamed in: " & LibObject.DisplayName
End Sub
See also
VBA Reference (Page 1752)
Accessing the component library with VBA (Page 1650)
LibraryObjectRenamed Event
Description
Occurs when an object in the components library has been renamed.
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_LibraryObjectRenamed(LibObject As HMIFolderItem,
OldName As String)
WinCC: Scripting (VBS, ANSI-C, VBA)
1780 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameters
Parameter (Data Type) Description
LibObject (HMIFolderItem) The renamed object.
OldName (String) The original name of the renamed object.
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 old and new object names are output:
Private Sub objGDApplication_LibraryObjectRenamed(ByVal LibObject As IHMIFolderItem, ByVal
OldName As String)
'VBA99
MsgBox "The object " & OldName & " is renamed in: " & LibObject.DisplayName
End Sub
See also
VBA Reference (Page 1752)
Accessing the component library with VBA (Page 1650)
LibraryObjectAdded Event
Description
Occurs when an object has been added to the components library.
syntax
HMIObjectPropertyChanged(ByVal Property As IHMIProperty,
CancelForwarding As Boolean)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1781
VBA for Automated Configuration
3.6 VBA Reference
Parameters
Parameter (Data Type) Description
LibObject (IHMIFolderItem) Identifies the library object.
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 an object has been added to the
components library:
Private Sub Document_LibraryObjectAdded(ByVal LibObject As IHMIFolderItem,
CancelForwarding As Boolean)
'VBA100
Dim strObjName As String
'
'"strObjName" contains the name of the added object
strObjName = LibObject.DisplayName
MsgBox "Object " & strObjName & " was added to the picture."
End Sub
See also
VBA Reference (Page 1752)
MenuItemClicked Event
Description
Occurs when an entry in a user-defined menu is 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_MenuItemClicked(ByVal MenuItem As IHMIMenuItem)
WinCC: Scripting (VBS, ANSI-C, VBA)
1782 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameters
Parameter (Data Type) Description
MenuItem (IHMIMenuItem) Identifies the user-defined menu.
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 entry in a user-defined menu is
clicked:
Private Sub Document_MenuItemClicked(ByVal MenuItem As IHMIMenuItem)
'VBA101
Dim objMenuItem As HMIMenuItem
Dim varMenuItemKey As Variant
Set objMenuItem = MenuItem
'
'"objMenuItem" contains the clicked menu-item
'"varMenuItemKey" contains the value of parameter "Key"
'from the clicked userdefined menu-item
varMenuItemKey = objMenuItem.Key
Select Case MenuItem.Key
Case "mItem1_1"
MsgBox "The first menu-item was clicked!"
End Select
End Sub
See also
How to assign VBA macros to menus and toolbars (Page 1645)
VBA Reference (Page 1752)
NewLibraryFolder Event
Description
Occurs when a folder has been created in the components library.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1783
VBA for Automated Configuration
3.6 VBA Reference
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_NewLibraryFolder(LibObject As HMIFolderItem)
Parameters
Parameter (Data Type) Description
LibObject (HMIFolderItem) The newly created folder.
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 new folder name is output:
Private Sub objGDApplication_NewLibraryFolder(ByVal LibObject As IHMIFolderItem)
'VBA102
MsgBox "The library-folder " & LibObject.DisplayName & " was added."
End Sub
See also
VBA Reference (Page 1752)
Accessing the component library with VBA (Page 1650)
NewLibraryObject Event
Description
Occurs when an object has been created in the components library.
WinCC: Scripting (VBS, ANSI-C, VBA)
1784 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
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_NewLibraryObject(LibObject As HMIFolderItem)
Parameters
Parameter (Data Type) Description
LibObject (HMIFolderItem) The newly created object.
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 new object name is output:
Private Sub objGDApplication_NewLibraryObject(ByVal LibObject As IHMIFolderItem)
'VBA103
MsgBox "The object " & LibObject.DisplayName & " was added."
End Sub
See also
VBA Reference (Page 1752)
Accessing the component library with VBA (Page 1650)
Opened Event
Description
Occurs when a picture is opened.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1785
VBA for Automated Configuration
3.6 VBA Reference
syntax
Document_Opened(CancelForwarding As Boolean)
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 opened:
Private Sub Document_Opened(CancelForwarding As Boolean)
'VBA104
MsgBox "The Document is open now..."
End Sub
See also
VBA Reference (Page 1752)
Saved Event
Description
Occurs after a picture has been saved.
syntax
Document_Saved(CancelForwarding As Boolean)
Parameters
Parameter (Data Type) Description
CancelForwarding (Boolean) TRUE if the event is not intended to be forwarded.
Default setting is "False".
WinCC: Scripting (VBS, ANSI-C, VBA)
1786 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example a message is output when the picture has been saved:
Private Sub Document_Saved(CancelForwarding As Boolean)
'VBA105
MsgBox "The document is saved..."
End Sub
See also
VBA Reference (Page 1752)
SelectionChanged Event
Description
Occurs when the selection has been changed.
syntax
Document_SelectionChanged(CancelForwarding As Boolean)
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 a new object has been selected:
Private Sub Document_SelectionChanged(CancelForwarding As Boolean)
'VBA106
MsgBox "The selection is changed..."
End Sub
See also
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1787
VBA for Automated Configuration
3.6 VBA Reference
Started Event
Description
Occurs when the Graphics Designer has been started.
Syntax
objGDApplication_Started()
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>.
Parameters
--
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
WinCC: Scripting (VBS, ANSI-C, VBA)
1788 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
VBA Reference (Page 1752)
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)
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
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1789
VBA for Automated Configuration
3.6 VBA Reference
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 1645)
VBA Reference (Page 1752)
ViewCreated Event
Description
Occurs when a copy of a picture has been created.
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)
WinCC: Scripting (VBS, ANSI-C, VBA)
1790 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
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 1752)
WindowStateChange Event
Description
Occurs when the window size is changed (e.g. from "Minimized" to "Maximized").
syntax
objGDApplication_WindowStateChanged()
Parameter (Optional)
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1791
VBA for Automated Configuration
3.6 VBA Reference
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 1752)
3.6.1.6 Methods
A-C
Activate Method
Description
Activates the specified object.
syntax
Expression.Activate()
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
WinCC: Scripting (VBS, ANSI-C, VBA)
1792 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
View Object (Page 2111)
Application Object (Page 1915)
VBA Reference (Page 1752)
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.
See also
Add Method (Views Listing) (Page 1800)
Add Method (TagTriggers Listing) (Page 1799)
Add Method (CustomToolbars Listing) (Page 1795)
Add Method (GroupedObjects Listing) (Page 1798)
Add Method (Documents Listing) (Page 1797)
Add Method (AnalogResultInfos Listing) (Page 1793)
Add Method (AnalogResultInfos Listing)
Description
Adds a new, analog value range in the Dynamic dialog.
syntax
Expression.Add(RangeTo, ResultValue)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1793
VBA for Automated Configuration
3.6 VBA Reference
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
.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:
WinCC: Scripting (VBS, ANSI-C, VBA)
1794 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
DynamicDialog Object (Page 1960)
AnalogResultInfos Object (Listing) (Page 1914)
CreateDynamic Method (Page 1833)
How to dynamize a property with the Dynamic dialog (Page 1699)
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.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1795
VBA for Automated Configuration
3.6 VBA Reference
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
Set objToolbarItem = objToolbar.ToolbarItems.InsertSeparator(2, "tSeparator1_2")
End Sub
See also
Toolbars Object (Listing) (Page 2090)
InsertToolbarItem Method (Page 1862)
InsertSeparator Method (Page 1859)
InsertFromMenuItem Method (Page 1854)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
WinCC: Scripting (VBS, ANSI-C, VBA)
1796 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
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.
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 2277)
Documents Object (Listing) (Page 1957)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1797
VBA for Automated Configuration
3.6 VBA Reference
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.
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.
WinCC: Scripting (VBS, ANSI-C, VBA)
1798 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
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 1988)
Add Method (TagTriggers Listing)
Description
Creates a new tag trigger.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1799
VBA for Automated Configuration
3.6 VBA Reference
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 2110)
VBA Reference (Page 1752)
Add Method (Views Listing)
Description
Creates a copy of the specified picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
1800 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
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 2112)
VBA Reference (Page 1752)
AddAction Method
Description
Configures an action on an object or property. This action is triggered when a defined event
occurs.
syntax
Expression.Method(HMIActionCreationType)
Expression
Necessary. An expression or element which returns an object of the "Actions" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1801
VBA for Automated Configuration
3.6 VBA Reference
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 1971)
Actions Object (Listing) (Page 1904)
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")
Expression
Required. An expression or element which returns an object of the "HMIObjects" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
1802 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
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
WinCC media control CCMediaControl.CCMediaControl.1
WinCC OnlineTableControl CCAxOnlineTableControl.AxOnlineTableControl.1
WinCC OnlineTrendControl CCAxOnlineTrendControl.AxOnlineTrendControl.1
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1803
VBA for Automated Configuration
3.6 VBA Reference
Name of the WinCC control ProgID
WinCC Push Button Control (up to PBUTTON.PbuttonCtrl.1
WinCC V7.3)
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
Note
After executing the method, the Graphics Designer will not be fully shut down. The
"Grafexe.exe" file remains in the memory. In order to restart the Graphics Designer, exit the
"Grafexe.exe" application in the Task Manager.
See also
ActiveX controls (Page 1679)
HMIObjects Object (Listing) (Page 1994)
ActiveXControl Object (Page 1906)
VBA Reference (Page 1752)
AddDotNetControl method
Description
Adds a new ".Net-Control" object to the "HMIObjects" listing.
WinCC: Scripting (VBS, ANSI-C, VBA)
1804 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Syntax
Expression.AddDotNetControl(ObjectName, ControlType, InGAC,
AssemblyInfo)
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.
ControlType (String) The namespace of the object.
InGAC (String) TRUE: The object is registered in the Global Assembly Cache.
FALSE: The object is not registered in the Global Assembly Cache.
AssemblyInfo (String) If "InGAC=TRUE", then the following information will be specified:
Assembly
Version
Culture
PublicKeyToken
If "InGAC=FALSE", only the path of the object is specified in "Assembly".
Example
In the following example, the ".NETControl" object from the Global Assembly Cache is inserted
in the active picture.
'VBA851
Dim DotNetControl As HMIDotNetControl
Set DotNetControl = ActiveDocument.HMIObjects.AddDotNetControl("MyVBAControl",
"System.Windows.Forms.Label", True,"Assembly=System.Windows.Forms, Version=2.0.0.0,
Culture=neutral, PublicKeyToken=b77a5c561934e089")
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.
syntax
Expression.AddFolder(DefaultName)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1805
VBA for Automated Configuration
3.6 VBA Reference
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 2084)
FolderItems Object (Listing) (Page 1978)
VBA Reference (Page 1752)
Accessing the component library with VBA (Page 1650)
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.
syntax
Expression.AddFromClipboard(DefaultName)
Expression
Necessary. An expression or element which returns an object of the "FolderItems" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
1806 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
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 1978)
SymbolLibrary Object (Page 2084)
VBA Reference (Page 1752)
Accessing the component library with VBA (Page 1650)
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.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1807
VBA for Automated Configuration
3.6 VBA Reference
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 ob‐
ject 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
See also
PieSegment Object (Page 2036)
TextList Object (Page 2085)
StatusDisplay Object (Page 2074)
StaticText Object (Page 2071)
Slider object (Page 2066)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
PolyLine Object (Page 2042)
PictureWindow Object (Page 2033)
OptionGroup Object (Page 2029)
HMIObjects Object (Listing) (Page 1994)
Line Object (Page 2008)
WinCC: Scripting (VBS, ANSI-C, VBA)
1808 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
IOField Object (Page 1996)
GraphicObject Object (Page 1980)
EllipseArc Object (Page 1965)
EllipseSegment Object (Page 1968)
Ellipse Object (Page 1962)
CircularArc Object (Page 1936)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BarGraph Object (Page 1920)
ApplicationWindow Object (Page 1917)
AddOLEObject Method (Page 1810)
AddActiveXControl Method (Page 1802)
VBA Reference (Page 1752)
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.
syntax
Expression.Folder.AddItem "DefaultName", pHMIObject
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.
pHMIObject (HMIObject) The object that is to be inserted into the Compo‐
nents Library from the specified picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1809
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example a circle will be copied into the "Project Library". For this purpose the
circle will be pasted into the active picture and the folder "My Folder 2" will
Sub VBA123()
'VBA123
Dim objProjectLib As HMISymbolLibrary
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle", "HMICircle")
Set objProjectLib = Application.SymbolLibraries(2)
objProjectLib.FolderItems.AddFolder ("My Folder2")
objProjectLib.FindByDisplayName("My Folder2").Folder.AddItem "ProjectLib Circle",
ActiveDocument.HMIObjects("Circle")
End Sub
See also
FolderItems Object (Listing) (Page 1978)
SymbolLibrary Object (Page 2084)
VBA Reference (Page 1752)
Accessing the component library with VBA (Page 1650)
AddOLEObject Method
Description
Adds a new OLE Element to the "HMIObjects" listing. The object is inserted in the upper left
corner of the specified picture.
syntax
Expression.AddOLEObject(ObjectName, ServerName, [CreationType],
[UseSymbol])
Expression
Necessary. An expression or element which returns an object of the "HMIObjects" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
1810 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameters
Parameter (Data Type) Description
ObjectName (String) The name of the object. You can address the object by its name in a listing.
ServerName (String) The name of the application which is to contain the OLE Element, or the file
name complete with path. The value for "ServerName" corresponds to the
"Object Type" in the "Insert Object" dialog:
6HUYHU1DPH
CreationType (HMIO‐ Defines whether the OLE Element will be newly created or an existing file
LEObjectCreationType-) will be used:
● HMIOLEObjectCreationTypeDirect: Corresponds to setting "Create
New". This setting is used if you do not specify the parameter.
● HMIOLEObjectCreationTypeByLink: Corresponds to setting "Create
from File". This creates a copy of the file. Any changes made to the OLE
Element have no effect on the original file. Assign a name to the file via
the "ServerName" parameter.
● HMIOLEObjectCreationTypeByLinkWithReference: Same as above,
except that changes in OLE Element affect the original file. Assign a
name to the file via the "ServerName" parameter.
UseSymbol (Boolean) TRUE if the standard icon for the file type is to be used. Double clicking on
the icon then opens the associated application. The default setting for this
parameter is FALSE.
Example:
In the following example, an OLE Element containing a Wordpad document will be inserted
into the active picture:
Sub AddOLEObjectToActiveDocument()
'VBA124
Dim objOLEObject As HMIOLEObject
Set objOLEObject = ActiveDocument.HMIObjects.AddOLEObject("MS Wordpad Document",
"Wordpad.Document.1")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1811
VBA for Automated Configuration
3.6 VBA Reference
In the following example, the AddOLEObject method will be used and the
"HMIOLEObjectCreationTypeByLink" parameter will be specified:
Sub AddOLEObjectByLink()
'VBA805
Dim objOLEObject As HMIOLEObject
Dim strFilename As String
'
'Add OLEObject by filename. In this case, the filename has to
'contain filename and path.
'Replace the definition of strFilename with a filename with path
'existing on your system
strFilename = Application.ApplicationDataPath & "Test.bmp"
Set objOLEObject = ActiveDocument.HMIObjects.AddOLEObject("OLEObject1", strFilename,
hmiOLEObjectCreationTypeByLink, False)
End Sub
In the following example, the AddOLEObject method will be used and the
"HMIOLEObjectCreationTypeByLinkWithReference" parameter will be specified:
Sub AddOLEObjectByLinkWithReference()
'VBA806
Dim objOLEObject As HMIOLEObject
Dim strFilename As String
'
'Add OLEObject by filename. In this case, the filename has to
'contain filename and path.
'Replace the definition of strFilename with a filename with path
'existing on your system
strFilename = Application.ApplicationDataPath & "Test.bmp"
Set objOLEObject = ActiveDocument.HMIObjects.AddOLEObject("OLEObject1", strFilename,
hmiOLEObjectCreationTypeByLinkWithReference, True)
End Sub
See also
OLEObject Object (Page 2027)
HMIObjects Object (Listing) (Page 1994)
VBA Reference (Page 1752)
AddWPFControl method
Description
Adds a new "WPF-Control" object to the "HMIObjects" listing.
WinCC: Scripting (VBS, ANSI-C, VBA)
1812 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Syntax
Expression.AddWPFControl(ObjectName, ControlType, InGAC,
AssemblyInfo)
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.
ControlType (String) The namespace of the object.
InGAC (String) TRUE: The object is registered in the Global Assembly Cache.
FALSE: The object is not registered in the Global Assembly Cache.
AssemblyInfo (String) If "InGAC=TRUE", then the following information will be specified:
Assembly
Version
Culture
PublicKeyToken
If "InGAC=FALSE", only the path of the object is specified in "Assembly".
Example
In the following example, the "WPF Control" object outside the Global Assembly Cache is
inserted in the active picture.
'VBA852
Dim WPFControl As HMIWPFControl
Set WPFControl = ActiveDocument.HMIObjects.AddWPFControl("MyWPFVBAControl",
"WinCCWPFControl.TestControl", False, "Assembly=Z:\TestControl\WinCCWPFControl.dll")
AlignBottom Method
Description
Aligns the objects selected in the specified picture with In so doing the alignment is oriented
on the first object that you select.
syntax
Expression.AlignBottom()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1813
VBA for Automated Configuration
3.6 VBA Reference
Parameters
--
Example:
In the following example two objects are inserted at different positions in the current picture
and then aligned with the bottom:
Sub AlignSelectedObjectsBottom()
'VBA125
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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!"
ActiveDocument.Selection.AlignBottom
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
AlignLeft Method
Description
Left-justifies the objects selected in the specified picture. In so doing the alignment is oriented
on the first object that you select.
syntax
Expression.AlignLeft()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
1814 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameters
--
Example:
In the following example two objects are inserted at different positions in the current picture
and then aligned to the left:
Sub AlignSelectedObjectsLeft()
'VBA126
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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!"
ActiveDocument.Selection.AlignLeft
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
AlignRight Method
Description
Right-justifies the objects selected in the specified picture. In so doing the alignment is oriented
on the first object that you select.
syntax
Expression.AlignRight()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1815
VBA for Automated Configuration
3.6 VBA Reference
Parameters
--
Example:
In the following example two objects are inserted at different positions in the current picture
and then aligned to the right:
Sub AlignSelectedObjectsRight()
'VBA127
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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!"
ActiveDocument.Selection.AlignRight
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
AlignTop Method
Description
Aligns the objects selected in the specified picture with In so doing the alignment is oriented
on the first object that you select.
syntax
Expression.AlignTop()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
1816 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameters
--
Example:
In the following example two objects are inserted at different positions in the current picture
and then aligned with the top:
Sub AlignSelectedObjectsTop()
'VBA128
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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!"
ActiveDocument.Selection.AlignTop
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
ArrangeMinimizedWindows Method
Description
Arranges all minimized pictures on the lower margin of the Graphics Designer.
syntax
Expression.ArrangeMinimizedWindows()
Expression
Necessary. An expression or element which returns an object of the "Application" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1817
VBA for Automated Configuration
3.6 VBA Reference
Parameters
--
Example:
In the following example all minimized pictures are arranged on the lower margin of the
Graphics Designer. For this example to work, you must have minimized a number of pictures
in the Graphics Designer:
Sub ArrangeMinimizedWindows()
'VBA129
Application.ArrangeMinimizedWindows
End Sub
See also
Application Object (Page 1915)
VBA Reference (Page 1752)
BackwardOneLevel Method
Description
Moves the selected objects one level backward within their current layer.
syntax
Expression.BackwardOneLevel()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
1818 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example two objects are inserted in the active picture. The object inserted last
is then moved backward one level:
Sub MoveObjectOneLevelBackward()
'VBA173
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("sRectangle", "HMIRectangle")
With objCircle
.Top = 40
.Left = 40
.Selected = False
End With
With objRectangle
.Top = 40
.Left = 40
.Width = 100
.Height = 50
.BackColor = RGB(255, 0, 255)
.Selected = True
End With
MsgBox "Objects created and selected!"
ActiveDocument.Selection.BackwardOneLevel
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
BringToFront Method
Description
Brings the selected objects right to the front within their current layer.
Note
If the "BringToFront" method is used, the sequence of HMI objects can change in the
HMIObjects listing.
Syntax
Expression.BringToFront()
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1819
VBA for Automated Configuration
3.6 VBA Reference
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
Example:
In the following example two objects are inserted in the active picture. The object inserted last
is then brought to the front:
Sub MoveObjectToFront()
'VBA198
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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 = 40
.Left = 40
.Width = 100
.Height = 50
.BackColor = RGB(255, 0, 255)
.Selected = False
End With
MsgBox "The objects circle and rectangle are created" & vbCrLf & "Only the circle is
selected!"
ActiveDocument.Selection.BringToFront
MsgBox "The selection is moved to the front."
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
CascadeWindows Method
Description
Arranges all open pictures in the Graphics Designer in a cascade (i.e. overlapping).
WinCC: Scripting (VBS, ANSI-C, VBA)
1820 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
syntax
Expression.Methode(Parameter)
Expression
Necessary. An expression or element which returns an object of the "Application" type.
Parameters
--
Example:
In the following example all open pictures in the Graphics Designer are arranged in a cascade.
For this example to work, you must have opened a number of pictures in the Graphics Designer:
Sub CascadeWindows()
'VBA130
Application.CascadeWindows
End Sub
See also
VBA Reference (Page 1752)
Application Object (Page 1915)
CenterHorizontally Method
Description
Using this method, the objects selected in the specified picture are centered horizontally.
syntax
Expression.CenterHorizontally()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1821
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example two objects are inserted at different positions in the current picture
and then centered horizontally:
Sub CenterSelectedObjectsHorizontally()
'VBA131
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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!"
ActiveDocument.Selection.CenterHorizontally
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
CenterVertically Method
Description
Using this method, the objects selected in the specified picture are centered vertically.
syntax
Expression.CenterVertically()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
1822 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example two objects are inserted at different positions in the current picture
and then centered vertically:
Sub CenterSelectedObjectsVertically()
'VBA132
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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!"
ActiveDocument.Selection.CenterVertically
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
CheckSyntax Method
Description
Checks whether the syntax of the specified C script is correct.
Use the CheckSyntax method in conjunction with the Compiled Property.
syntax
Expression.CheckSyntax(CheckOK, Error)
Expression
Necessary. An expression or element which returns an object of the "DynamicDialog" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1823
VBA for Automated Configuration
3.6 VBA Reference
Parameters
Parameter (Data Type) Description
CheckOK (Boolean) TRUE if the syntax of the specified C script is cor‐
rect.
Error (String) The message text that is output if the C script is
incorrect.
Example:
--
See also
DynamicDialog Object (Page 1960)
VBA Reference (Page 1752)
Close Method
Description
Closes the specified picture and removes it from the document listing.
Note
Changes that have not been saved will be lost.
Syntax 1
Expression.Close(FileName)
Expression
Necessary. An expression or element which returns an object of the "Documents" type.
Syntax 2
Expression.Close()
Expression
Necessary. An expression or element which returns an object of the "Document" type.
Parameters
Parameter (Data Type) Description
FileName (String) The name of the PDL file to be closed.
WinCC: Scripting (VBS, ANSI-C, VBA)
1824 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the picture "Test.PDL" will For this example to work, you must have
opened the picture "Test.PDL":
Sub CloseDocumentUsingTheFileName()
'VBA134
Dim strFile As String
strFile = Application.ApplicationDataPath & "test.pdl"
Application.Documents.Close (strFile)
End Sub
In the following example the active picture in the Graphics Designer will be closed:
Sub CloseDocumentUsingActiveDocument()
'VBA135
ActiveDocument.Close
End Sub
See also
Document Object (Page 1954)
ActiveDocument Property (Page 2116)
Documents Object (Listing) (Page 1957)
VBA Reference (Page 1752)
CloseAll Method
Description
Closes all the pictures opened in the Graphics Designer and removes them from the
documents listing.
Note
Changes that have not been saved will be lost.
syntax
Expression.CloseAll()
Expression
Necessary. An expression or element which returns an object of the "Documents" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1825
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example all open pictures in the Graphics Designer are closed:
Sub CloseAllDocuments()
'VBA136
Application.Documents.CloseAll
End Sub
See also
Documents Object (Listing) (Page 1957)
VBA Reference (Page 1752)
ConvertToScript Method
Description
Converts the specified Dynamic dialog into a C script.
On conversion the associated DynamicDialog object is deleted.
Note
You cannot undo the conversion.
syntax
Expression.ConvertToScript()
Expression
Necessary. An expression or element which returns an object of the "DynamicDialog" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
1826 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example a circle will be inserted into the active picture and its radius will be
dynamically configured using the Dynamic dialog. The Dynamic dialog will then be converted
into a C script.
Sub ConvertDynamicDialogToScript()
'VBA137
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_A", "HMICircle")
'
'Create dynamic
Set objDynDialog = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'NewDynamic1'")
'
'configure dynamic. "ResultType" defines the valuerange-type:
With objDynDialog
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.Add 50, 40
.AnalogResultInfos.Add 100, 80
.AnalogResultInfos.ElseCase = 100
MsgBox "The dynamic-dialog will be changed into a C-script."
.ConvertToScript
End With
End Sub
See also
DynamicDialog Object (Page 1960)
VBA Reference (Page 1752)
ConvertToVBScript method
Description
Converts the specified Dynamic dialog into a VB script.
On conversion, the associated DynamicDialog object is deleted.
Note
You cannot undo the conversion.
Syntax
Expression.ConvertToVBScript()
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1827
VBA for Automated Configuration
3.6 VBA Reference
Expression
Required. An expression which returns an object of the "DynamicDialog" type.
Parameters
--
Example
In the following example, a circle is inserted into the active picture and its radius is dynamically
configured using the Dynamic dialog. The Dynamic dialog is then converted into a VB script.
Sub ConvertDynamicDialogToVBScript()
'VBA908
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_A", "HMICircle")
'
'Create dynamic
Set objDynDialog = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'NewDynamic1'")
'
'configure dynamic. "ResultType" defines the valuerange-type:
With objDynDialog
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.Add 50, 40
.AnalogResultInfos.Add 100, 80
.AnalogResultInfos.ElseCase = 100
MsgBox "The dynamic-dialog will be changed into a VB-script."
.ConvertToVBScript
End With
End Sub
See also
DynamicDialog Object (Page 1960)
ConvertWM method
Description
Is used internally for PowerCC.
CopySelection Method
Description
Using this method, the objects selected in the picture are copied to the clipboard.
WinCC: Scripting (VBS, ANSI-C, VBA)
1828 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
syntax
Expression.CopySelection()
Expression
Necessary. An expression or element which returns an object of the "Document" or "Selection"
type.
Parameters
--
Example:
In the following example two of the objects inserted in the active picture are selected. The
selection is copied and pasted to a new picture:
Sub CopySelectionToNewDocument()
'VBA138
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim iNewDoc As Integer
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!"
'Instead of "ActiveDocument.CopySelection" you can also write:
'"ActiveDocument.Selection.CopySelection".
ActiveDocument.CopySelection
Application.Documents.Add hmiOpenDocumentTypeVisible
iNewDoc = Application.Documents.Count
Application.Documents(iNewDoc).PasteClipboard
End Sub
See also
Document Object (Page 1954)
ActiveDocument Property (Page 2116)
SelectedObjects object (Listing) (Page 2063)
PasteClipboard Method (Page 1874)
Add Method (Documents Listing) (Page 1797)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1829
VBA for Automated Configuration
3.6 VBA Reference
Activate Method (Page 1792)
VBA Reference (Page 1752)
CopyToClipboard Method
Description
Copies an object from a folder in the Components Library to the clipboard.
Syntax
Expression.CopyToClipboard()
Expression
Necessary. An expression or element which returns a FolderItem object of the "Item" type.
Parameters
--
Example:
In the following example the object "PC" from the "Global Library" will be copied into the folder
"My Folder3" in the "Project Library":
Sub CopyObjectFromGlobalLibraryToProjectLibrary()
'VBA139
Dim objGlobalLib As HMISymbolLibrary
Dim objProjectLib As HMISymbolLibrary
Dim objFolderItem As HMIFolderItem
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"
Set objFolderItem = objProjectLib.FindByDisplayName("My Folder3")
objFolderItem.Folder.AddFromClipBoard ("Copy of PC/PLC")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1830 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
SymbolLibrary Object (Page 2084)
FolderItem Object (Page 1977)
VBA Reference (Page 1752)
Accessing the component library with VBA (Page 1650)
CreateCustomizedObject Method
Description
Creates a customized object from the objects selected in the specified picture. You then have
to configure the customized object in the "Configuration Dialog".
For further information on this topic please refer to "Customized Objects" in this documentation
and "Customized Object" in the WinCC documentation.
syntax
Expression.CreateCustomizedObject()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1831
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example two objects are inserted at different positions in the current picture
and a customized object is then created:
Sub CreateCustomizedObject()
'VBA140
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objCustObject As HMICustomizedObject
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 objCustObject = ActiveDocument.Selection.CreateCustomizedObject
objCustObject.ObjectName = "myCustomizedObject"
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
CustomizedObject Object (Page 1943)
VBA Reference (Page 1752)
Customized Objects (Page 1690)
CreateDynamicDialog method
Description
Dynamizing properties of pictures and objects depending on specific value ranges or variable
statuses.
Syntax
Expression.CreateDynamicDialog([Code as String],iResultType as Long)
Expression
Required. An expression or element which returns an object of the "Property" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
1832 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameter
Parameter (Data Type) Description
Code (String) Defines the function or tag that is used for dynamic
purposes. Also specify the tag name in single quo‐
tation marks: "Tag name"
iResultType (Long) Defines the type of value range:
● hmiResultTypeDirect = 0
● hmiResultTypeAnalog= 1
● hmiResultTypeBool = 2
● hmiResultTypeBit = 3
Example
In the following example the radius of a circle is given dynamics with the dynamic dialog. A
tag name and a "ResultType" are assigned to the dynamic dialog.
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA820
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
'Create Object
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("myCircle","HMICircle")
'Create dynamic (Tag "myTest" must exist")
Set objDynDialog = objCircle.Radius.CreateDynamicDialog("'myTest'",0)
End Sub
See also
FaceplateProperty object (Page 1976)
CreateDynamic Method
Description
Makes the specified property dynamic.
syntax
Expression.CreateDynamic(DynamicType, [SourceCode])
Expression
Necessary. An expression or element which returns an object of the "Property" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1833
VBA for Automated Configuration
3.6 VBA Reference
Parameters
You only need use the "SourceCode" parameter if you want to make the specified property
dynamic with the aid of the Dynamic dialog.
In all other types of dynamics you can omit the parameter.
Parameter (Data Type) Description
DynamicType (HMIDynamicCreationType) Defines the type of dynamics:
● hmiDynamicCreationTypeVariableDirect:
Dynamics with a tag
● hmiDynamicCreationTypeVariableIndirect:
Dynamics with a tag In this type of dynamics
you specify only the name of the tag whose
value will be used for dynamic purposes.
● hmiDynamicCreationTypeScript: Dynamics
with a script (C, VB).
● hmiDynamicCreationTypeDynamicDialog:
Dynamizing with the dynamic dialog box:
SourceCode (String) Defines the function or tag that will be used for
dynamic purposes.
Also specify the tag name in single quote marks:
"Tag name"
Example:
In this example a circle property "Top" will be made dynamic with the aid of the tag
"NewDynamic":
Sub AddDynamicAsVariableDirectToProperty()
'VBA141
Dim objVariableTrigger As HMIVariableTrigger
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("MyCircle", "HMICircle")
'Make property "Top" dynamic:
Set objVariableTrigger = objCircle.Top.CreateDynamic(hmiDynamicCreationTypeVariableDirect,
"NewDynamic")
'
'Define cycle-time
With objVariableTrigger
.CycleType = hmiCycleType_2s
End With
End Sub
See also
Property Object (Page 2046)
DeleteDynamic Method (Page 1839)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
1834 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
CreateGroup Method
Description
Creates a group object from the objects selected in the specified picture.
For further information on this topic please refer to "Group Objects" in this documentation and
"Group Object" in the WinCC documentation.
syntax
Expression.CreateGroup()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
Example:
In the following example two objects are inserted at different positions in the current picture
and a group object is then created:
Sub CreateGroup()
'VBA142
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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
objGroup.ObjectName = "myGroup"
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1835
VBA for Automated Configuration
3.6 VBA Reference
See also
SelectedObjects object (Listing) (Page 2063)
Group Object (Page 1983)
VBA Reference (Page 1752)
Group Objects (Page 1682)
D-M
GetDeclutterObjectSize method
Description
Reads the limits displaying and hiding objects (decluttering) in the specified picture.
Syntax
Expression.GetDeclutterObjectSize(Min, Max)
Expression
Required. An expression or element which returns an object of the "Document" type.
Parameter
Parameter (data type) Description
Min (Long) Lower size range in pixels.
Max (Long) Upper size range in pixels.
Example
In the following example, the decluttering limits of the active picture are read and output:
Sub ReadSettingsOfPicture()
'VBA848
Dim objectsize_min As Long, objectsize_max As Long
ActiveDocument.GetDeclutterObjectSize objectsize_min, objectsize_max
MsgBox objectsize_min & " " & objectsize_max
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1836 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Delete Method
Description
Deletes the specified object and removes it from the listing.
syntax
Expression.Delete()
Expression
Necessary. An expression or element which returns objects of the following types.
● Assignment
● FolderItem
● LanguageText
● Menu
● MenuItem
● Object
● Toolbar
● ToolbarItem
● VariableTrigger
● View
Parameters
--
Example:
In the following example the first object in the active picture will be deleted. For this example
to work, you must have created at least one object in the active picture:
Sub ObjectDelete()
'VBA143
ActiveDocument.HMIObjects(1).Delete
End Sub
See also
LanguageText Object (Page 2003)
View Object (Page 2111)
VariableTrigger Object (Page 2108)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1837
VBA for Automated Configuration
3.6 VBA Reference
ToolbarItem Object (Page 2092)
FolderItem Object (Page 1977)
HMIObject Object (Page 1992)
MenuItem Object (Page 2017)
Menu Object (Page 2013)
VBA Reference (Page 1752)
DeleteAll Method
Description
Deletes all selected objects in the specified picture and removes them from the "Selection"
and "HMIObjects" listings.
syntax
Expression.DeleteAll()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
1838 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example two objects are inserted at different positions in the current picture
and then selected and deleted:
Sub DeleteAllSelectedObjects()
'VBA145
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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!"
ActiveDocument.Selection.DeleteAll
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
DeleteDynamic Method
Description
Removes the dynamic characteristic from the specified property.
syntax
Expression.DeleteDynamic
Expression
Necessary. An expression or element which returns an object of the "Property" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1839
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the dynamic characteristic created with the aid of the CreateDynamic
Method will be
Sub DeleteDynamicFromObjectMeinKreis()
'VBA146
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects("MyCircle")
objCircle.Top.DeleteDynamic
End Sub
See also
Property Object (Page 2046)
CreateDynamic Method (Page 1833)
VBA Reference (Page 1752)
DeselectAll Method
Description
Deselects all selected objects in the specified picture and removes them from the Selection
listing.
syntax
Expression.DeselectAll()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
1840 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example two objects are inserted at different positions in the current picture
and selected. All selected objects are then deselected:
Sub SelectObjectsAndDeselectThemAgain()
'VBA147
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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 created and selected!"
ActiveDocument.Selection.DeselectAll
MsgBox "Objects deselected!"
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
Destroy Method
Description
Ungroups the specified customized object. The objects remain intact.
Syntax
Expression.Destroy()
Expression
An expression or element which returns objects of the "CustomizedObject" types.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1841
VBA for Automated Configuration
3.6 VBA Reference
Example:
An example showing how to use the Destroy Method can be found in this documentation under
the heading "Editing a Customized Object with VBA".
See also
CustomizedObject Object (Page 1943)
Destroy Method (Page 1841)
Delete Method (Page 1837)
CreateCustomizedObject Method (Page 1831)
How to Edit a Customized Object with VBA (Page 1691)
DuplicateSelection Method
Description
Duplicates the objects selected in the specified picture. The objects created in this way are
added to the HMIObjects listing. The names of new objects are numbered consecutively with
each duplication.
For instance if you duplicate an object called "Circle", the duplicate object is called "Circle1".
If you duplicate the object called "Circle" once more, the resulting object is called "Circle2" and
so on.
syntax
Expression.DuplicateSelection()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
1842 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example two objects are inserted at different positions in the current picture
and selected. They are then duplicated:
Sub DuplicateSelectedObjects()
'VBA149
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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 created and selected!"
ActiveDocument.Selection.DuplicateSelection
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
VBA Reference (Page 1752)
EvenlySpaceHorizontally Method
Description
Using this method, the objects selected in the specified picture are spaced horizontally at an
even distance from one another.
syntax
Expression.EvenlySpaceHorizontally()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1843
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example three objects are inserted at different positions in the current picture
and selected. They are then positioned horizontally at an even distance from one another:
Sub EvenlySpaceObjectsHorizontally()
'VBA150
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objEllipse As HMIEllipse
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("sRectangle", "HMIRectangle")
Set objEllipse = ActiveDocument.HMIObjects.AddHMIObject("sEllipse", "HMIEllipse")
With objCircle
.Top = 30
.Left = 0
.Selected = True
End With
With objRectangle
.Top = 80
.Left = 42
.Selected = True
End With
With objEllipse
.Top = 48
.Left = 162
.BackColor = RGB(255, 0, 0)
.Selected = True
End With
MsgBox "Objects created and selected!"
ActiveDocument.Selection.EvenlySpaceHorizontally
End Sub
See also
VBA Reference (Page 1752)
SelectedObjects object (Listing) (Page 2063)
EvenlySpaceVertically Method
Description
Using this method, the objects selected in the specified picture are spaced vertically at an even
distance from one another.
syntax
Expression.EvenlySpaceVertically()
WinCC: Scripting (VBS, ANSI-C, VBA)
1844 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
Example:
In the following example three objects are inserted at different positions in the current picture
and selected. They are then positioned vertically at an even distance from one another:
Sub EvenlySpaceObjectsVertically()
'VBA151
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objEllipse As HMIEllipse
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("sRectangle", "HMIRectangle")
Set objEllipse = ActiveDocument.HMIObjects.AddHMIObject("sEllipse", "HMIEllipse")
With objCircle
.Top = 30
.Left = 0
.Selected = True
End With
With objRectangle
.Top = 80
.Left = 42
.Selected = True
End With
With objEllipse
.Top = 48
.Left = 162
.BackColor = RGB(255, 0, 0)
.Selected = True
End With
MsgBox "Objects created and selected"
ActiveDocument.Selection.EvenlySpaceVertically
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1845
VBA for Automated Configuration
3.6 VBA Reference
Export Method
Description
Saves the specified picture as an EMF file.
Syntax
Expression.Export(Type, Path)
Expression
Required. An expression or element which returns an object of the "Document" type.
Parameter
Parameter (Data Type) Description
Type (HMIImportExportType) Defines the format in which the exported picture
will be saved.
Path (String) The path in which the picture is going to be expor‐
ted. The path must exist.
Example
Sub ExportAllPicturesAsPDL()
'VBA152
Dim iPictureCounter As Integer
Dim strPath As String
strPath = "C:\WinCC_PDL_Export\"
'Count Pictures in Graphics Designer...
For iPictureCounter = 1 To grafexe.Documents.Count
'...and export each picture as PDL-file to specified path:
grafexe.Documents(iPictureCounter).Export hmiImportExportTypePDL,
strPath
Next iPictureCounter
End Sub
See also
View Object (Page 2111)
Document Object (Page 1954)
WinCC: Scripting (VBS, ANSI-C, VBA)
1846 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Find Method
Description
Searches for objects in the specified picture and returns the search result as a collection object.
You can search for the following object properties:
● Type
● Name
● Property
syntax
Expression.Find([ObjectType], [ObjectName], [PropertyName])
Expression
Necessary. An expression or element which returns an object of the "HMIObjects" type.
Parameters
You must specify at least one of the three parameters.
Parameter (Data Type) Description
ObjectType (String) The object type that is to be searched for. Specify
the "ProgID" of the object concerned. "Obtain the
"ProgID" by prefixing the VBA object name with
"HMI" "(e.g. HMICircle or HMIRectangle)
ObjectName (String) The name of the object that is to be searched for.
You can use placeholders (?,*) in the object name
in order to find objects with similar names.
PropertyName (String) The name of the object property that is to be
searched for. Specify the VBA property name con‐
cerned (e.g. "BackColor" in place of "Background
Color").
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1847
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example, objects of the "HMICircle" type will be searched for in the active
picture and the search result will be output:
Sub FindObjectsByType()
'VBA153
Dim colSearchResults As HMICollection
Dim objMember As HMIObject
Dim iResult As Integer
Dim strName As String
Set colSearchResults = ActiveDocument.HMIObjects.Find(ObjectType:="HMICircle")
For Each objMember In colSearchResults
iResult = colSearchResults.Count
strName = objMember.ObjectName
MsgBox "Found: " & CStr(iResult) & vbCrLf & "objectname: " & strName)
Next objMember
End Sub
Note
Further information on using the Find Method can be found in this documentation under the
heading "Editing Standard Objects, Smart Objects and Windows Objects".
See also
Type Property (Page 2453)
Name Property (Page 2349)
Property Object (Page 2046)
HMIObjects Object (Listing) (Page 1994)
How to edit Default objects, Smart objects, Windows objects and Tube objects (Page 1674)
VBA Reference (Page 1752)
FindByDisplayName Method
Description
Searches the entire Components Library for the specified object. A FolderItem object is
returned as the search result.
Note
The display name of the object is language-dependent. Only the language currently set will
be taken into account when searching. The search ends with the first object found.
WinCC: Scripting (VBS, ANSI-C, VBA)
1848 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
syntax
Expression.FindByDisplayName(DisplayName)
Expression
Necessary. An expression or element which returns an object of the "SymbolLibrary" type or
the "FolderItems" listing.
Parameters
Parameter (Data Type) Description
DisplayName (String) The display name of the object that is to be
searched for in the Components Library.
Example:
In the following example the entire library will be searched for the object "PC" and its display
name will be output:
Sub FindObjectInSymbolLibrary()
'VBA154
Dim objGlobalLib As HMISymbolLibrary
Dim objFItem As HMIFolderItem
Set objGlobalLib = Application.SymbolLibraries(1)
Set objFItem = objGlobalLib.FindByDisplayName("PC")
MsgBox objFItem.DisplayName
End Sub
See also
FolderItem Object (Page 1977)
Accessing the component library with VBA (Page 1650)
FireConnectionEvents method
Description
Is used internally by the Graphics Designer.
FlipHorizontally Method
Description
Mirrors the selected objects in the specified picture along the horizontal midline.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1849
VBA for Automated Configuration
3.6 VBA Reference
The object type determines whether it is allowed to be mirrored (for instance an OLE Element
cannot be mirrored). The properties are appropriately modified when mirroring is performed.
For example, if you mirror an object of the "StaticText" type along the horizontal midline, the
value of the "AlignmentTop" property changes from "0" to "2".
syntax
Expression.FlipHorizontally()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
Example:
In the following example a StaticText object will be inserted into the active picture and mirrored
along the horizontal midline:
Sub FlipObjectHorizontally()
'VBA155
Dim objStaticText As HMIStaticText
Dim strPropertyName As String
Dim iPropertyValue As Integer
Set objStaticText = ActiveDocument.HMIObjects.AddHMIObject("Textfield", "HMIStaticText")
strPropertyName = objStaticText.Properties("Text").Name
With objStaticText
.Width = 120
.Text = "Sample Text"
.Selected = True
iPropertyValue = .AlignmentTop
MsgBox "Value of '" & strPropertyName & "' before flip: " & iPropertyValue
ActiveDocument.Selection.FlipHorizontally
iPropertyValue = objStaticText.AlignmentTop
MsgBox "Value of '" & strPropertyName & "' after flip: " & iPropertyValue
End With
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
1850 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
FlipVertically Method
Description
Mirrors the selected objects in the specified picture along the vertical midline.
The object type determines whether it is allowed to be mirrored (for instance an OLE Element
cannot be mirrored). The properties are appropriately modified when mirroring is performed.
For example if you mirror an object of the "StaticText" type along the vertical midline, the value
of the "AlignmentLeft" property changes from "0" to "2".
syntax
Expression.FlipVertically()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
Example:
In the following example a StaticText object will be inserted into the active picture and mirrored
along the vertical midline:
Sub FlipObjectVertically()
'VBA156
Dim objStaticText As HMIStaticText
Dim strPropertyName As String
Dim iPropertyValue As Integer
Set objStaticText = ActiveDocument.HMIObjects.AddHMIObject("Textfield", "HMIStaticText")
strPropertyName = objStaticText.Properties("Text").Name
With objStaticText
.Width = 120
.Text = "Sample Text"
.Selected = True
.AlignmentLeft = 0
iPropertyValue = .AlignmentLeft
MsgBox "Value of '" & strPropertyName & "' before flip: " & iPropertyValue
ActiveDocument.Selection.FlipVertically
iPropertyValue = objStaticText.AlignmentLeft
MsgBox "Value of '" & strPropertyName & "' after flip: " & iPropertyValue
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1851
VBA for Automated Configuration
3.6 VBA Reference
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
ForwardOneLevel Method
Description
Moves the selected objects one level forward within their current layer.
syntax
Expression.ForwardOneLevel()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
Example:
In the following example two objects are inserted in the active picture. The object inserted first
is then moved forward one level:
Sub MoveObjectOneLevelForward()
'VBA174
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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 = 40
.Left = 40
.Width = 100
.Height = 50
.BackColor = RGB(255, 0, 255)
.Selected = False
End With
MsgBox "Objects created and selected!"
ActiveDocument.Selection.ForwardOneLevel
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1852 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
GetItemByPath Method
Description
Returns a FolderItem object (folder or object) located on the specified internal access path in
the Components Library.
Note
To obtain the internal access path, select the "Copy Path" command from The internal access
path to the folder or object will then be copied to the clipboard.
syntax
Expression.GetItemByPath(PathName)
Expression
Necessary. An expression or element which returns an object of the "SymbolLibrary" type.
Parameters
Parameter (Data Type) Description
PathName (String) The internal access path on which the object is
located in the Components Library.
Example:
In this example one object from the entire library will be returned and its display name will be
output:
Sub ShowDisplayName()
'VBA157
Dim objGlobalLib As HMISymbolLibrary
Dim objFItem As HMIFolderItem
Set objGlobalLib = Application.SymbolLibraries(1)
Set objFItem = objGlobalLib.GetItemByPath("\Folder1\Folder2\Object1")
MsgBox objFItem.DisplayName
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1853
VBA for Automated Configuration
3.6 VBA Reference
See also
SymbolLibrary Object (Page 2084)
FolderItem Object (Page 1977)
Accessing the component library with VBA (Page 1650)
InsertFromMenuItem Method
Description
Inserts into an existing, user-defined toolbar a new icon that references an existing menu entry
in a user-defined menu.
Use this method if you wish to set up a toolbar so that it contains the same commands as an
existing user-defined menu.
Syntax
Expression.InsertFromMenuItem(Position, Key, pMenuItem,
DefaultToolTipText)
Expression
Required. An expression or element which returns an object of the "ToolbarItems" type.
Parameters
Parameter (Data Type) Description
Position (Long) Defines the position of the icon within the user-de‐
fined toolbar.
Key (Variant) Identifies the symbol. Use unique names for "Key"
"(e.g. tItem1_1).
pMenuItem (HMIMenuItem) The MenuItem object that is intended to be refer‐
enced.
DefaultToolTipText (String) Defines for the icon concerned the tool tip text that
will be displayed when you move the mouse over
the icon.
WinCC: Scripting (VBS, ANSI-C, VBA)
1854 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In this example a user-defined menu and a user-defined toolbar will be inserted in the active
picture. The icon calls up the menu entry "Hello World" from the user-defined menu:
Sub ToolbarItem_InsertFromMenuItem()
'VBA158
Dim objMenu As HMIMenu
Dim objToolbarItem As HMIToolbarItem
Dim objToolbar As HMIToolbar
Dim objMenuItem As HMIMenuItem
Set objMenu = Application.CustomMenus.InsertMenu(1, "Menu1", "TestMenu")
'
'*************************************************
'* Note:
'* The object-reference has to be unique.
'*************************************************
'
Set objMenuItem = Application.CustomMenus(1).MenuItems.InsertMenuItem(1, "MenuItem1",
"Hello World")
Application.CustomMenus(1).MenuItems(1).Macro = "HelloWorld"
Set objToolbar = Application.CustomToolbars.Add("Toolbar1")
Set objToolbarItem = Application.CustomToolbars(1).ToolbarItems.InsertFromMenuItem(1,
"ToolbarItem1", objMenuItem, "Call's Hello World of TestMenu")
End Sub
Sub HelloWorld()
MsgBox "Procedure 'HelloWorld()' is execute."
End Sub
See also
ToolbarItems Object (Listing) (Page 2094)
InsertSeparator Method (Page 1859)
Add Method (CustomToolbars Listing) (Page 1795)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1855
VBA for Automated Configuration
3.6 VBA Reference
InsertMenu Method
Description
Creates a new, user-defined menu. There is a difference between application-specific and
picture-specific user-defined menus:
● Application-specific menu: 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 menu: 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.InsertMenu(Position, Key, DefaultLabel)
Expression
Necessary. An expression or element which returns an object of the "CustomMenus" type.
Parameters
Parameter (Data Type) Description
Position (Long) Defines the position of the user-defined menu with‐
in the menu bar. However, picture-specific menus
are always positioned to the right of application-
specific menus.
Key (Variant) Identifies the user-defined menu. Use unique
names for "Key" (e.g. "DocMenu1")
DefaultLabel (String) The name of the user-defined menu.
WinCC: Scripting (VBS, ANSI-C, VBA)
1856 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example, a user-defined menu with two menus entries and a submenu with
two entries will be created in the active picture. The submenu will be visually distinguished by
a dividing line:
Sub CreateDocumentMenus()
'VBA159
Dim objDocMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Dim objSubMenu As HMIMenuItem
'
Set objDocMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DocMenu1", "Doc_Menu_1")
'
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(1, "dmItem1_1", "First MenuItem")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(2, "dmItem1_2", "Second MenuItem")
'
'Insert a dividing rule into custumized menu:
Set objMenuItem = objDocMenu.MenuItems.InsertSeparator(3, "dSeparator1_3")
'
Set objSubMenu = objDocMenu.MenuItems.InsertSubMenu(4, "dSubMenu1_4", "First SubMenu")
'
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(5, "dmItem1_5", "First item in sub-
menu")
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(6, "dmItem1_6", "Second item in sub-
menu")
End Sub
The diagram shows the generated menu structure.
See also
Menus Object (Listing) (Page 2015)
InsertSubmenu Method (Page 1860)
InsertSeparator Method (Page 1859)
InsertMenuItem Method (Page 1858)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1857
VBA for Automated Configuration
3.6 VBA Reference
InsertMenuItem Method
Description
Inserts a new entry in a user-defined menu.
syntax
Expression.InsertMenuItem(Position, Key, DefaultLabel)
Expression
Necessary. An expression or element which returns an object of the "MenuItems" type.
Parameters
Parameter (Data Type) Description
Position (Long) Defines the position of the submenu within the
user-defined menu.
Key (Variant) Identifies the submenu. Use unique names for
"Key" "(e.g. dSubMenu1_4).
DefaultLabel (String) Defines the name of the submenu.
Example:
In the following example, a user-defined menu with two menus entries and a submenu with
two entries will be created in the active picture. The submenu will be visually distinguished by
a dividing line:
Sub CreateDocumentMenus()
'VBA160
Dim objDocMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Dim objSubMenu As HMIMenuItem
'
Set objDocMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DocMenu1", "Doc_Menu_1")
'
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(1, "dmItem1_1", "First MenuItem")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(2, "dmItem1_2", "Second MenuItem")
'
'Insert a dividing rule into customized menu:
Set objMenuItem = objDocMenu.MenuItems.InsertSeparator(3, "dSeparator1_3")
'
Set objSubMenu = objDocMenu.MenuItems.InsertSubMenu(4, "dSubMenu1_4", "First SubMenu")
'
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(5, "dmItem1_5", "First item in sub-
menu")
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(6, "dmItem1_6", "Second item in sub-
menu")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1858 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
The diagram shows the menu structure.
See also
MenuItems Object (Listing) (Page 2019)
MenuItem Object (Page 2017)
InsertSubmenu Method (Page 1860)
InsertSeparator Method (Page 1859)
InsertMenu Method (Page 1856)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
InsertSeparator Method
Description
Inserts a dividing line in a user-defined menu or user-defined toolbar.
syntax
Expression.InsertSeparator(Position, Key)
Expression
Necessary. An expression or element which returns an object of the "MenuItems" or
"ToolbarItems" type.
Parameters
Parameter (Data Type) Description
Position (Long) Defines the position of the dividing line within the
user-defined menu or user-defined toolbar.
Key (Variant) Identifies the dividing line. Use unique names for
"Key" (e.g. "tSeparator1_2").
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1859
VBA for Automated Configuration
3.6 VBA Reference
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()
'VBA161
Dim objToolbar As HMIToolbar
Dim objToolbarItem As HMIToolbarItem
Set objToolbar = ActiveDocument.CustomToolbars.Add("DocToolbar")
'Add toolbar-item to userdefined toolbar
Set objToolbarItem = objToolbar.ToolbarItems.InsertToolbarItem(1, "tItem1_1", "First
symbol-icon")
Set objToolbarItem = objToolbar.ToolbarItems.InsertToolbarItem(3, "tItem1_3", "Second
symbol-icon")
'
'Insert dividing rule between first and second symbol-icon
Set objToolbarItem = objToolbar.ToolbarItems.InsertSeparator(2, "tSeparator1_2")
End Sub
See also
ToolbarItems Object (Listing) (Page 2094)
MenuItems Object (Listing) (Page 2019)
InsertToolbarItem Method (Page 1862)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
InsertSubmenu Method
Description
Inserts a submenu into an existing user-defined menu.
syntax
Expression.InsertSubmenu(Position, Key, DefaultLabel)
Expression
Necessary. An expression or element which returns an object of the "MenuItem" type
WinCC: Scripting (VBS, ANSI-C, VBA)
1860 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameters
Parameter (Data Type) Description
Position (Long) Defines the position of the submenu within the
user-defined menu.
Key (Variant) Identifies the submenu. Use unique names for
"Key" "(e.g. dSubMenu1_4).
DefaultLabel (String) Defines the name of the submenu.
Example:
In the following example, a user-defined menu with two menus entries and a submenu with
two entries will be created in the active picture. The submenu will be visually distinguished by
a dividing line:
Sub CreateDocumentMenus()
'VBA162
Dim objDocMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Dim objSubMenu As HMIMenuItem
'
Set objDocMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DocMenu1", "Doc_Menu_1")
'
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(1, "dmItem1_1", "First MenuItem")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(2, "dmItem1_2", "Second MenuItem")
'
'Insert a dividing rule into customized menu:
Set objMenuItem = objDocMenu.MenuItems.InsertSeparator(3, "dSeparator1_3")
'
Set objSubMenu = objDocMenu.MenuItems.InsertSubMenu(4, "dSubMenu1_4", "First SubMenu")
'
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(5, "dmItem1_5", "First item in sub-
menu")
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(6, "dmItem1_6", "Second item in sub-
menu")
End Sub
The diagram shows the menu structure:
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1861
VBA for Automated Configuration
3.6 VBA Reference
See also
MenuItem Object (Page 2017)
InsertSeparator Method (Page 1859)
InsertMenuItem Method (Page 1858)
InsertMenu Method (Page 1856)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
InsertToolbarItem Method
Description
Inserts a new icon in an existing user-defined toolbar.
syntax
Expression.InsertToolbarItem(Position, Key, DefaultToolTipText)
Expression
Necessary. An expression or element which returns an object of the "ToolbarItems" type.
Parameters
Parameter (Data Type) Description
Position (Long) Defines the position of the icon within the user-de‐
fined toolbar.
Key (Variant) Identifies the symbol. Use unique names for "Key"
"(e.g. tItem1_1).
DefaultToolTipText (String) Defines for the icon concerned the tool tip text that
will be displayed when you move the mouse over
the icon.
WinCC: Scripting (VBS, ANSI-C, VBA)
1862 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
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()
'VBA163
Dim objToolbar As HMIToolbar
Dim objToolbarItem As HMIToolbarItem
Set objToolbar = ActiveDocument.CustomToolbars.Add("DocToolbar")
'Add toolbar-item to userdefined toolbar
Set objToolbarItem = objToolbar.ToolbarItems.InsertToolbarItem(1, "tItem1_1", "First
symbol-icon")
Set objToolbarItem = objToolbar.ToolbarItems.InsertToolbarItem(3, "tItem1_3", "Second
symbol-icon")
'
'Insert dividing rule between first and second symbol-icon
Set objToolbarItem = objToolbar.ToolbarItems.InsertSeparator(2, "tSeparator1_2")
End Sub
See also
ToolbarItems Object (Listing) (Page 2094)
InsertSeparator Method (Page 1859)
Add Method (CustomToolbars Listing) (Page 1795)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
IsCSLayerVisible Method
Description
Returns TRUE if the specified CS layer is visible.
syntax
Expression.IsCSLayerVisible(Index)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1863
VBA for Automated Configuration
3.6 VBA Reference
Expression
Necessary. An expression or element which returns an object of the "Document" type.
Parameters
Parameter (Data Type) Description
Index (Variant) Defines the CS layer. Value range from 1 to 32.
Layer0 corresponds to the index value "1".
Example:
The following example determines whether CS layer 1 in the copy of the active picture is visible
and outputs the result:
Sub IsCSLayerVisible()
'VBA164
Dim objView As HMIView
Dim strLayerName As String
Dim iLayerIdx As Integer
Set objView = ActiveDocument.Views(1)
objView.Activate
iLayerIdx = 2
strLayerName = ActiveDocument.Layers(iLayerIdx).Name
If objView.IsCSLayerVisible(iLayerIdx) = True Then
MsgBox "CS " & strLayerName & " is visible"
Else
MsgBox "CS " & strLayerName & " is invisible"
End If
End Sub
See also
Document Object (Page 1954)
VBA Reference (Page 1752)
Editing Layers with VBA (Page 1666)
IsRTLayerVisible Method
Description
Returns TRUE if the specified RT layer is visible.
syntax
Expression.IsRTLayerVisible(Index)
WinCC: Scripting (VBS, ANSI-C, VBA)
1864 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Expression
Necessary. An expression or element which returns an object of the "Document" type.
Parameters
Parameter (Data Type) Description
Index (Variant) Defines the RT layer. Value range from 1 to 32.
Layer0 corresponds to the index value "1".
Example:
The following example determines whether RT layer 1 is visible and outputs the result:
Sub RTLayerVisibility()
'VBA165
Dim strLayerName As String
Dim iLayerIdx As Integer
iLayerIdx = 2
strLayerName = ActiveDocument.Layers(iLayerIdx).Name
If ActiveDocument.IsRTLayerVisible(iLayerIdx) = True Then
MsgBox "RT " & strLayerName & " is visible"
Else
MsgBox "RT " & strLayerName & " is invisible"
End If
End Sub
See also
Document Object (Page 1954)
VBA Reference (Page 1752)
Editing Layers with VBA (Page 1666)
Item Method
Description
Returns an element from a listing.
syntax
Expression.Item(Index)
Expression
Necessary. An expression or element which returns an object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1865
VBA for Automated Configuration
3.6 VBA Reference
Parameters
Parameter (Data Type) Description
Index (Variant) The name or index number of an element from the
listing.
You can use the Object Name as the name. As the
index number you can use a numerical expression
(from 1 up to the value of the Count property of the
listing).
If the entered value fails to match any element in
the listing, this counts as an error.
Example:
Note
The Item Method is the default method for listings. Both the following examples give the same
result.
In the following example the name of the first picture in the Graphics Designer is output:
Sub ShowDocumentNameLongVersion()
'VBA166
Dim strDocName As String
strDocName = Application.Documents.Item(3).Name
MsgBox strDocName
End Sub
Sub ShowDocumentNameShortVersion()
'VBA167
Dim strDocName As String
strDocName = Application.Documents(3).Name
MsgBox strDocName
End Sub
See also
VariableStateValues Object (Listing) (Page 2106)
Count Property (Page 2208)
Views Object (Listing) (Page 2112)
VariableTriggers Object (Listing) (Page 2110)
ToolbarItems Object (Listing) (Page 2094)
Toolbars Object (Listing) (Page 2090)
SymbolLibraries Object (Listing) (Page 2082)
SelectedObjects object (Listing) (Page 2063)
Properties Object (Listing) (Page 2045)
WinCC: Scripting (VBS, ANSI-C, VBA)
1866 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
MenuItems Object (Listing) (Page 2019)
Menus Object (Listing) (Page 2015)
Layers Object (Listing) (Page 2006)
LanguageTexts Object (Listing) (Page 2004)
LanguageFonts Object (Listing) (Page 2001)
GroupedObjects Object (Listing) (Page 1988)
FolderItems Object (Listing) (Page 1978)
Events Object (Listing) (Page 1972)
Documents Object (Listing) (Page 1957)
DataLanguages Object (Listing) (Page 1947)
ConnectionPoints Object (Listing) (Page 1941)
AnalogResultInfos Object (Listing) (Page 1914)
Actions Object (Listing) (Page 1904)
VBA Reference (Page 1752)
SVGLibraries object (list) (Page 2077)
SVGLibrary object (Page 2078)
ItemByLcid Method
Description
Selects the language for which you wish to enter the font settings. Read only access.
Note
You can only select languages in which you have already configured.
Syntax
Expression.ItemByLcid(LangID)
Expression
Required. An expression or element which returns an object of the "LanguageFonts" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1867
VBA for Automated Configuration
3.6 VBA Reference
Parameter
Parameter (Data Type) Description
LangID (Long) This is the language identifier. The list of language
identifiers is contained, for example, in the "Lan‐
guages.csv" file that is found in the index of the
WinCC documentation.
Example
The following example sets the font attributes of a button for French and English. In contrast
to English, French is displayed on the button in a smaller font with a constant tracking (Courier
New, 12pt):
Sub ExampleForLanguageFonts()
'VBA168
Dim objLangFonts As HMILanguageFonts
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
objButton.Text = "Hello"
Set objLangFonts = objButton.LDFonts
'
'To make fontsettings for English:
With objLangFonts.ItemByLCID(1033)
.Family = "Times New Roman"
.Bold = False
.Italic = True
.Underlined = False
.Size = 14
End With
'
'To make fontsettings for French:
With objLangFonts.ItemByLCID(1036)
.Family = "Courier New"
.Bold = True
.Italic = False
.Underlined = True
.Size = 12
End With
End Sub
See also
LanguageFonts Object (Listing) (Page 2001)
WinCC: Scripting (VBS, ANSI-C, VBA)
1868 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
LoadDefaultConfig Method
Description
Loads the file in which the default settings for objects are saved. The PDD file is located in the
"GraCS" folder of the current project.
syntax
Expression.LoadDefaultConfig(FileName)
Expression
Necessary. An expression or element which returns an object of the "Application" type.
Parameters
Parameter (Data Type) Description
FileName (String) The name of the PDD file which it is intended to
load.
Example:
In the following example the file "Test.PDD" will be loaded. For this example to work, you must
have previously saved the file. You can do this with the aid of the SaveDefaultConfig Method:
Sub LoadDefaultConfig()
'VBA169
Application.LoadDefaultConfig ("Test.PDD")
End Sub
See also
Application Object (Page 1915)
SaveDefaultConfig Method (Page 1887)
VBA Reference (Page 1752)
MoveOneLayerDown Method
Description
Moves the selected object in the specified picture into the next lowest layer.
syntax
Expression.MoveOneLayerDown()
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1869
VBA for Automated Configuration
3.6 VBA Reference
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
Example:
In the following example a circle in the active picture is inserted in the third layer and then
moved to the next lowest layer:
Sub MoveObjectOneLayerDown()
'VBA170
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
With objCircle
.Top = 40
.Left = 40
.Selected = True
.Layer = 3
MsgBox "Circle is inserted into layer" & Str(.Layer)
ActiveDocument.Selection.MoveOneLayerDown
MsgBox "Circle is moved into layer" & Str(.Layer)
End With
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
MoveOneLayerUp Method
Description
Moves the selected object in the specified picture into the next highest layer.
syntax
Expression.MoveOneLayerUp()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
1870 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameters
--
Example:
In the following example a circle in the active picture is inserted in the third layer and then
moved to the next highest layer:
Sub MoveObjectOneLayerUp()
'VBA171
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
With objCircle
.Top = 40
.Left = 40
.Selected = True
.Layer = 3
MsgBox "Circle is inserted into layer" & Str(.Layer)
ActiveDocument.Selection.MoveOneLayerUp
MsgBox "Circle is moved into layer" & Str(.Layer)
End With
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
MoveSelection Method
Description
Moves one or more objects selected in the picture by the specified coordinates.
Note
When you want to reposition one or more selected objects, use the properties "Left" and "Top".
syntax
Expression.MoveSelection(PosX, PosY)
Expression
Required. An expression or element which returns an object of the "Document" or "Selection"
type.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1871
VBA for Automated Configuration
3.6 VBA Reference
Parameters
Parameter (Data Type) Description
PosX (Long) The number of pixels by which the selection is to
be moved horizontally.
PosY (Long) The number of pixels by which the selection is to
be moved vertically.
Example:
In the following example two objects are inserted at different positions in the current picture
and selected. The selection is then moved 30 pixels to the right and 40 pixels down:
Sub MoveSelectionToNewPostion()
'VBA172
Dim nPosX As Long
Dim nPosY As Long
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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!"
nPosX = 30
nPosY = 40
ActiveDocument.MoveSelection nPosX, nPosY
End Sub
See also
Top Property (Page 2449)
Left Property (Page 2311)
Document Object (Page 1954)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
1872 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
O-Z
Open Method
Description
Opens an existing picture in the Graphics Designer and adds it to the documents listing.
syntax
Expression.Open(FileName, [HMIOpenDocumentType])
Expression
Necessary. An expression or element which returns an object of the "Documents" type.
Parameters
Parameter (Data Type) Description
FileName (String) The name of the PDL file to be opened.
Unless you saved the PDL file in the "GraCS" fold‐
er of the open project, you must also specify the
path at the same time.
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 the picture "Test" will be opened. For this example to work, you must
have previously saved a picture with the name "Test" in the "GraCS" folder of the open project.
Sub OpenDocument()
'VBA175
Application.Documents.Open "Test.PDL", hmiOpenDocumentTypeVisible
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1873
VBA for Automated Configuration
3.6 VBA Reference
See also
Hide Property (Page 2277)
Documents Object (Listing) (Page 1957)
VBA Reference (Page 1752)
PasteClipboard Method
Description
Pastes the contents of the clipboard into the specified picture.
Note
The clipboard must contain objects from the Graphics Designer. Other contents (such as ASCII
text) will not be pasted.
syntax
Expression.PasteClipboard()
Expression
Necessary. An expression or element which returns an object of the "Document" type.
Parameters
--
Example:
In the following example all the objects selected in the active picture are copied to the clipboard
and then pasted into a new picture. For this example to work, you must have selected at least
one object in the active picture:
Sub CopySelectionToNewDocument()
'VBA176
Dim iNewDoc As String
ActiveDocument.CopySelection
Application.Documents.Add hmiOpenDocumentTypeVisible
iNewDoc = Application.Documents.Count
Application.Documents(iNewDoc).PasteClipboard
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1874 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
ActiveDocument Property (Page 2116)
Document Object (Page 1954)
CopySelection Method (Page 1828)
Add Method (Documents Listing) (Page 1797)
Activate Method (Page 1792)
VBA Reference (Page 1752)
PrintDocument Method
Description
Prints the specified copy of the picture using the current printer settings.
syntax
Expression.PrintDocument()
Expression
Necessary. An expression or element which returns an object of the "View" type.
Parameters
--
Example:
In the following example a copy of the active picture is created and then activated and printed:
Sub CreateAndPrintView()
'VBA177
Dim objView As HMIView
Set objView = ActiveDocument.Views.Add
objView.Activate
objView.PrintDocument
End Sub
See also
View Object (Page 2111)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1875
VBA for Automated Configuration
3.6 VBA Reference
PrintProjectDocumentation Method
Description
Prints out the project documentation for the current picture complete with all the objects it
contains and their properties via the reporting system in WinCC (Report Designer).
You must first have set the print settings (such as page range) in the "Print Job Properties"
dialog. To do this, go to the Graphics Designer and select the menu command "File" > "Project
Documentation - Setup".
Note
The project documentation will be output on the printer that was set up in the Report Designer.
You can design the print layout to suit your needs with the aid of the Report Designer.
syntax
Expression.PrintProjectDocumentation()
Expression
Necessary. An expression or element which returns an object of the "Document" type.
Parameters
--
Example:
In the following example the project documentation for the active picture will be printed:
Sub ToPrintProjectDocumentation()
'VBA178
ActiveDocument.PrintProjectDocumentation
End Sub
See also
Document Object (Page 1954)
VBA Reference (Page 1752)
Remove Method
Description
Removes an object from a selection of objects or from a group object.
WinCC: Scripting (VBS, ANSI-C, VBA)
1876 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
syntax
Expression.Remove(Index)
Expression
Necessary. An expression or element which returns an object of the "GroupedObjects" or
"Selection" type.
Parameters
Parameter (Data Type) Description
Index (Variant) The name or index number of the object that is
intended to be removed.
You can use the Object Name as the name. As the
index number you can use a numerical expression
(from 1 up to the value of the Count property of the
listing).
If the entered value fails to match any element in
the listing, this counts as an error.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1877
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example three objects will first be inserted in the active picture and selected.
Then one object will be removed from the selection and the remaining objects will be grouped.
Then the first object will be removed from the group object:
Sub RemoveObjectFromGroup()
'VBA179
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objEllipse As HMIEllipse
Dim objGroup As HMIGroup
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("sRectangle", "HMIRectangle")
Set objEllipse = ActiveDocument.HMIObjects.AddHMIObject("sEllipse", "HMIEllipse")
With objCircle
.Top = 30
.Left = 0
.Selected = True
End With
With objRectangle
.Top = 80
.Left = 42
.Selected = True
End With
With objEllipse
.Top = 48
.Left = 162
.Width = 40
.BackColor = RGB(255, 0, 0)
.Selected = True
End With
MsgBox "Objects selected!"
Set objGroup = ActiveDocument.Selection.CreateGroup
MsgBox "Group-object is created."
objGroup.GroupedHMIObjects.Remove ("sEllipse")
MsgBox "The ellipse is removed from group-object."
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
GroupedObjects Object (Listing) (Page 1988)
VBA Reference (Page 1752)
Rotate Method
Description
Rotates the object selected in the specified picture by 90° clockwise.
WinCC: Scripting (VBS, ANSI-C, VBA)
1878 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
syntax
Expression.Rotate()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
Example:
In the following example two objects will be inserted in the active picture and then grouped.
The group object will then be rotated once:
Sub RotateGroupObject()
'VBA180
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objGroup As HMIGroup
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("sRectangle", "HMIRectangle")
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
With objRectangle
.Top = 30
.Left = 30
.Width = 80
.Height = 40
.Selected = True
End With
With objCircle
.Top = 30
.Left = 30
.BackColor = RGB(255, 255, 255)
.Selected = True
End With
MsgBox "Objects selected!"
Set objGroup = ActiveDocument.Selection.CreateGroup
MsgBox "Group-object created."
objGroup.Selected = True
ActiveDocument.Selection.Rotate
End Sub
See also
VBA Reference (Page 1752)
SelectedObjects object (Listing) (Page 2063)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1879
VBA for Automated Configuration
3.6 VBA Reference
SameHeight Method
Description
Sets the "Height" property for all selected objects in the specified picture to the smallest
available value.
syntax
Expression.SameHeight()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
1880 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example three objects of different sizes will be inserted in the active picture.
Then all objects will be selected and set to the same height:
Sub ApplySameHeightToSelectedObjects()
'VBA181
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objEllipse As HMIEllipse
Dim objGroup As HMIGroup
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("sRectangle", "HMIRectangle")
Set objEllipse = ActiveDocument.HMIObjects.AddHMIObject("sEllipse", "HMIEllipse")
With objCircle
.Top = 30
.Left = 0
.Height = 15
.Selected = True
End With
With objRectangle
.Top = 80
.Left = 42
.Height = 40
.Selected = True
End With
With objEllipse
.Top = 48
.Left = 162
.Width = 40
.Height = 120
.BackColor = RGB(255, 0, 0)
.Selected = True
End With
MsgBox "Objects selected!"
ActiveDocument.Selection.SameHeight
End Sub
See also
Height Property (Page 2276)
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1881
VBA for Automated Configuration
3.6 VBA Reference
SameWidth Method
Description
Sets the "Width" property for all selected objects in the specified picture to the smallest
available value.
syntax
Expression.SameWidth()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
1882 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example three objects of different sizes will be inserted in the active picture.
Then all objects will be selected and set to the same width:
Sub ApplySameWidthToSelectedObjects()
'VBA182
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objEllipse As HMIEllipse
Dim objGroup As HMIGroup
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("sRectangle", "HMIRectangle")
Set objEllipse = ActiveDocument.HMIObjects.AddHMIObject("sEllipse", "HMIEllipse")
With objCircle
.Top = 30
.Left = 0
.Width = 15
.Selected = True
End With
With objRectangle
.Top = 80
.Left = 42
.Width = 40
.Selected = True
End With
With objEllipse
.Top = 48
.Left = 162
.Width = 120
.BackColor = RGB(255, 0, 0)
.Selected = True
End With
MsgBox "Objects selected!"
ActiveDocument.Selection.SameWidth
End Sub
See also
Width Property (Page 2556)
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
SameWidthAndHeight Method
Description
Sets the "Height" and "Width" properties for all selected objects in the specified picture to the
smallest available value.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1883
VBA for Automated Configuration
3.6 VBA Reference
syntax
Expression.SameWidthAndHeight()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
Example:
In the following example three objects of different sizes will be inserted in the active picture.
Then all objects will be selected and set to the same height:
Sub ApplySameWidthAndHeightToSelectedObjects()
'VBA183
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objEllipse As HMIEllipse
Dim objGroup As HMIGroup
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("sRectangle", "HMIRectangle")
Set objEllipse = ActiveDocument.HMIObjects.AddHMIObject("sEllipse", "HMIEllipse")
With objCircle
.Top = 30
.Left = 0
.Height = 15
.Selected = True
End With
With objRectangle
.Top = 80
.Left = 42
.Width = 25
.Height = 40
.Selected = True
End With
With objEllipse
.Top = 48
.Left = 162
.Width = 40
.Height = 120
.BackColor = RGB(255, 0, 0)
.Selected = True
End With
MsgBox "Objects selected!"
ActiveDocument.Selection.SameWidthAndHeight
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1884 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
Width Property (Page 2556)
Height Property (Page 2276)
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
Save Method
Description
Saves the specified picture under its current name.
syntax
Expression.Save()
Expression
Necessary. An expression or element which returns an object of the "Document" type.
Parameters
--
Example:
In the following example the active picture in the Graphics Designer will be saved:
Sub SaveDocument()
'VBA184
ActiveDocument.Save
End Sub
See also
ActiveDocument Property (Page 2116)
Document Object (Page 1954)
VBA Reference (Page 1752)
SaveAll Method
Description
Saves all the open pictures in the Graphics Designer under their current names.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1885
VBA for Automated Configuration
3.6 VBA Reference
syntax
Expression.SaveAll()
Expression
Necessary. An expression or element which returns an object of the "Documents" type.
Parameters
--
Example:
In the following example all open pictures in the Graphics Designer are saved:
Sub SaveAllDocuments()
'VBA185
Application.Documents.SaveAll
End Sub
See also
Documents Object (Listing) (Page 1957)
VBA Reference (Page 1752)
SaveAs Method
Description
Saves the specified picture under a new name.
If a previously existing picture is to be overwritten, it must be ascertained prior to the SaveAs
method call that this picture is permitted to be overwritten. You must inquire the
LockedByCreatorID property of the picture to be overwritten to do so. Otherwise an error will
be triggered in VBA.
syntax
Expression.SaveAs(FileName)
Expression
Necessary. An expression or element which returns an object of the "Document" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
1886 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameters
Parameter (Data Type) Description
FileName (String) The file name under which the picture is to be
saved.
Example:
In the following example the active picture will be saved under the name "Test2.PDL":
Sub SaveDocumentAs()
'VBA186
ActiveDocument.SaveAs ("Test2.PDL")
End Sub
See also
LockedByCreatorID Property (Page 2319)
ActiveDocument Property (Page 2116)
Document Object (Page 1954)
VBA Reference (Page 1752)
SaveDefaultConfig Method
Description
Saves the default settings for objects to a PDD file. The file is saved to the "GraCS" folder of
the current project.
syntax
Expression.SaveDefaultConfig(FileName)
Expression
Necessary. An expression or element which returns an object of the "Application" type.
Parameters
Parameter (Data Type) Description
FileName (String) The name of the PDD file.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1887
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the default settings for objects are saved to the file "Test.PDD".
Sub SaveDefaultConfig()
'VBA187
Application.SaveDefaultConfig ("Test.PDD")
End Sub
See also
Application Object (Page 1915)
LoadDefaultConfig Method (Page 1869)
VBA Reference (Page 1752)
SelectAll Method
Description
Selects all the objects in the specified picture and adds them to the selection listing.
syntax
Expression.SelectAll()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
1888 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example three objects will be inserted in the active picture and then selected.
Sub SelectAllObjectsInActiveDocument()
'VBA188
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objEllipse As HMIEllipse
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("sRectangle", "HMIRectangle")
Set objEllipse = ActiveDocument.HMIObjects.AddHMIObject("sEllipse", "HMIEllipse")
With objCircle
.Top = 30
.Left = 0
.Height = 15
End With
With objRectangle
.Top = 80
.Left = 42
.Width = 25
.Height = 40
End With
With objEllipse
.Top = 48
.Left = 162
.Width = 40
.Height = 120
.BackColor = RGB(255, 0, 0)
End With
ActiveDocument.Selection.SelectAll
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
SendToBack Method
Description
Sends the selected objects right to the back within their current layer.
Note
If the "SendToBack" method is used, the sequence of HMI objects can change in the
HMIObjects listing.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1889
VBA for Automated Configuration
3.6 VBA Reference
Syntax
Expression.SendToBack()
Expression
Necessary. An expression or element which returns an object of the "Selection" type.
Parameters
--
Example:
In the following example two objects are inserted in the active picture. The object inserted first
is then sent to the back:
Sub SendObjectToBack()
'VBA197
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("sRectangle", "HMIRectangle")
With objCircle
.Top = 40
.Left = 40
.Selected = False
End With
With objRectangle
.Top = 40
.Left = 40
.Width = 100
.Height = 50
.BackColor = RGB(255, 0, 255)
.Selected = True
End With
MsgBox "The objects circle and rectangle are created" & vbCrLf & "Only the rectangle is
selected!"
ActiveDocument.Selection.SendToBack
MsgBox "The selection is moved to the back."
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
1890 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
SetCSLayerVisible Method
Description
Shows or hides the specified CS layer.
syntax
Expression.SetCSLayerVisible(Index, Val)
Expression
Necessary. An expression or element which returns an object of the "View" type.
Parameters
Parameter (Data Type) Description
Index (Variant) Defines the CS layer that is going to be shown or
hidden. Value range from 1 up to 32.
Val (Boolean) TRUE if the specified CS layer is intended to be
visible.
Example:
In the following example the second CS layer in the copy of the active picture is hidden (i.e.
made invisible):
Sub SetCSLayerVisible()
'VBA189
Dim objView As HMIView
Set objView = ActiveDocument.Views.Add
objView.Activate
objView.SetCSLayerVisible 2, False
End Sub
See also
Document Object (Page 1954)
VBA Reference (Page 1752)
Editing Layers with VBA (Page 1666)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1891
VBA for Automated Configuration
3.6 VBA Reference
SetOpenContext method
Description
The SetOpenContext method sets the password. Password-protected process pictures can
then be opened.
Syntax
Expression.SetOpenContext (Password)
Expression
Required. An expression or element which returns an object of the "Documents" type.
Parameter
Parameter (Data Type) Description
Password (String) Password of the available picture.
Example
Several pictures ("A.pdl", "B.pdl" und "C.pdl") are opened in the following example using the
same password string "Test123". Enter the password for the pictures to open these. Terminate
the SetOpenContext method with an empty string "" to prevent further access to the password.
Sub OpenProtectedPicture()
'VBA853
Documents.SetOpenContext ("Test123")
Documents.Open ("A.pdl")
Documents.Open ("B.pdl")
Documents.Open ("C.pdl")
Documents.SetOpenContext ("")
End Sub
SetDeclutterObjectSize Method
Description
Specifies the size area for fading in and out of objects in the specified picture. If height and
width of the object are outside the specified size area, the objects are faded out.
The "ObjectSizeDecluttering" property must be set to TRUE.
syntax
Expression.SetDeclutterObjectSize(Min, Max)
WinCC: Scripting (VBS, ANSI-C, VBA)
1892 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Expression
Necessary. An expression or element which returns an object of the "Document" type.
Parameters
Parameter (Data Type) Description
Min (Long) Lower size range in pixels.
Max (Long) Upper size range in pixels.
Example:
In the following example the settings for the lowest layer are configured in the active picture:
Sub ConfigureSettingsOfLayer()
'VBA190
Dim objLayer As HMILayer
Set objLayer = ActiveDocument.Layers(1)
With objLayer
'Configure "Layer 0"
.MinZoom = 10
.MaxZoom = 100
.Name = "Configured with VBA"
End With
'Define decluttering of objects:
With ActiveDocument
.LayerDecluttering = True
.ObjectSizeDecluttering = True
.SetDeclutterObjectSize 50, 100
End With
End Sub
See also
ObjectSizeDecluttering Property (Page 2355)
Document Object (Page 1954)
VBA Reference (Page 1752)
SetRTLayerVisible Method
Description
Shows or hides the specified RT layer.
syntax
Expression.SetRTLayerVisible(Index, Val)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1893
VBA for Automated Configuration
3.6 VBA Reference
Expression
Necessary. An expression or element which returns an object of the "Document" type.
Parameters
Parameter (Data Type) Description
Index (Variant) Defines the RT layer that is going to be shown or
hidden. Value range from 1 to 32.
Val (Boolean) TRUE if the specified RT layer is intended to be
visible.
Example:
In the following example the first RT layer in the active picture will be made visible:
Sub SetRTLayerVisibleWithVBA()
'VBA191
ActiveDocument.SetRTLayerVisible 1, False
End Sub
See also
Document Object (Page 1954)
VBA Reference (Page 1752)
Editing Layers with VBA (Page 1666)
ShowPropertiesDialog Method
Description
Opens the "Object Properties" dialog.
syntax
Expression.ShowPropertiesDialog()
Expression
Necessary. An expression or element which returns an object of the "Application" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
1894 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the "Object Properties" dialog is opened:
Sub ShowPropertiesDialog()
'VBA192
Application.ShowPropertiesDialog
End Sub
See also
Application Object (Page 1915)
VBA Reference (Page 1752)
ShowSymbolLibraryDialog Method
Description
Opens the Components Library.
syntax
Expression.ShowSymbolLibraryDialog()
Expression
Necessary. An expression or element which returns an object of the "Application" type.
Parameters
--
Example:
In the following example the Components Library is opened:
Sub ShowSymbolLibraryDialog()
'VBA193
Application.ShowSymbolLibraryDialog
End Sub
See also
Application Object (Page 1915)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1895
VBA for Automated Configuration
3.6 VBA Reference
ShowTagDialog Method
Description
Opens the "Tags" dialog.
syntax
Expression.ShowTagDialog()
Expression
Necessary. An expression or element which returns an object of the "Application" type.
Parameters
--
Example:
In the following example the "Tags" dialog is opened:
Sub ShowTagDialog()
'VBA194
Application.ShowTagDialog
End Sub
See also
Application Object (Page 1915)
VBA Reference (Page 1752)
TileWindowsHorizontally Method
Description
Arranges all open pictures in the Graphics Designer so that they are tiled horizontally.
syntax
Expression.Methode()
Expression
Necessary. An expression or element which returns an object of the "Application" type.
WinCC: Scripting (VBS, ANSI-C, VBA)
1896 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameters
--
Example:
In the following example all open pictures in the Graphics Designer are tiled horizontally. For
this example to work, you must have opened a number of pictures in the Graphics Designer:
Sub TileWindowsHorizontally()
'VBA195
Application.TileWindowsHorizontally
End Sub
See also
Application Object (Page 1915)
VBA Reference (Page 1752)
TileWindowsVertically Method
Description
Arranges all open pictures in the Graphics Designer so that they are tiled vertically.
syntax
Expression.Methode()
Expression
Necessary. An expression or element which returns an object of the "Application" type.
Parameters
--
Example:
In the following example all open pictures in the Graphics Designer are tiled vertically. For this
example to work, you must have opened a number of pictures in the Graphics Designer:
Sub TileWindowsVertically()
'VBA196
Application.TileWindowsVertically
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1897
VBA for Automated Configuration
3.6 VBA Reference
See also
Application Object (Page 1915)
VBA Reference (Page 1752)
TransformDisplayCoordinate method
Description
Is used internally for PowerCC.
TransformPixelCoordinate method
Description
Is used internally for PowerCC.
Ungroup Method
Description
Ungroups a group object. The objects remain intact.
syntax
Expression.Ungroup(Parameter)
Expression
Necessary. An expression or element which returns an object of the "Group" type.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
1898 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example three objects are created in the current picture and a group object is
then created from them: The group object is then moved and ungrouped.
Sub DissolveGroup()
'VBA199
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objEllipse As HMIEllipse
Dim objGroup As HMIGroup
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("sRectangle", "HMIRectangle")
Set objEllipse = ActiveDocument.HMIObjects.AddHMIObject("sEllipse", "HMIEllipse")
With objCircle
.Top = 30
.Left = 0
.Selected = True
End With
With objRectangle
.Top = 80
.Left = 42
.Selected = True
End With
With objEllipse
.Top = 48
.Left = 162
.Width = 40
.BackColor = RGB(255, 0, 0)
.Selected = True
End With
MsgBox "Objects selected!"
Set objGroup = ActiveDocument.Selection.CreateGroup
MsgBox "Group-object is created."
With objGroup
.Left = 120
.Top = 300
MsgBox "Group-object is moved."
.UnGroup
MsgBox "Group is dissolved."
End With
End Sub
See also
Group Object (Page 1983)
CreateGroup Method (Page 1835)
VBA Reference (Page 1752)
Group Objects (Page 1682)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1899
VBA for Automated Configuration
3.6 VBA Reference
3.6.1.7 Objects and Lists
0-9, A-C
3DBarGraph Object
Description
Represents the "3D Bar" object. The 3DBarGraph object is an element of the following listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
VBA Object Name
HMI3DBarGraph
Application
Use the Add method to create a new "3D Bar" object in a picture:
Sub Add3DBarGraph()
'VBA200
Dim obj3DBarGraph As HMI3DBarGraph
Set obj3DBarGraph = ActiveDocument.HMIObjects.AddHMIObject("3DBar", "HMI3DBarGraph")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where "Index" in this
case identifies the object by name:
Sub Edit3DBarGraph()
'VBA201
Dim obj3DBarGraph As HMI3DBarGraph
Set obj3DBarGraph = ActiveDocument.HMIObjects("3DBar")
obj3DBarGraph.BorderColor = RGB(255, 0, 0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1900 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection(Index)" to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA202
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
Object properties
The 3D Bar object possesses the following properties:
● AngleAlpha
● AngleBeta
● Application
● Axe
● BackColor
● Background
● BarDepth
● BarHeight
● BarWidth
● BaseX
● BaseY
● BorderColor
● BorderStyle
● BorderWidth
● Direction
● FillColor
● FillStyle
● GlobalColorScheme
● GlobalShadow
● GroupParent
● Height
● Layer
● Layer00Checked ... Layer10Checked
● Layer00Color ... Layer10Color
● Layer00FillColor ... Layer10FillColor
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1901
VBA for Automated Configuration
3.6 VBA Reference
● Layer00FillStyle ... Layer10FillStyle
● Layer00Value ... Layer10Value
● Left
● LightEffect
● Max.
● Min.
● ObjectName
● Operation
● Parent
● PasswordLevel
● PredefinedAngles
● Process
● Selected
● ShowBadTagState
● TabOrderAlpha
● TabOrderSwitch
● ToolTipText
● Top
● Transparency
● Type
● Visible
● Width
● ZeroPointValue
See also
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
ZeroPointValue Property (Page 2561)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
WinCC: Scripting (VBS, ANSI-C, VBA)
1902 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
ToolTipText Property (Page 2448)
Process Property (Page 2387)
PredefinedAngels Property (Page 2385)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Name Property (Page 2349)
Min Property (Page 2345)
Max Property (Page 2327)
LightEffect Property (Page 2312)
Left Property (Page 2311)
Layer Property (Page 2299)
Layer00..10Value property (Page 2302)
Height Property (Page 2276)
Direction Property (Page 2220)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderColor Property (Page 2160)
BaseY Property (Page 2154)
BaseX Property (Page 2153)
BarWidth Property (Page 2149)
BarHeight Property (Page 2149)
BarDepth Property (Page 2148)
Background Property (Page 2147)
Axe Property (Page 2136)
AngleBeta Property (Page 2129)
AngleAlpha Property (Page 2128)
Layer00..10Checked property (Page 2299)
Layer00..10Color property (Page 2300)
Application Property (Page 2129)
BackColor Property (Page 2139)
FillColor Property (Page 2238)
FillStyle Property (Page 2242)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1903
VBA for Automated Configuration
3.6 VBA Reference
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
Layer00..10FillColor property (Page 2301)
Layer00..10FillStyle property (Page 2301)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
Actions Object (Listing)
Description
Displays a listing of the actions that are configured on an event.
VBA Object Name
HMIActions
WinCC: Scripting (VBS, ANSI-C, VBA)
1904 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the AddAction method to configure one or more actions on an event. In this example a
button and a circle will be inserted in the active picture. In runtime the radius of the circle
enlarges every time you click the button:
Sub CreateVBActionToClickedEvent()
'VBA203
Dim objButton As HMIButton
Dim objCircle As HMICircle
Dim objVBScript As HMIScriptInfo
Dim strVBCode As String
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_VB", "HMICircle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objCircle
.Top = 100
.Left = 100
.BackColor = RGB(255, 0, 0)
End With
With objButton
.Top = 10
.Left = 10
.Text = "Increase Radius"
End With
'define event and assign sourcecode to it:
Set objVBScript = objButton.Events(1).Actions.AddAction(hmiActionCreationTypeVBScript)
strVBCode = "Dim myCircle" & vbCrLf & "Set myCircle = "
strVBCode = strVBCode & "HMIRuntime.ActiveScreen.ScreenItems(""Circle_VB"")"
strVBCode = strVBCode & vbCrLf & "myCircle.Radius = myCircle.Radius + 5"
With objVBScript
.SourceCode = strVBCode
End With
End Sub
See also
AddAction Method (Page 1801)
Configuring Event-Driven Actions with VBA (Page 1707)
Parent Property (Page 2364)
Item Property (Page 2289)
Count Property (Page 2208)
Application Property (Page 2129)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1905
VBA for Automated Configuration
3.6 VBA Reference
ActiveXControl Object
Description
Represents the ActiveX Control object. The ActiveXControl object is an element of the following
listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
VBA Object Name
HMIActiveXControl
Usage
Use the AddActiveXControl method to insert an ActiveX Control in a picture, for instance. In
the following example the ActiveX Control "WinCC Gauge Control" is inserted in the active
picture.
Sub AddActiveXControl()
'VBA204
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
ServerName Property (Page 2418)
AddActiveXControl Method (Page 1802)
VBA Reference (Page 1752)
ActiveX controls (Page 1679)
ProgID Property (Page 2389)
WinCC: Scripting (VBS, ANSI-C, VBA)
1906 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
Height Property (Page 2276)
Layer Property (Page 2299)
LDTooltipTexts Property (Page 2309)
Left Property (Page 2311)
ObjectName Property (Page 2353)
Operation Property (Page 2358)
Parent Property (Page 2364)
PasswordLevel Property (Page 2367)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
ToolTipText Property (Page 2448)
Top Property (Page 2449)
Transparency property (Page 2450)
Type Property (Page 2453)
Visible Property (Page 2553)
Width Property (Page 2556)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
AdvancedAnalogDisplay object
Description
Represents the "Analog Display (Advanced)" object. The "AdvancedAnalogDisplay" object is
an element of the following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1907
VBA for Automated Configuration
3.6 VBA Reference
VBA Object Name
HMIAdvancedAnalogDisplay
Application
Use the AddHMIObject method to create a new "Analog Display (Advanced)" object in a
picture:
Sub AddAdvancedAnalogDisplay()
'VBA857
Dim objAdvancedAnalogDisplay As HMIAdvancedAnalogDisplay
Set objAdvancedAnalogDisplay = ActiveDocument.HMIObjects.AddHMIObject("Analogdisplay1",
"HMIAdvancedAnalogDisplay")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where "Index" in this
case identifies the object by name:
Sub EditAdvancedAnalogDisplay()
'VBA858
Dim objAdvancedAnalogDisplay As HMIAdvancedAnalogDisplay
Set objAdvancedAnalogDisplay = ActiveDocument.HMIObjects("Analogdisplay1")
objAdvancedAnalogDisplay.BackColor_Simulation = RGB(255, 0, 0)
End Sub
See also
AlarmGoneVisible property (Page 2123)
AlignmentLeft Property (Page 2125)
AlignmentTop Property (Page 2126)
Application Property (Page 2129)
BackColor Property (Page 2139)
BackColor_Alarm.._Warning property (Page 2141)
BackFillColor property (Page 2143)
BackFillColor_OK property (Page 2143)
BackFillColor_Simulation property (Page 2144)
BackFillStyle property (Page 2144)
BackFillStyle_OK property (Page 2144)
BackFillStyle_Simulation property (Page 2144)
BorderColor Property (Page 2160)
BorderWidth Property (Page 2168)
UseGlobalAlarmClasses property (Page 2468)
WinCC: Scripting (VBS, ANSI-C, VBA)
1908 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
CBackColorOff..ColorOn property (Page 2176)
CBackFlash property (Page 2177)
CollectValue property (Page 2189)
CornerRadius property (Page 2208)
CQBackColorOff..ColorOn property (Page 2210)
CQBackFlash property (Page 2210)
CQTextColorOff..ColorOn property (Page 2210)
CTextColorOff..ColorOn property (Page 2211)
CQTextFlash property (Page 2211)
CTextFlash property (Page 2211)
EventQuitMask property (Page 2229)
EnableFlashing property (Page 2228)
Events Property (Page 2230)
FontBold Property (Page 2262)
FontItalic Property (Page 2263)
FontName Property (Page 2263)
FontSize Property (Page 2264)
FontUnderline Property (Page 2265)
ForeColor Property (Page 2266)
Format property (Page 2269)
ForeColor_Alarm.._Warning property (Page 2267)
GlobalShadow property (Page 2270)
GNQBackColorOff..ColorOn property (Page 2270)
GNQBackFlash property (Page 2271)
GNQTextColorOff..ColorOn property (Page 2271)
GNQTextFlash property (Page 2271)
GroupParent Property (Page 2275)
Height Property (Page 2276)
Layer Property (Page 2299)
LDTooltipTexts Property (Page 2309)
Left Property (Page 2311)
MessageClass Property (Page 2345)
ObjectName Property (Page 2353)
Operation Property (Page 2358)
Orientation Property (Page 2361)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1909
VBA for Automated Configuration
3.6 VBA Reference
OutputValue property (Page 2364)
PaintColor_QualityCodeBad property (Page 2364)
PaintColor_QualityCodeUnCertain property (Page 2364)
Parent Property (Page 2364)
PasswordLevel Property (Page 2367)
PrioAlarm..Warning property (Page 2387)
PrioBit16..31 property (Page 2387)
Properties Property (Page 2391)
Relevant Property (Page 2401)
Selected Property (Page 2415)
ServerName Property (Page 2418)
ShowBadTagState property (Page 2421)
Simulation property (Page 2421)
SimulationBit property (Page 2421)
Tag property (Graphic Object Update Wizard) (Page 2436)
tagname property (Page 2437)
tagtype property (Page 2439)
trend property (Page 2451)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
ToolTipText Property (Page 2448)
Top Property (Page 2449)
Transparency property (Page 2450)
Type Property (Page 2453)
UseValueText property (Page 2472)
Visible Property (Page 2553)
Width Property (Page 2556)
ConnectionPoints property (Page 2205)
FlashState property (Page 2258)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
1910 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
AdvancedStateDisplay object
Description
Represents the "State Display (Advanced)" object. The "AdvancedStateDisplay" object is an
element of the following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIAdvancedStateDisplay
Application
Use the AddHMIObject method to create a new "State Display (Advanced)" object in a picture:
Sub AddAdvancedStateDisplay()
'VBA859
Dim objAdvancedStateDisplay As HMIAdvancedStateDisplay
Set objAdvancedStateDisplay = ActiveDocument.HMIObjects.AddHMIObject("Statedisplay1",
"HMIAdvancedStateDisplay")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where "Index" in this
case identifies the object by name:
Sub EditAdvancedStateDisplay()
'VBA860
Dim objAdvancedStateDisplay As HMIAdvancedStateDisplay
Set objAdvancedStateDisplay = ActiveDocument.HMIObjects("Statedisplay1")
objAdvancedStateDisplay.PaintColor_QualityCodeBad = RGB(255, 0, 0)
End Sub
See also
UseGlobalAlarmClasses property (Page 2468)
EventQuitMask property (Page 2229)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Tag property (Graphic Object Update Wizard) (Page 2436)
tagname property (Page 2437)
tagtype property (Page 2439)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1911
VBA for Automated Configuration
3.6 VBA Reference
ToolTipText Property (Page 2448)
Top Property (Page 2449)
Transparency property (Page 2450)
trend property (Page 2451)
Type Property (Page 2453)
UseEventState property (Page 2467)
Visible Property (Page 2553)
Width Property (Page 2556)
Selected Property (Page 2415)
ServerName Property (Page 2418)
ShowBadTagState property (Page 2421)
Properties Property (Page 2391)
Relevant Property (Page 2401)
Process property (Page 2388)
Process1 property (Page 2388)
Process2 property (Page 2389)
Process3 property (Page 2389)
PaintColor_QualityCodeBad property (Page 2364)
PaintColor_QualityCodeUnCertain property (Page 2364)
Parent Property (Page 2364)
PasswordLevel Property (Page 2367)
PrioAlarm..Warning property (Page 2387)
PrioBit16..31 property (Page 2387)
MaxIndex property (Page 2328)
ObjectName Property (Page 2353)
Operation Property (Page 2358)
Layer Property (Page 2299)
LDTooltipTexts Property (Page 2309)
Left Property (Page 2311)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
Height Property (Page 2276)
Index Property (Page 2283)
Events Property (Page 2230)
CollectValue property (Page 2189)
WinCC: Scripting (VBS, ANSI-C, VBA)
1912 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
AlarmGoneVisible property (Page 2123)
Application Property (Page 2129)
BasePicture property (Page 2152)
BitPosition0..3 property (Page 2156)
BitSelect0..3 property (Page 2157)
ConnectionPoints property (Page 2205)
FlashPictureState property (Page 2251)
NibbleSelect property (Page 2351)
ConnectorObjects property (Page 2206)
AnalogResultInfo Object
Description
Displays an analog value range and associated property value in the Dynamic dialog. The
AnalogResultInfo object is an element of the AnalogResultInfos listing:
VBA Object Name
HMIAnalogResultInfo
Usage
Use the AnalogResultInfo object to return an individual value range and property value. For a
detailed example, please refer to "AnalogResultInfos Object (Listing)" in this documentation.
See also
AnalogResultInfos Object (Listing) (Page 1914)
Delete Method (Page 1837)
Value Property (Page 2472)
RangeTo Property (Page 2399)
Parent Property (Page 2364)
Application Property (Page 2129)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1913
VBA for Automated Configuration
3.6 VBA Reference
AnalogResultInfos Object (Listing)
Description
A listing of AnalogResultInfo objects that contain all the analog value ranges and the associated
property value in the Dynamic dialog.
VBA Object Name
HMIAnalogResultInfos
Usage
Use the Add method to add a new value range in the Dynamic dialog. In the following example
the radius of a circle will be dynamically configured using the Dynamic dialog, a tag name will
be assigned and three analog value ranges will be created:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA206
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.Add 50, 40
.AnalogResultInfos.Add 100, 80
.AnalogResultInfos.ElseCase = 100
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1914 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use AnalogResultInfos to return the AnalogResultInfos listing. In this example the value ranges
created in the above example will be output:
Sub ShowAnalogResultInfosOfCircleRadius()
'VBA207
Dim colAResultInfos As HMIAnalogResultInfos
Dim objAResultInfo As HMIAnalogResultInfo
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
Dim iAnswer As Integer
Dim varRange As Variant
Dim varValue As Variant
Set objCircle = ActiveDocument.HMIObjects("Circle_A")
Set objDynDialog = objCircle.Radius.Dynamic
Set colAResultInfos = objDynDialog.AnalogResultInfos
For Each objAResultInfo In colAResultInfos
varRange = objAResultInfo.RangeTo
varValue = objAResultInfo.value
iAnswer = MsgBox("Ranges of values from Circle_A-Radius:" & vbCrLf & "Range of value to: "
& varRange & vbCrLf & "Value of property: " & varValue, vbOKCancel)
If vbCancel = iAnswer Then Exit For
Next objAResultInfo
End Sub
See also
Add Method (AnalogResultInfos Listing) (Page 1793)
Parent Property (Page 2364)
Item Property (Page 2289)
ElseCase Property (Page 2226)
Count Property (Page 2208)
Application Property (Page 2129)
Application Object
Description
Represents the Graphics Designer editor. The Application object contains properties and
methods that return objects from the top layer. For example ActiveDocument returns a
Document object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1915
VBA for Automated Configuration
3.6 VBA Reference
VBA Object Name
HMIApplication
Usage
Use Application to return the Application object. In the following example the application
version is output:
Sub ShowApplicationVersion()
'VBA208
MsgBox Application.Version
End Sub
See also
ShowTagDialog Method (Page 1896)
CurrentDesktopLanguage Property (Page 2212)
TileWindowsVertically Method (Page 1897)
TileWindowsHorizontally Method (Page 1896)
ShowSymbolLibraryDialog Method (Page 1895)
ShowPropertiesDialog Method (Page 1894)
SaveDefaultConfig Method (Page 1887)
LoadDefaultConfig Method (Page 1869)
CascadeWindows Method (Page 1820)
ArrangeMinimizedWindows Method (Page 1817)
Activate Method (Page 1792)
VBA Reference (Page 1752)
WindowState Property (Page 2560)
Visible Property (Page 2553)
Version Property (Page 2552)
VBE Property (Page 2552)
VBAVersion Property (Page 2552)
SymbolLibraries Property (Page 2430)
ProjectType Property (Page 2391)
ProjectName Property (Page 2390)
ProfileName Property (Page 2389)
Parent Property (Page 2364)
Name Property (Page 2349)
WinCC: Scripting (VBS, ANSI-C, VBA)
1916 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
IsConnectedToProject Property (Page 2286)
Documents Property (Page 2224)
DefaultHMIObjects Property (Page 2217)
CustomToolbars Property (Page 2214)
CustomMenus Property (Page 2214)
CurrentDataLanguage Property (Page 2211)
ConfigurationFileName Property (Page 2205)
AvailableDataLanguages Property (Page 2135)
ApplicationDataPath Property (Page 2130)
Application Property (Page 2129)
ActiveDocument Property (Page 2116)
CommandLine Property (Page 2203)
DisableVBAEvents Property (Page 2221)
AddIns property (Page 2122)
CopyPasteSettings property (Page 2208)
DisablePerformanceWarnings property (Page 2220)
ApplicationWindow Object
Description
Represents the "Application Window" object. The ApplicationWindow object is an element of
the following listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1917
VBA for Automated Configuration
3.6 VBA Reference
VBA Object Name
HMIApplicationWindow
Usage
Use the Add method to create a new "Application Window" object in a picture:
Sub AddApplicationWindow()
'VBA209
Dim objApplicationWindow As HMIApplicationWindow
Set objApplicationWindow = ActiveDocument.HMIObjects.AddHMIObject("AppWindow",
"HMIApplicationWindow")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditApplicationWindow()
'VBA210
Dim objApplicationWindow As HMIApplicationWindow
Set objApplicationWindow = ActiveDocument.HMIObjects("AppWindow")
objApplicationWindow.Sizeable = True
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA211
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
Caption Property (Page 2175)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
WindowBorder Property (Page 2558)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
WinCC: Scripting (VBS, ANSI-C, VBA)
1918 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Sizeable Property (Page 2423)
OnTop Property (Page 2357)
Name Property (Page 2349)
Moveable Property (Page 2348)
MaximizeButton Property (Page 2328)
Left Property (Page 2311)
Layer Property (Page 2299)
Height Property (Page 2276)
CloseButton Property (Page 2189)
Application Property (Page 2129)
Events Property (Page 2230)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Operation Property (Page 2358)
Parent Property (Page 2364)
PasswordLevel Property (Page 2367)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
ToolTipText Property (Page 2448)
ConnectionPoints property (Page 2205)
Template property (Page 2439)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1919
VBA for Automated Configuration
3.6 VBA Reference
BarGraph Object
Description
Represents the "Bar" object. The BarGraph object is an element of the following listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default settings of property values of all Standard,
Windows and Smart objects.
VBA Object Name
HMIBarGraph
Application
Use the Add method to create a new "Bar" object in a picture:
Sub AddBarGraph()
'VBA212
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where "Index" in this
case identifies the object by name:
Sub EditBarGraph()
'VBA213
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects("Bar1")
objBarGraph.BorderColor = RGB(255, 0, 0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1920 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection(Index)" to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA214
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
TypeWarningHigh Property (Page 2461)
Max Property (Page 2327)
FillColor Property (Page 2238)
BorderStyle Property (Page 2167)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
ZeroPointValue Property (Page 2561)
ZeroPoint Property (Page 2561)
Width Property (Page 2556)
WarningLow Property (Page 2555)
WarningHigh Property (Page 2554)
Visible Property (Page 2553)
TypeWarningLow Property (Page 2462)
TypeToleranceLow Property (Page 2460)
TypeToleranceHigh Property (Page 2459)
TypeLimitLow4 Property (Page 2457)
TypeLimitHigh4 Property (Page 2455)
TypeAlarmLow Property (Page 2455)
TypeAlarmHigh Property (Page 2454)
Trend Property (Page 2451)
TrendColor Property (Page 2452)
Top Property (Page 2449)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1921
VBA for Automated Configuration
3.6 VBA Reference
ToolTipText Property (Page 2448)
ToleranceLow Property (Page 2445)
ToleranceHigh Property (Page 2444)
ScalingType Property (Page 2408)
Scaling Property (Page 2407)
ScaleTicks Property (Page 2407)
ScaleColor Property (Page 2406)
RightComma Property (Page 2402)
Process Property (Page 2387)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Name Property (Page 2349)
Min Property (Page 2345)
Marker Property (Page 2327)
LongStrokesTextEach Property (Page 2325)
LongStrokesSize Property (Page 2325)
LongStrokesOnly Property (Page 2324)
LongStrokesBold Property (Page 2323)
LimitLow4 Property (Page 2314)
LimitHigh4 Property (Page 2312)
Left Property (Page 2311)
LeftComma Property (Page 2311)
Layer Property (Page 2299)
HysteresisRange Property (Page 2281)
Hysteresis Property (Page 2280)
Height Property (Page 2276)
FontSize Property (Page 2264)
FontName Property (Page 2263)
FontBold Property (Page 2262)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
Exponent Property (Page 2233)
WinCC: Scripting (VBS, ANSI-C, VBA)
1922 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Direction Property (Page 2220)
ColorWarningLow Property (Page 2200)
ColorWarningHigh Property (Page 2199)
ColorToleranceLow Property (Page 2197)
ColorToleranceHigh Property (Page 2196)
ColorLimitLow4 Property (Page 2194)
ColorLimitHigh4 Property (Page 2193)
ColorChangeType Property (Page 2192)
ColorAlarmLow Property (Page 2190)
ColorAlarmHigh Property (Page 2189)
CheckWarningLow Property (Page 2186)
CheckWarningHigh Property (Page 2185)
CheckToleranceLow Property (Page 2184)
CheckToleranceHigh Property (Page 2183)
CheckLimitLow4 Property (Page 2181)
CheckLimitHigh4 Property (Page 2179)
CheckAlarmLow Property (Page 2178)
CheckAlarmHigh Property (Page 2177)
BorderWidth Property (Page 2168)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
BackColor3 Property (Page 2141)
BackColor2 Property (Page 2140)
AxisSection Property (Page 2137)
Average Property (Page 2136)
Alignment Property (Page 2125)
AlarmLow Property (Page 2124)
AlarmHigh Property (Page 2123)
FillStyle2 Property (Page 2244)
Application Property (Page 2129)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1923
VBA for Automated Configuration
3.6 VBA Reference
Events Property (Page 2230)
ObjectName Property (Page 2353)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
BinaryResultInfo Object
Description
Displays both the binary (boolean) value ranges and the associated property values in the
Dynamic dialog.
VBA Object Name
HMIBinaryResultInfo
Usage
Use BinaryResultInfo to return the BinaryResultInfo object. In the following example the radius
of a circle will be dynamically configured using the Dynamic dialog, a tag name will be assigned
and the associated property values will be assigned to both the binary value ranges:
Sub AddDynamicDialogToCircleRadiusTypeBinary()
'VBA215
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_C", "HMICircle")
Set objDynDialog = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'NewDynamic1'")
With objDynDialog
.ResultType = hmiResultTypeBool
.BinaryResultInfo.NegativeValue = 20
.BinaryResultInfo.PositiveValue = 40
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1924 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
VBA Reference (Page 1752)
PositiveValue Property (Page 2384)
Parent Property (Page 2364)
NegativeValue Property (Page 2350)
Application Property (Page 2129)
BitResultInfo Object
Description
Displays both the value ranges for bit set/not set and the associated property values in the
Dynamic dialog.
VBA Object Name
HMIBitResultInfo
Usage
Use BitResultInfo to return a BitResultInfo object. In the following example the radius of a circle
will be dynamically configured using the Dynamic dialog, a tag name will be assigned, the bit
to be set will be defined and the associated property values will be assigned to the "set"/"not
set" states:
Sub AddDynamicDialogToCircleRadiusTypeBit()
'VBA216
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_B", "HMICircle")
'Tag "NewDynmic1" must exist
Set objDynDialog = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'NewDynamic1'")
With objDynDialog
.ResultType = hmiResultTypeBit
.BitResultInfo.BitNumber = 1
.BitResultInfo.BitSetValue = 40
.BitResultInfo.BitNotSetValue = 80
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1925
VBA for Automated Configuration
3.6 VBA Reference
See also
Delete Method (Page 1837)
VBA Reference (Page 1752)
BitSetValue Property (Page 2157)
BitNumber Property (Page 2155)
BitNotSetValue Property (Page 2154)
Application Property (Page 2129)
Parent Property (Page 2364)
Button Object
Description
Represents the "Button" object. The Button object is an element of the following listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default settings of property values of all Standard,
Windows and Smart objects.
VBA Object Name
HMIButton
Application
Use the Add method to create a new "Button" object in a picture:
Sub AddButton()
'VBA217
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button", "HMIButton")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1926 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where "Index" in this
case identifies the object by name:
Sub EditButton()
'VBA218
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects("Button")
objButton.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection(Index)" to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA219
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
ForeFlashColorOn Property (Page 2268)
BorderColorBottom Property (Page 2162)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
Text Property (Page 2440)
PictureUp Property (Page 2378)
PictureDown Property (Page 2376)
PasswordLevel Property (Page 2367)
Orientation Property (Page 2361)
Operation Property (Page 2358)
Left Property (Page 2311)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1927
VBA for Automated Configuration
3.6 VBA Reference
Layer Property (Page 2299)
Hotkey Property (Page 2279)
Height Property (Page 2276)
ForeFlashColorOff Property (Page 2267)
ForeColor Property (Page 2266)
FontUnderline Property (Page 2265)
FontSize Property (Page 2264)
FontName Property (Page 2263)
FontItalic Property (Page 2263)
FontBold Property (Page 2262)
FlashRateForeColor Property (Page 2257)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashForeColor Property (Page 2248)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
FillingIndex Property (Page 2240)
Filling Property (Page 2239)
FillColor Property (Page 2238)
DisplayOptions Property (Page 2222)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColorTop Property (Page 2162)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
BackBorderWidth Property (Page 2138)
AlignmentTop Property (Page 2126)
AlignmentLeft Property (Page 2125)
AdaptBorder Property (Page 2120)
WinCC: Scripting (VBS, ANSI-C, VBA)
1928 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDFonts Property (Page 2304)
LDTexts Property (Page 2309)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
PicDownReferenced Property (Page 2372)
PicDownTransparent Property (Page 2373)
PicDownUseTransColor Property (Page 2373)
PictAlignment property (Page 2375)
PicUpReferenced Property (Page 2379)
PicUpTransparent Property (Page 2380)
PicUpUseTransColor Property (Page 2380)
PicUseTransColor Property (Page 2381)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
WinCCStyle property (Page 2557)
WindowsStyle property (Page 2559)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1929
VBA for Automated Configuration
3.6 VBA Reference
CheckBox Object
Description
Represents the "Check Box" object. The CheckBox object is an element of the following listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default settings of property values of all Standard,
Windows and Smart objects.
VBA Object Name
HMICheckBox
Application
Use the Add method to create a new "Check Box" object in a picture:
Sub AddCheckBox()
'VBA220
Dim objCheckBox As HMICheckBox
Set objCheckBox = ActiveDocument.HMIObjects.AddHMIObject("CheckBox", "HMICheckBox")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where "Index" in this
case identifies the object by name:
Sub EditCheckBox()
'VBA221
Dim objCheckBox As HMICheckBox
Set objCheckBox = ActiveDocument.HMIObjects("CheckBox")
objCheckBox.BorderColor = RGB(255, 0, 0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1930 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection(Index)" to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA222
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Application Property (Page 2129)
AdaptBorder Property (Page 2120)
AlignmentLeft Property (Page 2125)
AlignmentTop Property (Page 2126)
BackColor Property (Page 2139)
BackFlashColorOff Property (Page 2145)
BackFlashColorOn Property (Page 2146)
BorderBackColor Property (Page 2159)
BorderColor Property (Page 2160)
BorderFlashColorOff Property (Page 2164)
BorderFlashColorOn Property (Page 2166)
BorderStyle Property (Page 2167)
BorderWidth Property (Page 2168)
BoxAlignment Property (Page 2170)
BoxCount Property (Page 2171)
Events Property (Page 2230)
FillColor Property (Page 2238)
Filling Property (Page 2239)
FillingIndex Property (Page 2240)
FillStyle Property (Page 2242)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1931
VBA for Automated Configuration
3.6 VBA Reference
FlashBackColor Property (Page 2246)
FlashBorderColor Property (Page 2247)
FlashForeColor Property (Page 2248)
FlashRateBackColor Property (Page 2253)
FlashRateBorderColor Property (Page 2255)
FlashRateForeColor Property (Page 2257)
FontBold Property (Page 2262)
FontItalic Property (Page 2263)
FontName Property (Page 2263)
FontSize Property (Page 2264)
FontUnderline Property (Page 2265)
ForeColor Property (Page 2266)
ForeFlashColorOff Property (Page 2267)
ForeFlashColorOn Property (Page 2268)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
Height Property (Page 2276)
Index Property (Page 2283)
Layer Property (Page 2299)
LDFonts Property (Page 2304)
LDTexts Property (Page 2309)
LDTooltipTexts Property (Page 2309)
Left Property (Page 2311)
ObjectName Property (Page 2353)
Operation Property (Page 2358)
OperationMessage Property (Page 2359)
Orientation Property (Page 2361)
Parent Property (Page 2364)
PasswordLevel Property (Page 2367)
Process Property (Page 2387)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
WinCC: Scripting (VBS, ANSI-C, VBA)
1932 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Text Property (Page 2440)
ToolTipText Property (Page 2448)
Top Property (Page 2449)
Transparency property (Page 2450)
Type Property (Page 2453)
Visible Property (Page 2553)
Width Property (Page 2556)
WindowsStyle property (Page 2559)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
Textlist property (Page 2441)
Circle Object
Description
Represents the "Circle" object. The Circle object is an element of the following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMICircle
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1933
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the Add method to create a new "Circle" object in a picture:
Sub AddCircle()
'VBA223
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle", "HMICircle")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditCircle()
'VBA224
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects("Circle")
objCircle.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA225
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
FillColor Property (Page 2238)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
Radius Property (Page 2397)
PasswordLevel Property (Page 2367)
WinCC: Scripting (VBS, ANSI-C, VBA)
1934 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
FillingIndex Property (Page 2240)
Filling Property (Page 2239)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
DrawInsideFrame property (Page 2224)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1935
VBA for Automated Configuration
3.6 VBA Reference
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
CircularArc Object
Description
Represents the "Circular Arc" object. The CircularArc object is an element of the following
listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMICircularArc
Usage
Use the Add method to create a new "Circular Arc" object in a picture:
Sub AddCiruclarArc()
'VBA226
Dim objCiruclarArc As HMICircularArc
Set objCiruclarArc = ActiveDocument.HMIObjects.AddHMIObject("CircularArc",
"HMICircularArc")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1936 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditCiruclarArc()
'VBA227
Dim objCiruclarArc As HMICircularArc
Set objCiruclarArc = ActiveDocument.HMIObjects("CircularArc")
objCiruclarArc.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA228
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
HMIObjects Object (Listing) (Page 1994)
BorderBackColor Property (Page 2159)
SelectedObjects object (Listing) (Page 2063)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
StartAngle Property (Page 2428)
Radius Property (Page 2397)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1937
VBA for Automated Configuration
3.6 VBA Reference
FlashBorderColor Property (Page 2247)
EndAngle Property (Page 2229)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
Collection object
Description
Allows access to a listing of objects of the same type, for example, "Documents" objects.
See also
Application Property (Page 2129)
Count Property (Page 2208)
Item Property (Page 2289)
Parent Property (Page 2364)
WinCC: Scripting (VBS, ANSI-C, VBA)
1938 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
ComboBox object
Description
0XOWLSOH2EMHFWV
+0,'HIDXOW2EMHFWV
+0,2EMHFWV &RPER%R[
6HOHFWLRQ
Represents the "ComboBox" object. The ComboBox object is an element of the following lists:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all default, smart, window and
tube objects.
VBA object name
HMIComboBox
Usage
Use the Add method to create a new "ComboBox" object in a picture:
Sub AddComboBox()
'VBA822
Dim objComboBox As HMIComboBox
Set objComboBox = ActiveDocument.HMIObjects.AddHMIObject("ComboBox", "HMIComboBox")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditComboBox()
'VBA850
Dim objComboBox As HMIComboBox
Set objComboBox = ActiveDocument.HMIObjects("ComboBox")
objComboBox.BorderColor = RGB(255, 0, 0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1939
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA824
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
ObjectName Property (Page 2353)
Left Property (Page 2311)
Layer Property (Page 2299)
Top Property (Page 2449)
Width Property (Page 2556)
Height Property (Page 2276)
NumberLines Property (Page 2352)
ForeColor Property (Page 2266)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackColor Property (Page 2139)
BorderStyle Property (Page 2167)
BorderWidth Property (Page 2168)
FillColor Property (Page 2238)
FillStyle Property (Page 2242)
FontName Property (Page 2263)
FontSize Property (Page 2264)
FontBold Property (Page 2262)
FontItalic Property (Page 2263)
FontUnderline Property (Page 2265)
AlignmentLeft Property (Page 2125)
GlobalShadow property (Page 2270)
Index Property (Page 2283)
Text Property (Page 2440)
Operation Property (Page 2358)
PasswordLevel Property (Page 2367)
WinCC: Scripting (VBS, ANSI-C, VBA)
1940 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Visible Property (Page 2553)
ToolTipText Property (Page 2448)
SelText property (Page 2417)
SelIndex property (Page 2417)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GroupParent Property (Page 2275)
LDFonts Property (Page 2304)
LDTexts Property (Page 2309)
LDTooltipTexts Property (Page 2309)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Type Property (Page 2453)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
Textlist property (Page 2441)
ConnectionPoints Object (Listing)
Description
The listing returns the number of points to which the connector can be appended in the
specified object.
VBA object name
HMIConnectionPoints
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1941
VBA for Automated Configuration
3.6 VBA Reference
Object properties
The ConnectionPoints object possesses the following properties:
● Application
● Count
● Item
● Parent
Example 1
In this example, a rectangle is inserted and the number of connection points is output:
Sub CountConnectionPoints()
'VBA229
Dim objRectangle As HMIRectangle
Dim objConnPoints As HMIConnectionPoints
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
Set objConnPoints = ActiveDocument.HMIObjects("Rectangle1").ConnectionPoints
MsgBox "Rectangle1 has " & objConnPoints.Count & " connectionpoints."
End Sub
Example 2:
In this example, a text field is inserted and the connection points are accessed via
"ConnectionPoints.Item". The coordinates of the connection points are shown in an output
window.
Sub GetConnectionPoints()
'VBA825
Dim xPos As Long
Dim yPos As Long
Dim objConnPoints As HMIConnectionPoints
Set objDoc = Application.ActiveDocument
Set objObject = objDoc.HMIObjects.AddHMIObject("Text","HMIStaticText")
Set objConnPoints = ActiveDocument.HMIObjects("Text").ConnectionPoints
For i = 1 To objConnPoints.Count
xPos = objObject.ConnectionPoints.Item(i)(0)
yPos = objObject.ConnectionPoints.Item(i)(1)
MsgBox "Coordinates " & i & ". ConnectionPoint:" & Chr(13) & "x: " & xPos & Chr(13) &
"y: " & yPos
Next
End Sub
The diagram below shows the positions of the 4 connection points of the text field.
WinCC: Scripting (VBS, ANSI-C, VBA)
1942 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Note
If you activate the connection points of a connector with VBA, the connection point index begins
with "1".
If you determine the connection points in the property window of the connector in the graphical
interface, the connection point index begins with "0".
The index numbers e.g. of the lower connection point in the picture are assigned as follows:
● VBA: Index = 3
● Graphical interface: Index = 2
See also
Parent Property (Page 2364)
Item Property (Page 2289)
Count Property (Page 2208)
Application Property (Page 2129)
CustomizedObject Object
Description
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1943
VBA for Automated Configuration
3.6 VBA Reference
Represents the object called "Customized Object". The CustomizedObject object is an element
of the following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
In the case of the CustomizedObject object, the only properties that are available in the object
are those that you have selected in the "Configuration" dialog for the customized object
concerned.
Note
You cannot configure the CustomizedObject object with VBA.
Further information regarding customized objects can be found in the WinCC documentation
under "Customized Object".
VBA Object Name
HMICustomizedObject
Application
Use the CreateCustomizedObject Method with the Selection listing to create a new
"Customized Object" object in a picture:
Sub CreateCustomizedObject()
'VBA230
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objCustomizedObject As HMICustomizedObject
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_A", "HMICircle")
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_B", "HMIRectangle")
With objCircle
.Left = 10
.Top = 10
.Selected = True
End With
With objRectangle
.Left = 50
.Top = 50
.Selected = True
End With
MsgBox "objects created and selected!"
Set objCustomizedObject = ActiveDocument.Selection.CreateCustomizedObject
objCustomizedObject.ObjectName = "Customer-Object"
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1944 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where "Index" in this
case identifies the object by name:
Sub EditCustomizedObject()
'VBA231
Dim objCustomizedObject As HMICustomizedObject
Set objCustomizedObject = ActiveDocument.HMIObjects("Customer-Object")
MsgBox objCustomizedObject.ObjectName
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
Destroy Method (Page 1841)
Delete Method (Page 1837)
CreateCustomizedObject Method (Page 1831)
How to Edit a Customized Object with VBA (Page 1691)
VBA Reference (Page 1752)
Customized Objects (Page 1690)
Editing Objects with VBA (Page 1670)
Application Property (Page 2129)
Events Property (Page 2230)
GroupParent Property (Page 2275)
Height Property (Page 2276)
InheritState property (Page 2285)
Layer Property (Page 2299)
LDTooltipTexts Property (Page 2309)
Left Property (Page 2311)
ObjectName Property (Page 2353)
Operation Property (Page 2358)
Parent Property (Page 2364)
PasswordLevel Property (Page 2367)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
ToolTipText Property (Page 2448)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1945
VBA for Automated Configuration
3.6 VBA Reference
Top Property (Page 2449)
Type Property (Page 2453)
Visible Property (Page 2553)
Width Property (Page 2556)
ConnectionPoints property (Page 2205)
HMIUdoObjects property (Page 2279)
ConnectorObjects property (Page 2206)
D-I
DataLanguage Object
Description
Represents the installed project language, which is identified by its name and language
identifier. The DataLanguage object is an element of the DataLanguages listing:
The list of language codes is available in the WinCC documentation (Index > Language Code).
The hexadecimal value specified in the list has to be converted to its equivalent decimal value.
VBA Object Name
HMIDataLanguage
Usage
Use the DataLanguages property to return an individual DataLanguage object. In the following
example the first installed project language is output:
Sub ShowFirstObjectOfCollection()
'VBA232
Dim strName As String
strName = ActiveDocument.Application.AvailableDataLanguages(1).LanguageName
MsgBox strName
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1946 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
DataLanguages Object (Listing) (Page 1947)
VBA Reference (Page 1752)
Language-Dependent Configuration with VBA (Page 1628)
Parent Property (Page 2364)
LanguageName Property (Page 2296)
LanguageID Property (Page 2296)
Application Property (Page 2129)
DataLanguages Object (Listing)
Description
A listing of the DataLanguage objects that represent all the installed project languages.
VBA Object Name
HMIDataLanguages
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1947
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the AvailableDataLanguages property to return the DataLanguages listing. In the following
example the installed project language is output:
Sub ShowDataLanguage()
'VBA233
Dim colDataLanguages As HMIDataLanguages
Dim objDataLanguage As HMIDataLanguage
Dim strLanguages As String
Dim iCount As Integer
iCount = 0
Set colDataLanguages = Application.AvailableDataLanguages
For Each objDataLanguage In colDataLanguages
If "" <> strLanguages Then strLanguages = strLanguages & "/"
strLanguages = strLanguages & objDataLanguage.LanguageName & " "
'Every 15 items of datalanguages output in a messagebox
If 0 = iCount Mod 15 And 0 <> iCount Then
MsgBox strLanguages
strLanguages = ""
End If
iCount = iCount + 1
Next objDataLanguage
MsgBox strLanguages
End Sub
See also
Language-Dependent Configuration with VBA (Page 1628)
DataLanguage Object (Page 1946)
Item Method (Page 1865)
VBA Reference (Page 1752)
Parent Property (Page 2364)
Count Property (Page 2208)
Application Property (Page 2129)
DataSetObj object
Description
The "DataSetObj" object serves as a container for the internal storage of data of the user
objects or faceplate types. The DataSetObj object is an element of the following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
1948 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VBA Object Name
HMIDataSetObj
See also
Application Property (Page 2129)
ConnectionPoints property (Page 2205)
Events Property (Page 2230)
GroupParent Property (Page 2275)
Height Property (Page 2276)
Layer Property (Page 2299)
LDFonts Property (Page 2304)
Left Property (Page 2311)
ObjectName Property (Page 2353)
Operation Property (Page 2358)
Parent Property (Page 2364)
PasswordLevel Property (Page 2367)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
ToolTipText Property (Page 2448)
Top Property (Page 2449)
Type Property (Page 2453)
Visible Property (Page 2553)
Width Property (Page 2556)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1949
VBA for Automated Configuration
3.6 VBA Reference
DestLink Object
Description
Represents the destination for a direct connection.
VBA Object Name
HMIDestLink
WinCC: Scripting (VBS, ANSI-C, VBA)
1950 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the DestinationLink property to return the DestLink object. In the following example the X
position of "Rectangle_A" is copied to the Y position of "Rectangle_B" in Runtime by clicking
on the button:
Sub DirectConnection()
'VBA234
Dim objButton As HMIButton
Dim objRectangleA As HMIRectangle
Dim objRectangleB As HMIRectangle
Dim objEvent As HMIEvent
Dim objDirConnection As HMIDirectConnection
Set objRectangleA = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_A", "HMIRectangle")
Set objRectangleB = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_B", "HMIRectangle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objRectangleA
.Top = 100
.Left = 100
End With
With objRectangleB
.Top = 250
.Left = 400
.BackColor = RGB(255, 0, 0)
End With
With objButton
.Top = 10
.Left = 10
.Width = 90
.Height = 50
.Text = "SetPosition"
End With
'
'Directconnection is initiated on mouseclick:
Set objDirConnection =
objButton.Events(1).Actions.AddAction(hmiActionCreationTypeDirectConnection)
With objDirConnection
'Sourceobject: Property "Top" of "Rectangle_A"
.SourceLink.Type = hmiSourceTypeProperty
.SourceLink.ObjectName = "Rectangle_A"
.SourceLink.AutomationName = "Top"
'
'Targetobject: Property "Left" of "Rectangle_B"
.DestinationLink.Type = hmiDestTypeProperty
.DestinationLink.ObjectName = "Rectangle_B"
.DestinationLink.AutomationName = "Left"
End With
End Sub
See also
DirectConnection Object (Page 1952)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1951
VBA for Automated Configuration
3.6 VBA Reference
Type Property (Page 2453)
ObjectName Property (Page 2353)
AutomationName Property (Page 2133)
Parent Property (Page 2364)
DirectConnection Object
Description
Represents a direct connection.
VBA Object Name
HMIDirectConnection
WinCC: Scripting (VBS, ANSI-C, VBA)
1952 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the DestinationLink and SourceLink properties to configure the source and destination of
a direct connection. In the following example the X position of "Rectangle_A" is copied to the
Y position of "Rectangle_B" in Runtime by clicking on the button:
Sub DirectConnection()
'VBA235
Dim objButton As HMIButton
Dim objRectangleA As HMIRectangle
Dim objRectangleB As HMIRectangle
Dim objEvent As HMIEvent
Dim objDirConnection As HMIDirectConnection
Set objRectangleA = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_A", "HMIRectangle")
Set objRectangleB = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_B", "HMIRectangle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objRectangleA
.Top = 100
.Left = 100
End With
With objRectangleB
.Top = 250
.Left = 400
.BackColor = RGB(255, 0, 0)
End With
With objButton
.Top = 10
.Left = 10
.Width = 90
.Height = 50
.Text = "SetPosition"
End With
'
'Directconnection is initiated on mouseclick:
Set objDirConnection =
objButton.Events(1).Actions.AddAction(hmiActionCreationTypeDirectConnection)
With objDirConnection
'Sourceobject: Property "Top" of "Rectangle_A"
.SourceLink.Type = hmiSourceTypeProperty
.SourceLink.ObjectName = "Rectangle_A"
.SourceLink.AutomationName = "Top"
'
'Targetobject: Property "Left" of "Rectangle_B"
.DestinationLink.Type = hmiDestTypeProperty
.DestinationLink.ObjectName = "Rectangle_B"
.DestinationLink.AutomationName = "Left"
End With
End Sub
See also
DestinationLink Property (Page 2218)
SourceLink Object (Page 2069)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1953
VBA for Automated Configuration
3.6 VBA Reference
DestLink Object (Page 1950)
VBA Reference (Page 1752)
SourceLink Property (Page 2424)
Application Property (Page 2129)
Parent Property (Page 2364)
Document Object
Description
Displays a picture in Graphics Designer. The document object is an element of the documents
listing.
VBA Object Name
HMIDocument
Usage
Use Documents(Index) to return an individual document object. In the following example the
file name of the first picture is displayed:
Sub ShowFirstObjectOfCollection()
'VBA236
Dim strName As String
strName = Application.Documents(3).Name
MsgBox strName
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1954 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
You may also use the object "Me" if you wish to address the current document:
Sub ShowDocumentName()
'VBA812
Dim obj As Document
set obj = Me
MsgBox obj.Name
End Sub
For example, use the SaveAs method to save the picture under a different name. In the
following example the first picture will be saved under the name "CopyOfPicture1":
Sub SaveDocumentAs()
'VBA237
Application.Documents(3).SaveAs ("CopyOfPicture1")
End Sub
See also
Editing Pictures with VBA (Page 1663)
GridHeight Property (Page 2273)
Documents Object (Listing) (Page 1957)
SetRTLayerVisible Method (Page 1893)
SaveAs Method (Page 1886)
Save Method (Page 1885)
PrintProjectDocumentation Method (Page 1876)
PasteClipboard Method (Page 1874)
MoveSelection Method (Page 1871)
IsRTLayerVisible Method (Page 1864)
Export Method (Page 1846)
CopySelection Method (Page 1828)
Close Method (Page 1824)
VBA Reference (Page 1752)
ExtendedZoomingEnable Property (Page 2235)
Width Property (Page 2556)
Visible Property (Page 2553)
Views Property (Page 2553)
UpdateCycle Property (Page 2466)
TabOrderOtherAction Property (Page 2434)
TabOrderMouse Property (Page 2433)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1955
VBA for Automated Configuration
3.6 VBA Reference
TabOrderKeyboard Property (Page 2432)
TabOrderAllHMIObjects Property (Page 2432)
SnapToGrid Property (Page 2424)
HMIDefaultObjects Object (Listing) (Page 1989)
Selection Property (Page 2416)
Properties Property (Page 2391)
Path Property (Page 2368)
PasswordLevel Property (Page 2367)
Parent Property (Page 2364)
Operation Property (Page 2358)
Name Property (Page 2349)
LockedByCreatorID Property (Page 2319)
LastChange Property (Page 2298)
HMIObjects Property (Page 2278)
Hide Property (Page 2277)
Height Property (Page 2276)
GridWidth Property (Page 2274)
GridColor Property (Page 2273)
Grid Property (Page 2272)
FillStyle Property (Page 2242)
Events Property (Page 2230)
CustomToolbars Property (Page 2214)
CustomMenus Property (Page 2214)
CursorMode Property (Page 2213)
BackColor Property (Page 2139)
Application Property (Page 2129)
BackPictureAlignment property (Page 2148)
BackPictureName property (Page 2148)
CommonVBSCode Property (Page 2201)
CommonVBSEventArea property (Page 2202)
CommonVBSPropertyArea property (Page 2202)
GlobalColorScheme property (Page 2270)
LayerDecluttering Property (Page 2302)
Layers Property (Page 2303)
Modified Property (Page 2347)
WinCC: Scripting (VBS, ANSI-C, VBA)
1956 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
ObjectSizeDecluttering Property (Page 2355)
PdlProtection property (Page 2369)
GetDeclutterObjectSize method (Page 1836)
SetDeclutterObjectSize Method (Page 1892)
FireConnectionEvents method (Page 1849)
TransformDisplayCoordinate method (Page 1898)
TransformPixelCoordinate method (Page 1898)
FillBackColor property (Page 2238)
Documents Object (Listing)
Description
VBA Object Name
HMIDocuments
Usage
Note
Use the "ActiveDocument" property if you wish to refer to the active picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1957
VBA for Automated Configuration
3.6 VBA Reference
Use the Documents property to return the Documents listing. In the following example the
names of all open pictures are output:
Sub ShowDocuments()
'VBA238
Dim colDocuments As Documents
Dim objDocument As Document
Set colDocuments = Application.Documents
For Each objDocument In colDocuments
MsgBox objDocument.Name
Next objDocument
End Sub
Use the Add method to add a new Document object to the Documents listing. In the following
example a new picture is created:
Sub AddNewDocument()
'VBA239
Dim objDocument As Document
Set objDocument = Application.Documents.Add
End Sub
See also
Add Method (Page 1793)
Document Object (Page 1954)
SaveAll Method (Page 1885)
Open Method (Page 1873)
CloseAll Method (Page 1825)
Close Method (Page 1824)
VBA Reference (Page 1752)
Editing Pictures with VBA (Page 1663)
Parent Property (Page 2364)
Count Property (Page 2208)
Application Property (Page 2129)
ActiveDocument Property (Page 2116)
Item Property (Page 2289)
SetOpenContext method (Page 1892)
ConvertWM method (Page 1828)
WinCC: Scripting (VBS, ANSI-C, VBA)
1958 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
DotNetControl object
Description
Represents the "DotNetControl" object. The DotNetControl object is an element of the following
listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
VBA Object Name
HMIDotNetControl
Application
Use the AddDotNetControl method to insert a DotNetControl in a picture.
In the following example, the ".NETControl" object from the Global Assembly Cache is inserted
in the active picture.
'VBA851
Dim DotNetControl As HMIDotNetControl
Set DotNetControl = ActiveDocument.HMIObjects.AddDotNetControl("MyVBAControl",
"System.Windows.Forms.Label", True,"Assembly=System.Windows.Forms, Version=2.0.0.0,
Culture=neutral, PublicKeyToken=b77a5c561934e089")
See also
AddDotNetControl method (Page 1804)
Delete Method (Page 1837)
Application Property (Page 2129)
AssemblyInfo property (Page 2131)
ControlType property (Page 2208)
Events Property (Page 2230)
GroupParent Property (Page 2275)
Height Property (Page 2276)
Layer Property (Page 2299)
LDTooltipTexts Property (Page 2309)
Left Property (Page 2311)
ObjectName Property (Page 2353)
Operation Property (Page 2358)
Parent Property (Page 2364)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1959
VBA for Automated Configuration
3.6 VBA Reference
PasswordLevel Property (Page 2367)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
ToolTipText Property (Page 2448)
Top Property (Page 2449)
Type Property (Page 2453)
Visible Property (Page 2553)
Width Property (Page 2556)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
DynamicDialog Object
Description
Represents the Dynamic dialog. You can use the dynamic dialog to make the properties of
pictures and objects respond dynamically to different value ranges.
Define the value range with the aid of the ResultType property.
VBA Object Name
HMIDynamicDialog
WinCC: Scripting (VBS, ANSI-C, VBA)
1960 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the DynamicDialog object to make an object property dynamic. In the following example
the radius of a circle will be dynamically configured using the Dynamic dialog, a tag name will
be assigned and three analog value ranges will be created:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA240
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
.ResultType = hmiResultTypeAnalog
.Trigger.VariableTriggers.Add "NewDynamic2", hmiVariableCycleType_5s
.AnalogResultInfos.Add 50, 40
.AnalogResultInfos.Add 100, 80
.AnalogResultInfos.ElseCase = 100
End With
End Sub
See also
Delete Method (Page 1837)
ConvertToScript Method (Page 1826)
CheckSyntax Method (Page 1823)
VariableStateValues Property (Page 2549)
VariableStateChecked Property (Page 2548)
Trigger Property (Page 2452)
SourceCode Property (Page 2426)
ScriptType Property (Page 2409)
ResultType Property (Page 2402)
Parent Property (Page 2364)
Compiled Property (Page 2204)
BitResultInfo Property (Page 2156)
BinaryResultInfo Property (Page 2154)
Application Property (Page 2129)
AnalogResultInfos Property (Page 2127)
Prototype Property (Page 2392)
QualityCodeStateChecked Properties (Page 2393)
QualityCodeStateValues Property (Page 2395)
UsedLanguage property (Page 2467)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1961
VBA for Automated Configuration
3.6 VBA Reference
VariablesExist Property (Page 2547)
VariableStateType Property (Page 2549)
ConvertToVBScript method (Page 1827)
Ellipse Object
Description
Represents the "Ellipse" object. The Ellipse object is an element of the following listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIEllipse
Usage
Use the Add method to create a new "Ellipse" object in a picture:
Sub AddEllipse()
'VBA241
Dim objEllipse As HMIEllipse
Set objEllipse = ActiveDocument.HMIObjects.AddHMIObject("Ellipse", "HMIEllipse")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1962 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditEllipse()
'VBA242
Dim objEllipse As HMIEllipse
Set objEllipse = ActiveDocument.HMIObjects("Ellipse")
objEllipse.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing.
Sub ShowNameOfFirstSelectedObject()
'VBA243
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
FillingIndex Property (Page 2240)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
RadiusWidth Property (Page 2398)
RadiusHeight Property (Page 2397)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1963
VBA for Automated Configuration
3.6 VBA Reference
FlashRateBackColor Property (Page 2253)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
Filling Property (Page 2239)
FillColor Property (Page 2238)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
1964 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
EllipseArc Object
Description
Represents the "Ellipse Arc" object. The EllipseArc object is an element of the following listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIEllipseArc
Usage
Use the Add method to create a new "Ellipse Arc" object in a picture:
Sub AddEllipseArc()
'VBA244
Dim objEllipseArc As HMIEllipseArc
Set objEllipseArc = ActiveDocument.HMIObjects.AddHMIObject("EllipseArc", "HMIEllipseArc")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditEllipseArc()
'VBA245
Dim objEllipseArc As HMIEllipseArc
Set objEllipseArc = ActiveDocument.HMIObjects("EllipseArc")
objEllipseArc.BorderColor = RGB(255, 0, 0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1965
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA246
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
Use the "HMIDefaultObjects(Index)" to return an object from the HMIDefaultObjects Listing:
Sub EditDefaultPropertiesOfEllipseArc()
'VBA247
Dim objEllipseArc As HMIEllipseArc
Set objEllipseArc = Application.DefaultHMIObjects("HMIEllipseArc")
objEllipseArc.BorderColor = RGB(255, 255, 0)
'create new "EllipseArc"-object
Set objEllipseArc = ActiveDocument.HMIObjects.AddHMIObject("EllipseArc2", "HMIEllipseArc")
End Sub
See also
ToolTipText Property (Page 2448)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
StartAngle Property (Page 2428)
RadiusWidth Property (Page 2398)
RadiusHeight Property (Page 2397)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
WinCC: Scripting (VBS, ANSI-C, VBA)
1966 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
FlashBorderColor Property (Page 2247)
EndAngle Property (Page 2229)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1967
VBA for Automated Configuration
3.6 VBA Reference
EllipseSegment Object
Description
Represents the "Ellipse Segment" object. The EllipseSegment object is an element of the
following listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIEllipseSegment
Usage
Use the Add method to create a new "Ellipse Segment" object in a picture:
Sub AddEllipseSegment()
'VBA248
Dim objEllipseSegment As HMIEllipseSegment
Set objEllipseSegment = ActiveDocument.HMIObjects.AddHMIObject("EllipseSegment",
"HMIEllipseSegment")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditEllipseSegment()
'VBA249
Dim objEllipseSegment As HMIEllipseSegment
Set objEllipseSegment = ActiveDocument.HMIObjects("EllipseSegment")
objEllipseSegment.BorderColor = RGB(255, 0, 0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1968 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA250
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
ToolTipText Property (Page 2448)
BackFlashColorOn Property (Page 2146)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
StartAngle Property (Page 2428)
RadiusWidth Property (Page 2398)
RadiusHeight Property (Page 2397)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
FillingIndex Property (Page 2240)
Filling Property (Page 2239)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1969
VBA for Automated Configuration
3.6 VBA Reference
FillColor Property (Page 2238)
EndAngle Property (Page 2229)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
1970 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Event Object
Description
Represents an event that triggers one or more actions in Runtime (e.g. a direct connection).
An event can be configured onto an object and a property.
VBA Object Name
HMIEvent
Usage
Use the AddAction method to configure an action on an event. In this example a C action is
to be triggered in the event of a change of radius in Runtime:
Sub AddActionToPropertyTypeCScript()
'VBA251
Dim objEvent As HMIEvent
Dim objCScript As HMIScriptInfo
Dim objCircle As HMICircle
'Create circle in the picture. If property "Radius" is changed,
'a C-action is added:
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_AB", "HMICircle")
Set objEvent = objCircle.Radius.Events(1)
Set objCScript = objEvent.Actions.AddAction(hmiActionCreationTypeCScript)
End Sub
See also
Application Property (Page 2129)
Delete Method (Page 1837)
AddAction Method (Page 1801)
VBA Reference (Page 1752)
Parent Property (Page 2364)
EventType Property (Page 2232)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1971
VBA for Automated Configuration
3.6 VBA Reference
Actions Property (Page 2115)
EventName property (Page 2232)
Events Object (Listing)
Description
A listing of the Event objects that represent all the events configured onto an object. Use the
Item method to define the event that is intended to be configured:
● You configure an action on a property with VBA by using the "Events(1)" property, where
the index "1" stands for the event "Upon change":
● To configure an action onto an object with the aid of VBA, use the "Events(Index)" property,
where "Index" stands for the trigger event (see table):
Index EventType (depending upon the object used)
0 hmiEventTypeNotDefined
1 hmiEventTypeMouseClick
2 hmiEventTypeMouseLButtonDown
3 hmiEventTypeMouseLButtonUp
4 hmiEventTypeMouseRButtonDown
5 hmiEventTypeMouseRButtonUp
6 hmiEventTypeKeyboardDown
7 hmiEventTypeKeyboardUp
8 hmiEventTypeFocusEnter
9 hmiEventTypeObjectChange
10 hmiEventTypePictureOpen
VBA Object Name
HMIEvents
WinCC: Scripting (VBS, ANSI-C, VBA)
1972 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the Item method to return an individual Event object. In this example the event names
and event types of all objects in the active pictures are put out. In order for this example to
work, insert some objects into the active picture and configure different events.
Sub ShowEventsOfAllObjectsInActiveDocument()
'VBA252
Dim colEvents As HMIEvents
Dim objEvent As HMIEvent
Dim iMax As Integer
Dim iIndex As Integer
Dim iAnswer As Integer
Dim strEventName As String
Dim strObjectName As String
Dim varEventType As Variant
iIndex = 1
iMax = ActiveDocument.HMIObjects.Count
For iIndex = 1 To iMax
Set colEvents = ActiveDocument.HMIObjects(iIndex).Events
strObjectName = ActiveDocument.HMIObjects(iIndex).ObjectName
For Each objEvent In colEvents
strEventName = objEvent.EventName
varEventType = objEvent.EventType
iAnswer = MsgBox("Objectname: " & strObjectName & vbCrLf & "Eventtype: " & varEventType &
vbCrLf & "Eventname: " & strEventName, vbOKCancel)
If vbCancel = iAnswer Then Exit For
Next objEvent
If vbCancel = iAnswer Then Exit For
Next iIndex
End Sub
See also
Item Method (Page 1865)
VBA Reference (Page 1752)
Parent Property (Page 2364)
Count Property (Page 2208)
Application Property (Page 2129)
ExternalShapeInfo object
Description
Is used for internal purposes in Graphics Designer.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1973
VBA for Automated Configuration
3.6 VBA Reference
FaceplateObject object
Description
0XOWLSOH2EMHFWV
+0,'HIDXOW2EMHFWV
+0,2EMHFWV )DFHSODWH2EMHFW
6HOHFWLRQ
Represents the "faceplate instance" object. The FaceplateObject object is an element of the
following lists:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all default, smart, window and
tube objects.
VBA object name
HMIFaceplateObject
Usage
Use the Add method to create a new "faceplate instance" object in a picture:
Sub AddFaceplateInstance()
'VBA826
Dim objFaceplateInstance As HMIFaceplateObject
Set objFaceplateInstance = ActiveDocument.HMIObjects.AddHMIObject("faceplate instance",
"HMIFaceplateObject")
objFaceplateInstance.Properties.Item(3).value = "Faceplate1.fpt"
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditFaceplateInstance()
'VBA827
Dim objFaceplateInstance As HMIFaceplateObject
Set objFaceplateInstance = ActiveDocument.HMIObjects("faceplate instance")
objFaceplateInstance.visible = True
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1974 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA828
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
ObjectName Property (Page 2353)
Layer Property (Page 2299)
Left Property (Page 2311)
Top Property (Page 2449)
Width Property (Page 2556)
Height Property (Page 2276)
Operation Property (Page 2358)
PasswordLevel Property (Page 2367)
Visible Property (Page 2553)
ToolTipText Property (Page 2448)
ScalingMode property (Page 2408)
FaceplateType property (Page 2235)
Delete Method (Page 1837)
Destroy Method (Page 1841)
Application Property (Page 2129)
Events Property (Page 2230)
GroupParent Property (Page 2275)
InheritState property (Page 2285)
LDTooltipTexts Property (Page 2309)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Type Property (Page 2453)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1975
VBA for Automated Configuration
3.6 VBA Reference
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
FaceplateObjects object
Description
A listing of the HMIFaceplateObject objects that represent all faceplate objects in the picture.
VBA Object Name
HMIFaceplateObjects
See also
Parent Property (Page 2364)
OriginalPropertyName property (Page 2362)
FaceplateProperty object
Description
Represents the property of a faceplate object. In the case of the FaceplateProperty object, the
use of the Value property is set as the default. For this reason you can use the following
notation, for example, to assign a new value to an object property:
<FaceplateObject>.<FaceplateProperty> = <Value>
You can use the "Dynamic" property to make an object property dynamic with VBA. Use the
"Events" listing to configure actions with VBA.
See also
CreateDynamic Method (Page 1833)
DeleteDynamic Method (Page 1839)
Application Property (Page 2129)
DisplayName Property (Page 2221)
Dynamic Property (Page 2225)
Events Property (Page 2230)
IsDynamicable Property (Page 2287)
LDFonts Property (Page 2304)
LDTexts Property (Page 2309)
Name Property (Page 2349)
WinCC: Scripting (VBS, ANSI-C, VBA)
1976 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parent Property (Page 2364)
Value Property (Page 2472)
IsPublished property (Page 2287)
LDFontsType property (Page 2305)
ParentCookie property (Page 2367)
FolderItem Object
Description
Represents a folder or object in the Components Library. A FolderItem object of the "Folder"
type is an element of the FolderItems listing. A FolderItem object of the "Item" type is an element
of the Folder listing.
VBA Object Name
HMIFolderItem
Usage
Use the FolderItems property to return the FolderItems listing. In the following example the
names of folders in the "Global Library will be output:
Sub ShowFolderItemsOfGlobalLibrary()
'VBA253
Dim colFolderItems As HMIFolderItems
Dim objFolderItem As HMIFolderItem
Set colFolderItems = Application.SymbolLibraries(1).FolderItems
For Each objFolderItem In colFolderItems
MsgBox objFolderItem.Name
Next objFolderItem
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1977
VBA for Automated Configuration
3.6 VBA Reference
Use the CopyToClipboard method to copy a "FolderItem" object of the "Item" type to the
clipboard. In the following example the object "PC" will be copied to the clipboard.
Sub CopyFolderItemToClipboard()
'VBA254
Dim objGlobalLib As HMISymbolLibrary
Set objGlobalLib = Application.SymbolLibraries(1)
objGlobalLib.FolderItems("Folder2").Folder("Folder2").Folder.Item("Object1").CopyToClipboa
rd
End Sub
See also
Type Property (Page 2453)
FolderItems Object (Listing) (Page 1978)
Delete Method (Page 1837)
CopyToClipboard Method (Page 1830)
How to paste an object from the object library into a picture with VBA (Page 1656)
How to edit the component library with VBA (Page 1653)
VBA Reference (Page 1752)
Accessing the component library with VBA (Page 1650)
Parent Property (Page 2364)
Name Property (Page 2349)
LDNames Property (Page 2307)
Folder Property (Page 2258)
Application Property (Page 2129)
DisplayName Property (Page 2221)
Pathname Property (Page 2369)
FolderItems Object (Listing)
Description
WinCC: Scripting (VBS, ANSI-C, VBA)
1978 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
A listing of the FolderItem objects that represent all the folders and objects in the Components
Library.
VBA Object Name
HMIFolderItems
Usage
Use the FolderItems property to return the FolderItems listing. In the following example the
names of folders in the "Global Library will be output:
Sub ShowFolderItemsOfGlobalLibrary()
'VBA255
Dim colFolderItems As HMIFolderItems
Dim objFolderItem As HMIFolderItem
Set colFolderItems = Application.SymbolLibraries(1).FolderItems
For Each objFolderItem In colFolderItems
MsgBox objFolderItem.Name
Next objFolderItem
End Sub
Use the AddFolder method, for instance, to create a new folder in the Components Library. In
the following example the folder "Project Folder" will be created in the "Project Library":
Sub AddNewFolderToProjectLibrary()
'VBA256
Dim objProjectLib As HMISymbolLibrary
Set objProjectLib = Application.SymbolLibraries(2)
objProjectLib.FolderItems.AddFolder ("My Folder")
End Sub
See also
AddItem Method (Page 1809)
SymbolLibrary Object (Page 2084)
FolderItem Object (Page 1977)
AddFromClipboard Method (Page 1806)
AddFolder Method (Page 1805)
How to paste an object from the object library into a picture with VBA (Page 1656)
How to edit the component library with VBA (Page 1653)
VBA Reference (Page 1752)
Accessing the component library with VBA (Page 1650)
Parent Property (Page 2364)
Count Property (Page 2208)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1979
VBA for Automated Configuration
3.6 VBA Reference
Application Property (Page 2129)
FindByDisplayName Method (Page 1848)
Item Property (Page 2289)
GraphicObject Object
Description
Represents the object called "Graphic Object". The GraphicObject object is an element of the
following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIGraphicObject
Usage
Use the Add method to create a new "Graphic Object" object in a picture:
Sub AddGraphicObject()
'VBA257
Dim objGraphicObject As HMIGraphicObject
Set objGraphicObject = ActiveDocument.HMIObjects.AddHMIObject("Graphic-Object",
"HMIGraphicObject")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1980 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditGraphicObject()
'VBA258
Dim objGraphicObject As HMIGraphicObject
Set objGraphicObject = ActiveDocument.HMIObjects("Graphic-Object")
objGraphicObject.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA259
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name of the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
Left Property (Page 2311)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
PicUseTransColor Property (Page 2381)
PictureName Property (Page 2377)
PicTransColor Property (Page 2375)
PicReferenced Property (Page 2374)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Name Property (Page 2349)
Layer Property (Page 2299)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1981
VBA for Automated Configuration
3.6 VBA Reference
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
FillingIndex Property (Page 2240)
Filling Property (Page 2239)
FillColor Property (Page 2238)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
1982 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Group Object
Description
Represents the object called "Group Object". The Group Object is an element of the following
listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
A group object is created from the objects selected in a picture. The objects in the Group Object
are also saved in the "GroupedHMIObjects" listing and index numbers are newly allocated.
You have unrestricted access to the properties of all objects in the Group Object.
Further information regarding group objects can be found in the WinCC documentation under
"Group Object".
VBA Object Name
HMIGroup
Usage
Use the CreateGroup Method with the Selection listing to create a new "Group Object" object
in a picture:
Sub DoCreateGroup()
'VBA260
Dim objGroup As HMIGroup
Set objGroup = ActiveDocument.Selection.CreateGroup
objGroup.ObjectName = "Group-Object"
End Sub
Use the following methods to edit an existing Group Object:
● Methode "Add(Index)": Adds a new object to the group object.
● Methode "Remove(Index)": Removes a object from the group object.
● "UnGroup()" method: Ungroups the group object (ungroup).
● "Delete()" Method: Deletes the group object and the objects that it contains.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1983
VBA for Automated Configuration
3.6 VBA Reference
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditGroup()
'VBA261
Dim objGroup As HMIGroup
Set objGroup = ActiveDocument.HMIObjects("Group-Object")
MsgBox objGroup.ObjectName
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
GroupedObjects Object (Listing) (Page 1988)
Ungroup Method (Page 1898)
Remove Method (Page 1876)
Delete Method (Page 1837)
Add Method (GroupedObjects Listing) (Page 1798)
How to Edit Objects in Group Objects Using VBA (Page 1687)
How to Edit the Group Objects Using VBA (Page 1684)
VBA Reference (Page 1752)
Group Objects (Page 1682)
Editing Objects with VBA (Page 1670)
Application Property (Page 2129)
Events Property (Page 2230)
GroupParent Property (Page 2275)
GroupedHMIObjects Property (Page 2275)
Height Property (Page 2276)
Layer Property (Page 2299)
LDTooltipTexts Property (Page 2309)
Left Property (Page 2311)
ObjectName Property (Page 2353)
Operation Property (Page 2358)
Parent Property (Page 2364)
PasswordLevel Property (Page 2367)
Properties Property (Page 2391)
Selected Property (Page 2415)
WinCC: Scripting (VBS, ANSI-C, VBA)
1984 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
ToolTipText Property (Page 2448)
Top Property (Page 2449)
Type Property (Page 2453)
Visible Property (Page 2553)
Width Property (Page 2556)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
GroupDisplay Object
Description
Represents the "Group Display" object. The GroupDisplay object is an element of the following
listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
VBA Object Name
HMIGroupDisplay
Usage
Use the Add method to create a new "Group Display" object in a picture:
Sub AddGroupDisplay()
'VBA262
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("Groupdisplay",
"HMIGroupDisplay")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1985
VBA for Automated Configuration
3.6 VBA Reference
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditGroupDisplay()
'VBA263
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects("Groupdisplay")
objGroupDisplay.BackColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA264
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
MCText Property (Page 2342)
Height Property (Page 2276)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
UserValue1 Property (Page 2469)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
SignificantMask Property (Page 2421)
SameSize Property (Page 2405)
Relevant Property (Page 2401)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
MessageClass Property (Page 2345)
MCGUTextFlash Property (Page 2333)
WinCC: Scripting (VBS, ANSI-C, VBA)
1986 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
MCGUTextColorOn Property (Page 2332)
MCGUTextColorOff Property (Page 2332)
MCGUBackFlash Property (Page 2331)
MCGUBackColorOn Property (Page 2330)
MCGUBackColorOff-Eigenschaft (Page 2330)
LockText Property (Page 2322)
LockTextColor Property (Page 2323)
LockStatus Property (Page 2321)
LockBackColor Property (Page 2319)
Left Property (Page 2311)
Layer Property (Page 2299)
FontUnderline Property (Page 2265)
FontSize Property (Page 2264)
FontName Property (Page 2263)
FontItalic Property (Page 2263)
FontBold Property (Page 2262)
FlashRate Property (Page 2252)
Button1..8Width property (Page 2173)
BackColor Property (Page 2139)
BackBorderWidth Property (Page 2138)
AlignmentTop Property (Page 2126)
AlignmentLeft Property (Page 2125)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1987
VBA for Automated Configuration
3.6 VBA Reference
Type Property (Page 2453)
Button1..8MessageClasses (Page 2173)
UseGlobalAlarmClasses property (Page 2468)
UseGlobalSettings property (Page 2469)
CollectValue property (Page 2189)
EventQuitMask property (Page 2229)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
GroupedObjects Object (Listing)
Description
A listing of the HMIObject objects that represent all the objects in the group object.
VBA Object Name
HMIGroupedObjects
Usage
Use the GroupedHMIObjects property to return the GroupedObjects listing. In the following
example all the objects in the first group object are output in the active picture. The group
object called "Group1" must first have been created:
Sub ShowGroupedObjectsOfFirstGroup()
'VBA265
Dim colGroupedObjects As HMIGroupedObjects
Dim objObject As HMIObject
Set colGroupedObjects = ActiveDocument.HMIObjects("Group1").GroupedHMIObjects
For Each objObject In colGroupedObjects
MsgBox objObject.ObjectName
Next objObject
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
1988 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use the Remove method, for instance, to remove an object from the group object. In the
following example the first object will be removed from the group object called "Group1":
Sub RemoveObjectFromGroup()
'VBA266
Dim objGroup As HMIGroup
Set objGroup = ActiveDocument.HMIObjects("Group1")
objGroup.GroupedHMIObjects.Remove (1)
End Sub
See also
Group Object (Page 1983)
Remove Method (Page 1876)
Add Method (GroupedObjects Listing) (Page 1798)
How to Edit the Group Objects Using VBA (Page 1684)
VBA Reference (Page 1752)
Group Objects (Page 1682)
Parent Property (Page 2364)
GroupedHMIObjects Property (Page 2275)
Count Property (Page 2208)
Application Property (Page 2129)
Item Property (Page 2289)
HMIDefaultObjects Object (Listing)
Description
A listing of the following HMIObject objects:
Object VBA object name
Line HMILine
Polygon HMIPolygon
Polyline HMIPolyLine
Ellipse HMIEllipse
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1989
VBA for Automated Configuration
3.6 VBA Reference
Object VBA object name
Circle HMICircle
Ellipse segment HMIEllipseSegment
Pie segment HMIPieSegment
Ellipse arc HMIEllipseArc
Circular arc HMICircularArc
Rectangle HMIRectangle
Rounded rectangle HMIRoundRectangle
Application window HMIApplicationWindow
Screen Window HMIPictureWindow
Static text HMIStaticText
I/O Field HMIIOField
Button HMIButton
Check box HMICheckBox
Radio box HMIOptionGroup
Round button HMIRoundButton
Bar HMIBarGraph
Slider object HMISlider
Graphic Object HMIGraphicObject
Status display HMIStatusDisplay
Text list HMITextList
Connector HMIObjConnection
Multiple row text HMIMultiLineEdit
Combo box HMIComboBox
List box HMIListBox
Polygon tube HMITubePolyline
T-piece HMITubeTeeObject
Double T-piece HMITubeDoubleTeeObject
Tube bend HMITubeArcObject
3D bar HMI3DBarGraph
Group display HMIGroupDisplay
Faceplate instance HMIFaceplateObject
VBA object name
HMIDefaultObjects
WinCC: Scripting (VBS, ANSI-C, VBA)
1990 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the DefaultHMIObjects property to change the default property values of the included
objects. In this example all the objects contained in the listing will be output:
Sub ShowDefaultObjects()
'VBA267
Dim strType As String
Dim strName As String
Dim strMessage As String
Dim iMax As Integer
Dim iIndex As Integer
iMax = Application.DefaultHMIObjects.Count
iIndex = 1
For iIndex = 1 To iMax
With Application.DefaultHMIObjects(iIndex)
strType = .Type
strName = .ObjectName
strMessage = strMessage & "Element: " & iIndex & " / Objecttype: " & strType & " /
Objectname: " & strName
End With
If 0 = iIndex Mod 10 Then
MsgBox strMessage
strMessage = ""
Else
strMessage = strMessage & vbCrLf & vbCrLf
End If
Next iIndex
MsgBox "Element: " & iIndex & vbCrLf & "Objecttype: " & strType & vbCrLf & "Objectname: "
& strName
End Sub
See also
Button Object (Page 1926)
TextList Object (Page 2085)
StatusDisplay Object (Page 2074)
StaticText Object (Page 2071)
Slider object (Page 2066)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
PictureWindow Object (Page 2033)
OptionGroup Object (Page 2029)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1991
VBA for Automated Configuration
3.6 VBA Reference
Line Object (Page 2008)
IOField Object (Page 1996)
EllipseSegment Object (Page 1968)
EllipseArc Object (Page 1965)
Ellipse Object (Page 1962)
CircularArc Object (Page 1936)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
BarGraph Object (Page 1920)
ApplicationWindow Object (Page 1917)
VBA Reference (Page 1752)
Parent Property (Page 2364)
Count Property (Page 2208)
DefaultHMIObjects Property (Page 2217)
Application Property (Page 2129)
Item Property (Page 2289)
HMIObject Object
Description
Represents an object from the Object Palette of the Graphics Designer. The HMIObject object
is an element of the following listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
This object contains the object properties that apply to all standard, smart and Windows objects
(incl. Width, Height, Top and Left).
WinCC: Scripting (VBS, ANSI-C, VBA)
1992 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VBA Object Name
HMIObject
Usage
Use HMIObjects(Index), for instance, to return an individual HMIObject object. "For Index you
can use either the index number or the name of the object. In the following example the name
of the first object in the active picture is output:
Sub ShowFirstObjectOfCollection()
'VBA268
Dim strName As String
strName = ActiveDocument.HMIObjects(1).ObjectName
MsgBox strName
End Sub
Use the Delete method to remove an object from the HMIObjects listing. In the following
example the first object in the active picture will be removed:
Sub DeleteObject()
'VBA269
ActiveDocument.HMIObjects(1).Delete
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
Delete Method (Page 1837)
VBA Reference (Page 1752)
Default objects, Smart objects, Windows objects and Tube objects (Page 1672)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Type Property (Page 2453)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
TabOrderAlpha Property (Page 2431)
TabOrderSwitch Property (Page 2434)
Selected Property (Page 2415)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1993
VBA for Automated Configuration
3.6 VBA Reference
Properties Property (Page 2391)
PasswordLevel Property (Page 2367)
Parent Property (Page 2364)
Operation Property (Page 2358)
Left Property (Page 2311)
LDTooltipTexts Property (Page 2309)
Layer Property (Page 2299)
Height Property (Page 2276)
GroupParent Property (Page 2275)
Events Property (Page 2230)
Application Property (Page 2129)
ObjectName Property (Page 2353)
ConnectionPoints property (Page 2205)
HMIObjects Object (Listing)
Description
A listing of the HMIObject objects that represent all the objects in the picture.
VBA Object Name
HMIObjects
Note
The sequence of HMI objects in the HMIObjects list can be altered by adding and/or deleting
HMI objects.
The sequence of listing can also change if HMI objects are processed in the current listing.
This behavior can occur if the Layers property is modified and/or if the methods "SendToBack"
and "BringToFront" are used.
WinCC: Scripting (VBS, ANSI-C, VBA)
1994 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the HMIObjects property to return the HMIObjects listing. In the following example all the
object names in the active picture are output:
Sub ShowObjectsOfDocument()
'VBA270
Dim colObjects As HMIObjects
Dim objObject As HMIObject
Set colObjects = ActiveDocument.HMIObjects
For Each objObject In colObjects
MsgBox objObject.ObjectName
Next objObject
End Sub
Use the AddHMIObject method to create a new object in the picture. In the following example
a circle will be inserted into the active picture:
Sub AddCircle()
'VBA271
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_1", "HMICircle")
End Sub
Use the Find method to search for one or more objects in the picture. In the following example,
objects of the "HMICircle" type will be searched for in the active picture:
Sub FindObjectsByType()
'VBA272
Dim colSearchResults As HMICollection
Dim objMember As HMIObject
Dim iResult As Integer
Dim strName As String
Set colSearchResults = ActiveDocument.HMIObjects.Find(ObjectType:="HMICircle")
For Each objMember In colSearchResults
iResult = colSearchResults.Count
strName = objMember.ObjectName
MsgBox "Found: " & CStr(iResult) & vbCrLf & "Objectname: " & strName
Next objMember
End Sub
See also
Count Property (Page 2208)
HMIDefaultObjects Object (Listing) (Page 1989)
SelectedObjects object (Listing) (Page 2063)
Find Method (Page 1847)
AddOLEObject Method (Page 1810)
AddHMIObject Method (Page 1807)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1995
VBA for Automated Configuration
3.6 VBA Reference
AddActiveXControl Method (Page 1802)
How to edit Default objects, Smart objects, Windows objects and Tube objects (Page 1674)
VBA Reference (Page 1752)
Default objects, Smart objects, Windows objects and Tube objects (Page 1672)
Editing Objects with VBA (Page 1670)
Parent Property (Page 2364)
Application Property (Page 2129)
AddDotNetControl method (Page 1804)
AddWPFControl method (Page 1812)
Item Property (Page 2289)
IOField Object
Description
Represents the "I/O Field" object. The IOField object is an element of the following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIIOField
WinCC: Scripting (VBS, ANSI-C, VBA)
1996 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the Add method to create a new "I/O Field" object in a picture:
Sub AddIOField()
'VBA273
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IO-Field", "HMIIOField")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditIOField()
'VBA274
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects("IO-Field")
objIOField.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA275
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
Use the "HMIDefaultObjects(Index)" to return an object from the HMIDefaultObjects Listing:
Sub EditDefaultPropertiesOfIOField()
'VBA276
Dim objIOField As HMIIOField
Set objIOField = Application.DefaultHMIObjects("HMIIOField")
objIOField.BorderColor = RGB(255, 255, 0)
End Sub
See also
LimitMin Property (Page 2317)
ClearOnNew Property (Page 2188)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1997
VBA for Automated Configuration
3.6 VBA Reference
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
PasswordLevel Property (Page 2367)
OutputValue Property (Page 2363)
OutputFormat Property (Page 2362)
Orientation Property (Page 2361)
OperationReport Property (Page 2360)
OperationMessage Property (Page 2359)
Operation Property (Page 2358)
LimitMax Property (Page 2316)
Left Property (Page 2311)
Layer Property (Page 2299)
HiddenInput Property (Page 2278)
Height Property (Page 2276)
ForeFlashColorOn Property (Page 2268)
ForeFlashColorOff Property (Page 2267)
ForeColor Property (Page 2266)
FontUnderline Property (Page 2265)
FontSize Property (Page 2264)
FontName Property (Page 2263)
FontItalic Property (Page 2263)
FontBold Property (Page 2262)
FlashRateForeColor Property (Page 2257)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashForeColor Property (Page 2248)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
EditAtOnce Property (Page 2226)
DataFormat Property (Page 2216)
CursorControl Property (Page 2212)
WinCC: Scripting (VBS, ANSI-C, VBA)
1998 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
ClearOnError Property (Page 2187)
BoxType Property (Page 2172)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
AssumeOnFull Property (Page 2132)
AssumeOnExit Property (Page 2131)
AlignmentTop Property (Page 2126)
AlignmentLeft Property (Page 2125)
AdaptBorder Property (Page 2120)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
InputValue property (Page 2285)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 1999
VBA for Automated Configuration
3.6 VBA Reference
L-Q
LanguageFont Object
Description
Contains the font settings for the project language. The LanguageFont object is an element of
the LanguageFonts listing.
VBA Object Name
HMILanguageFont
Usage
Use LDFonts(Index) to return an individual LanguageFont object. In the following example a
Button object will be created and the name of the first configured font will be output:
Sub ShowFirstObjectOfCollection()
'VBA277
Dim strName As String
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button", "HMIButton")
strName = objButton.LDFonts(1).Family
MsgBox strName
End Sub
Object properties
The LanguageFont object possesses the following properties:
See also
LanguageFonts Object (Listing) (Page 2001)
VBA Reference (Page 1752)
Underlined Property (Page 2463)
Size Property (Page 2422)
Parent Property (Page 2364)
WinCC: Scripting (VBS, ANSI-C, VBA)
2000 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
LanguageID Property (Page 2296)
Italic Property (Page 2288)
Family Property (Page 2236)
Bold Property (Page 2158)
Application Property (Page 2129)
LanguageFonts Object (Listing)
Description
A listing of the LanguageFont objects that represent all the language-dependent fonts in an
object.
VBA Object Name
HMILanguageFonts
Usage
Use the LDFonts property to return the LanguageFonts listing. In the following example the
language identifiers of the configured fonts will be output:
Sub ShowLanguageFont()
'VBA278
Dim colLanguageFonts As HMILanguageFonts
Dim objLanguageFont As HMILanguageFont
Dim objButton As HMIButton
Dim iMax As Integer
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
Set colLanguageFonts = objButton.LDFonts
iMax = colLanguageFonts.Count
For Each objLanguageFont In colLanguageFonts
MsgBox "Planned fonts: " & iMax & vbCrLf & "Language-ID: " & objLanguageFont.LanguageID
Next objLanguageFont
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2001
VBA for Automated Configuration
3.6 VBA Reference
Use the ItemByLcid method to define the language for which it is intended to enter font settings.
The following example sets the font attributes of a button for French and English.
Note
For this example to work, you must already have configured in the languages concerned.
Sub ExampleForLanguageFonts()
'VBA279
Dim colLangFonts As HMILanguageFonts
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
objButton.Text = "DefText"
Set colLangFonts = objButton.LDFonts
'Adjust fontsettings for french:
With colLangFonts.ItemByLCID(1036)
.Family = "Courier New"
.Bold = True
.Italic = False
.Underlined = True
.Size = 12
End With
'Adjust fontsettings for english:
With colLangFonts.ItemByLCID(1033)
.Family = "Times New Roman"
.Bold = False
.Italic = True
.Underlined = False
.Size = 14
End With
End Sub
See also
LanguageFont Object (Page 2000)
ItemByLcid Method (Page 1867)
Item Method (Page 1865)
VBA Reference (Page 1752)
Parent Property (Page 2364)
Count Property (Page 2208)
Application Property (Page 2129)
WinCC: Scripting (VBS, ANSI-C, VBA)
2002 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
LanguageText Object
Description
Contains the multilingual labels for an object. The LanguageText object is an element of the
LanguageTexts listing.
VBA Object Name
HMILanguageText
Usage
In the following example a German label and an English label will be assigned to the button
called "myButton":
Sub AddLanguagesToButton()
'VBA280
Dim objLabelText As HMILanguageText
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
'
'Add text in actual datalanguage:
objButton.Text = "Actual-Language Text"
'
'Add english text:
Set objLabelText = ActiveDocument.HMIObjects("myButton").LDTexts.Add(1033, "English Text")
End Sub
See also
LanguageTexts Object (Listing) (Page 2004)
Delete Method (Page 1837)
VBA Reference (Page 1752)
Parent Property (Page 2364)
LanguageID Property (Page 2296)
DisplayText Property (Page 2223)
Application Property (Page 2129)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2003
VBA for Automated Configuration
3.6 VBA Reference
LanguageTexts Object (Listing)
Description
A listing of the LanguageText objects that represent all the multilingual texts in an object.
VBA Object Name
HMILanguageTexts
Usage
Use one of the following properties to return the LanguageTexts listing:
● LDLabelTexts Property
● LDNames Property
● LDStatusTexts Property
● LDTexts Property
● LDTooltipTexts Property
An example showing how to use the LanguageTexts listing can be found in this documentation
under the heading "LDStatusTexts Property".
Use the Add method to add multilingual texts to an object. In the following example a German
label and an English label will be assigned to the button called "myButton":
Sub AddLanguagesToButton()
'VBA281
Dim objLabelText As HMILanguageText
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
'
'Add text in actual datalanguage:
objButton.Text = "Actual-Language Text"
'
'Add english text:
Set objLabelText = ActiveDocument.HMIObjects("myButton").LDTexts.Add(1033, "English Text")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2004 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
LanguageText Object (Page 2003)
ItemByLcid Method (Page 1867)
Item Method (Page 1865)
VBA Reference (Page 1752)
Parent Property (Page 2364)
LDTooltipTexts Property (Page 2309)
LDTexts Property (Page 2309)
LDStatusTexts Property (Page 2307)
LDNames Property (Page 2307)
LDLabelTexts Property (Page 2305)
Count Property (Page 2208)
Application Property (Page 2129)
Layer Object
Description
Represents one of the 32 layers that are available in the picture.
VBA Object Name
HMILayer
Usage
Use the Layer object to define a name and the minimum and maximum zoom for a layer. You
define the visibility of layers separately by CS and RT layers:
● Document Object: Controls the visibility of the RT layers.
● View Object: Controls the visibility of the RT layers.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2005
VBA for Automated Configuration
3.6 VBA Reference
Use the Layers listing to return a Layer object. In the following example the settings for the
lowest layer are configured in the active picture:
Sub ConfigureSettingsOfLayer()
'VBA282
Dim objLayer As HMILayer
Set objLayer = ActiveDocument.Layers(1)
With objLayer
'configure "Layer 0"
.MinZoom = 10
.MaxZoom = 100
.Name = "Configured with VBA"
End With
End Sub
See also
Layers Property (Page 2303)
VBA Reference (Page 1752)
Editing Layers with VBA (Page 1666)
Visible Property (Page 2553)
Number Property (Page 2351)
Name Property (Page 2349)
MinZoom Property (Page 2346)
MaxZoom Property (Page 2329)
LDNames Property (Page 2307)
ActiveLayer Property (Page 2117)
Layers Object (Listing)
Description
A listing of the Layer objects that represent the 32 layers in the picture.
VBA Object Name
HMILayer
WinCC: Scripting (VBS, ANSI-C, VBA)
2006 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the LayersCS or LayersRT property to return the Layers listing. In the following example
the layer names in the copy of the active picture will be output:
Sub ShowLayer()
'VBA283
Dim colLayers As HMILayers
Dim objLayer As HMILayer
Dim strLayerList As String
Dim iCounter As Integer
iCounter = 1
Set colLayers = ActiveDocument.Layers
For Each objLayer In colLayers
If 1 = iCounter Mod 2 And 32 > iCounter Then
strLayerList = strLayerList & vbCrLf
ElseIf 11 > iCounter Then
strLayerList = strLayerList & " "
Else
strLayerList = strLayerList & " "
End If
strLayerList = strLayerList & objLayer.Name
iCounter = iCounter + 1
Next objLayer
MsgBox strLayerList
End Sub
See also
Layer Object (Page 2005)
Item Method (Page 1865)
VBA Reference (Page 1752)
Parent Property (Page 2364)
Count Property (Page 2208)
Application Property (Page 2129)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2007
VBA for Automated Configuration
3.6 VBA Reference
Line Object
Description
Represents the "Line" object. The Line object is an element of the following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMILine
Usage
Use the Add method to create a new "Line" object in a picture:
Sub AddLine()
'VBA285
Dim objLine As HMILine
Set objLine = ActiveDocument.HMIObjects.AddHMIObject("Line1", "HMILine")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditLine()
'VBA286
Dim objLine As HMILine
Set objLine = ActiveDocument.HMIObjects("Line1")
objLine.BorderColor = RGB(255, 0, 0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2008 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA287
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name of the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
AddHMIObject Method (Page 1807)
BorderBackColor Property (Page 2159)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
RotationAngle Property (Page 2403)
ReferenceRotationTop Property (Page 2400)
ReferenceRotationLeft Property (Page 2399)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Index Property (Page 2283)
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
FlashBorderColor Property (Page 2247)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2009
VBA for Automated Configuration
3.6 VBA Reference
BorderEndStyle Property (Page 2163)
BorderColor Property (Page 2160)
ActualPointTop Property (Page 2119)
ActualPointLeft Property (Page 2118)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
ListBox object
Description
0XOWLSOH2EMHFWV
+0,'HIDXOW2EMHFWV
+0,2EMHFWV /LVW%R[
6HOHFWLRQ
WinCC: Scripting (VBS, ANSI-C, VBA)
2010 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Represents the "ListBox" object. The ListBox object is an element of the following listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all default, smart, window and
tube objects.
VBA object name
HMIListBox
Usage
Use the Add method to create a new "ListBox" object in a picture:
Sub AddListBox()
'VBA829
Dim objListBox As HMIListBox
Set objListBox = ActiveDocument.HMIObjects.AddHMIObject("ListBox", "HMIListBox")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditListBox()
'VBA830
Dim objListBox As HMIListBox
Set objListBox = ActiveDocument.HMIObjects("ListBox")
objListBox.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA831
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
ObjectName Property (Page 2353)
Layer Property (Page 2299)
Left Property (Page 2311)
Top Property (Page 2449)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2011
VBA for Automated Configuration
3.6 VBA Reference
Width Property (Page 2556)
Height Property (Page 2276)
NumberLines Property (Page 2352)
ForeColor Property (Page 2266)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackColor Property (Page 2139)
FillColor Property (Page 2238)
BorderStyle Property (Page 2167)
BorderWidth Property (Page 2168)
FillStyle Property (Page 2242)
GlobalShadow property (Page 2270)
FontName Property (Page 2263)
FontSize Property (Page 2264)
FontBold Property (Page 2262)
FontItalic Property (Page 2263)
FontUnderline Property (Page 2265)
AlignmentLeft Property (Page 2125)
Index Property (Page 2283)
Text Property (Page 2440)
Operation Property (Page 2358)
PasswordLevel Property (Page 2367)
Visible Property (Page 2553)
ToolTipText Property (Page 2448)
OperationMessage Property (Page 2359)
OperationReport Property (Page 2360)
SelIndex property (Page 2417)
SelText property (Page 2417)
Application Property (Page 2129)
Events Property (Page 2230)
GroupParent Property (Page 2275)
LDFonts Property (Page 2304)
LDTexts Property (Page 2309)
LDTooltipTexts Property (Page 2309)
Parent Property (Page 2364)
WinCC: Scripting (VBS, ANSI-C, VBA)
2012 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Type Property (Page 2453)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
Textlist property (Page 2441)
Menu Object
Description
Represents the "User Defined Menu" object. The Menu object is an element of the
CustomMenus listing.
VBA Object Name
HMIMenu
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2013
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use CustomMenus(Index) to return an individual Menu object. "For Index you can use either
the index number or the name of the object. In order for the following example to work, create
a user defined menu. For an example of this, please refer to "Creating a New Application-
Specific Menu" in this documentation. In the following example the name of the first user-
defined menu in the active picture will be output:
Sub ShowFirstMenuOfMenucollection()
'VBA288
Dim strName As String
strName = ActiveDocument.CustomMenus(1).Label
MsgBox strName
End Sub
Use the Delete method to remove a "Menu" object from the "CustomMenus" listing. In the
following example the first user-defined menu in the active picture will be removed:
Sub DeleteMenu()
'VBA289
Dim objMenu As HMIMenu
Set objMenu = ActiveDocument.CustomMenus(1)
objMenu.Delete
End Sub
See also
Menus Object (Listing) (Page 2015)
Delete Method (Page 1837)
How to Create Picture-specific Menus and Toolbars (Page 1665)
How to Create a New Application-Specific Menu (Page 1633)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
Visible Property (Page 2553)
StatusText Property (Page 2428)
Position Property (Page 2383)
Parent Property (Page 2364)
MenuItems Property (Page 2342)
LDStatusTexts Property (Page 2307)
LDLabelTexts Property (Page 2305)
Label Property (Page 2295)
Key Property (Page 2293)
WinCC: Scripting (VBS, ANSI-C, VBA)
2014 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Enabled Property (Page 2227)
Application Property (Page 2129)
Menus Object (Listing)
Description
A listing of the Menu objects that represent all the user-defined menus in the Graphics
Designer.
VBA Object Name
HMIMenus
Usage
Use the CustomMenus property to return the Menus listing. In the following example all the
user-defined menus in the active picture will be output.
Note
The Menus listing does not distinguish between application-specific and picture-specific menus
in the output.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2015
VBA for Automated Configuration
3.6 VBA Reference
Sub ShowCustomMenusOfDocument()
'VBA290
Dim colMenus As HMIMenus
Dim objMenu As HMIMenu
Dim strMenuList As String
Set colMenus = ActiveDocument.CustomMenus
For Each objMenu In colMenus
strMenuList = strMenuList & objMenu.Label & vbCrLf
Next objMenu
MsgBox strMenuList
End Sub
Use the Application property and the InsertMenu method if you want to create an application-
specific menu. Create the VBA code in either the "Project Template" document or the "Global
Template" document. In the following example a user-defined menu called
"myApplicationMenu" will be created:
Sub InsertApplicationSpecificMenu()
'VBA291
Dim objMenu As HMIMenu
Set objMenu = Application.CustomMenus.InsertMenu(1, "a_Menu1", "myApplicationMenu")
End Sub
Use the ActiveDocument property and the InsertMenu method if you want to create a picture-
specific menu. Create the VBA code in the document called "ThisDocument": In the following
example a picture-specific menu called "myDocumentMenu" will be created:;
Sub InsertDocumentSpecificMenu()
'VBA292
Dim objMenu As HMIMenu
Set objMenu = ActiveDocument.CustomMenus.InsertMenu(1, "d_Menu1", "myDocumentMenu")
End Sub
See also
Menu Object (Page 2013)
Item Method (Page 1865)
InsertMenu Method (Page 1856)
How to Create Picture-specific Menus and Toolbars (Page 1665)
How to Create a New Application-Specific Menu (Page 1633)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
Parent Property (Page 2364)
Count Property (Page 2208)
Application Property (Page 2129)
WinCC: Scripting (VBS, ANSI-C, VBA)
2016 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
MenuItem Object
Description
Represents a menu entry for a user-defined menu in the Graphics Designer. The MenuItem
object is an element of the MenuItems listing.
VBA Object Name
HMIMenuItem
Usage
Note
In order for the examples to work, first create a user-defined menu. For an example of this,
please refer to "Adding a New Entry to the Menu" in this documentation.
Use MenuItems(Index) to return an individual MenuItem object. "For Index you can use either
the index number or the name of the object. In the following example the first entry in the first
user-defined menu in the active picture will be output:
Sub ShowFirstObjectOfCollection()
'VBA293
Dim strName As String
strName = ActiveDocument.CustomMenus(1).MenuItems(1).Label
MsgBox strName
End Sub
Use the Delete method to remove an object from the "MenuItems" listing. In the following
example the first entry in the first user-defined menu in the active picture will be deleted:
Sub DeleteMenuItem()
'VBA294
ActiveDocument.CustomMenus(1).MenuItems(1).Delete
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2017
VBA for Automated Configuration
3.6 VBA Reference
See also
Parent Property (Page 2364)
MenuItems Object (Listing) (Page 2019)
Delete Method (Page 1837)
Configuring Menus and Toolbars (Page 1630)
How to assign VBA macros to menus and toolbars (Page 1645)
How to assign help texts to menus and toolbars (Page 1643)
How to add a new menu entry to a menu (Page 1635)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
Visible Property (Page 2553)
Tag Property (Page 2435)
SubMenu Property (Page 2429)
StatusText Property (Page 2428)
ShortCut Property (Page 2419)
Position Property (Page 2383)
MenuItemType Property (Page 2343)
Macro Property (Page 2326)
LDStatusTexts Property (Page 2307)
LDLabelTexts Property (Page 2305)
Label Property (Page 2295)
Key Property (Page 2293)
Icon Property (Page 2281)
Enabled Property (Page 2227)
Checked Property (Page 2179)
Application Property (Page 2129)
WinCC: Scripting (VBS, ANSI-C, VBA)
2018 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
MenuItems Object (Listing)
Description
A listing of the MenuItem objects that represent all the entries in a user-defined menu.
Usage
Note
In order for the examples to work, first create a user-defined menu. For an example of this,
please refer to "Adding a New Entry to the Menu" in this documentation.
Use the MenuItems property to return the MenuItems listing. In the following example all the
entries in the first user-defined menu in the active picture will be output:
Note
The MenuItems listing does not distinguish between an application-specific and a picture-
specific menu in the output.
Sub ShowMenuItems()
'VBA295
Dim colMenuItems As HMIMenuItems
Dim objMenuItem As HMIMenuItem
Dim strItemList As String
Set colMenuItems = ActiveDocument.CustomMenus(1).MenuItems
For Each objMenuItem In colMenuItems
strItemList = strItemList & objMenuItem.Label & vbCrLf
Next objMenuItem
MsgBox strItemList
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2019
VBA for Automated Configuration
3.6 VBA Reference
Use the InsertMenuItem method, for instance, to insert an entry into an existing user-defined
menu. In the following example the picture-specific menu "DocMenu2" will be created in the
active picture and the menu entry "MenuItem1" is inserted:
Sub InsertMenuItem()
'VBA296
Dim objMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Set objMenu = ActiveDocument.CustomMenus.InsertMenu(2, "d_Menu2", "DocMenu2")
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(1, "m_Item2_1", "MenuItem 1")
End Sub
See also
InsertSubmenu Method (Page 1860)
MenuItem Object (Page 2017)
InsertSeparator Method (Page 1859)
InsertMenuItem Method (Page 1858)
How to add a new menu entry to a menu (Page 1635)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
Parent Property (Page 2364)
Count Property (Page 2208)
Application Property (Page 2129)
MultiLineEdit object
Description
0XOWLSOH2EMHFWV
+0,'HIDXOW2EMHFWV
+0,2EMHFWV 0XOWL/LQH(GLW
6HOHFWLRQ
WinCC: Scripting (VBS, ANSI-C, VBA)
2020 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Represents the "MultiLineEdit" object. The MultiLineEdit object is an element of the following
listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all default, smart, window and
tube objects.
VBA object name
HMIMultiLineEdit
Usage
Use the Add method to create a new "MultiLineEdit" object in a picture:
Sub AddMultiLineEdit()
'VBA832
Dim objMultiLineEdit As HMIMultiLineEdit
Set objMultiLineEdit = ActiveDocument.HMIObjects.AddHMIObject("MultiLineEdit",
"HMIMultiLineEdit")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditMultiLineEdit()
'VBA833
Dim objMultiLineEdit As HMIMultiLineEdit
Set objMultiLineEdit = ActiveDocument.HMIObjects("MultiLineEdit")
objMultiLineEdit.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA834
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
Layer Property (Page 2299)
Left Property (Page 2311)
BorderColor Property (Page 2160)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2021
VBA for Automated Configuration
3.6 VBA Reference
BorderBackColor Property (Page 2159)
BorderStyle Property (Page 2167)
BorderWidth Property (Page 2168)
BackColor Property (Page 2139)
FontName Property (Page 2263)
FontSize Property (Page 2264)
FontBold Property (Page 2262)
FontItalic Property (Page 2263)
FontUnderline Property (Page 2265)
ForeColor Property (Page 2266)
AlignmentLeft Property (Page 2125)
Top Property (Page 2449)
Width Property (Page 2556)
Height Property (Page 2276)
Text Property (Page 2440)
Operation Property (Page 2358)
PasswordLevel Property (Page 2367)
Visible Property (Page 2553)
ToolTipText Property (Page 2448)
ObjectName Property (Page 2353)
GlobalShadow property (Page 2270)
Application Property (Page 2129)
GroupParent Property (Page 2275)
LDFonts Property (Page 2304)
LDTexts Property (Page 2309)
LDTooltipTexts Property (Page 2309)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Type Property (Page 2453)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
2022 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
ObjConnection object
Description
Represents the "Connector" object. The ObjConnection object is an element of the following
listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
Note
You have read-only access to the properties of the ObjConnection object.
VBA Object Name
HMIObjConnection
Application
From the properties of the ObjConnection object you can find out which objects are connected.
Example
In order for the following example to work you must have connected two objects to the
connector in the active picture of the Graphics Designer. You can find the Connector object in
the Graphics Designer in the Object Palette under "Standard Objects". For this example to
work, give the connector the name "Connector1".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2023
VBA for Automated Configuration
3.6 VBA Reference
In the user-defined menu "Connector Info" you can click on the "Connector Info" entry and
display the objects connected via the connector:
WinCC: Scripting (VBS, ANSI-C, VBA)
2024 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Sub ShowConnectorInfo_Menu()
'VBA297
Dim objMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Dim strDocName As String
strDocName = Application.ApplicationDataPath & ActiveDocument.Name
Set objMenu = Documents(strDocName).CustomMenus.InsertMenu(1, "ConnectorMenu",
"Connector_Info")
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(1, "ShowConnectInfo", "Info Connector")
End Sub
Sub ShowConnectorInfo()
Dim objConnector As HMIObjConnection
Dim iStart As Integer
Dim iEnd As Integer
Dim strStart As String
Dim strEnd As String
Dim strObjStart As String
Dim strObjEnd As String
Set objConnector = ActiveDocument.HMIObjects("Connector1")
iStart = objConnector.BottomConnectedConnectionPointIndex
iEnd = objConnector.TopConnectedConnectionPointIndex
strObjStart = objConnector.BottomConnectedObjectName
strObjEnd = objConnector.TopConnectedObjectName
Select Case iStart
Case 0
strStart = "top"
Case 1
strStart = "right"
Case 2
strStart = "bottom"
Case 3
strStart = "left"
End Select
Select Case iEnd
Case 0
strEnd = "top"
Case 1
strEnd = "right"
Case 2
strEnd = "bottom"
Case 3
strEnd = "left"
End Select
MsgBox "The selected connector links the objects " & vbCrLf & "'" & strObjStart & "' and '"
& strObjEnd & "'" & vbCrLf & "Connected points: " & vbCrLf & strObjStart & ": " & strStart
& vbCrLf & strObjEnd & ": " & strEnd
End Sub
Private Sub Document_MenuItemClicked(ByVal MenuItem As IHMIMenuItem)
Select Case MenuItem.Key
Case "ShowConnectInfo"
Call ShowConnectorInfo
End Select
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2025
VBA for Automated Configuration
3.6 VBA Reference
See also
TopConnectedConnectionPointIndex Property (Page 2450)
TopConnectedObjectName Property (Page 2449)
BottomConnectedConnectionPointIndex Property (Page 2170)
BottomConnectedObjectName Property (Page 2169)
Application Property (Page 2129)
BorderBackColor Property (Page 2159)
BorderColor Property (Page 2160)
BorderEndStyle Property (Page 2163)
BorderFlashColorOff Property (Page 2164)
BorderFlashColorOn Property (Page 2166)
BorderStyle Property (Page 2167)
BorderWidth Property (Page 2168)
Events Property (Page 2230)
FlashBorderColor Property (Page 2247)
FlashRateBorderColor Property (Page 2255)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
Height Property (Page 2276)
Layer Property (Page 2299)
LDTooltipTexts Property (Page 2309)
Left Property (Page 2311)
ObjectName Property (Page 2353)
Operation Property (Page 2358)
Orientation Property (Page 2361)
Parent Property (Page 2364)
PasswordLevel Property (Page 2367)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
ToolTipText Property (Page 2448)
Top Property (Page 2449)
Transparency property (Page 2450)
WinCC: Scripting (VBS, ANSI-C, VBA)
2026 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Type Property (Page 2453)
Visible Property (Page 2553)
Width Property (Page 2556)
ConnectorType property (Page 2207)
ConnectionPoints property (Page 2205)
Display property (Page 2221)
ConnectorObjects property (Page 2206)
OLEObject Object
Description
Represents the object called "OLE Element". The OLEObject object is an element of the
following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
VBA Object Name
HMIOLEObject
Usage
Use the AddOLEObject method to create a new "OLE Element" object in a picture: In the
following example an OLE Element containing a Wordpad document will be inserted into the
active picture:
Sub AddOLEObjectToActiveDocument()
'VBA298
Dim objOleObject As HMIOLEObject
Set objOleObject = ActiveDocument.HMIObjects.AddOLEObject("Wordpad Document",
"Wordpad.Document.1")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2027
VBA for Automated Configuration
3.6 VBA Reference
Use "HMIObjects(Index)" to return an object from the HMIObjects listing, where "Index" in this
case identifies the object by name: In this example the X coordinate of the OLE Element
"Wordpad Document" is set to 140:
Sub EditOLEObject()
'VBA299
Dim objOleObject As HMIOLEObject
Set objOleObject = ActiveDocument.HMIObjects("Wordpad Document")
objOleObject.Left = 140
End Sub
Use "Selection(Index)" to return an object from the Selection listing. "For Index you can use
either the index number or the name of the object. In this example the name of the first selected
object will be output:
Sub ShowNameOfFirstSelectedObject()
'VBA300
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name of the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
How to Create Picture-specific Menus and Toolbars (Page 1665)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
Delete Method (Page 1837)
AddOLEObject Method (Page 1810)
How to Create an Application-specific Toolbar (Page 1639)
VBA Reference (Page 1752)
OLE Objects (Page 1677)
Application Property (Page 2129)
Events Property (Page 2230)
GroupParent Property (Page 2275)
Height Property (Page 2276)
Layer Property (Page 2299)
LDTooltipTexts Property (Page 2309)
Left Property (Page 2311)
ObjectName Property (Page 2353)
Operation Property (Page 2358)
WinCC: Scripting (VBS, ANSI-C, VBA)
2028 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parent Property (Page 2364)
PasswordLevel Property (Page 2367)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
ToolTipText Property (Page 2448)
Top Property (Page 2449)
Type Property (Page 2453)
Visible Property (Page 2553)
Width Property (Page 2556)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
OptionGroup Object
Description
Represents the "Radio Box" object. The OptionGroup object is an element of the following
listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIOptionGroup
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2029
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the Add method to create a new "Option Group" object in a picture:
Sub AddOptionGroup()
'VBA301
Dim objOptionGroup As HMIOptionGroup
Set objOptionGroup = ActiveDocument.HMIObjects.AddHMIObject("Radio-Box", "HMIOptionGroup")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditOptionGroup()
'VBA302
Dim objOptionGroup As HMIOptionGroup
Set objOptionGroup = ActiveDocument.HMIObjects("Radio-Box")
objOptionGroup.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA303
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name of the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
Left Property (Page 2311)
BorderStyle Property (Page 2167)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
Text Property (Page 2440)
WinCC: Scripting (VBS, ANSI-C, VBA)
2030 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Process Property (Page 2387)
PasswordLevel Property (Page 2367)
Orientation Property (Page 2361)
OperationMessage Property (Page 2359)
Operation Property (Page 2358)
Layer Property (Page 2299)
Index Property (Page 2283)
Height Property (Page 2276)
ForeFlashColorOn Property (Page 2268)
ForeFlashColorOff Property (Page 2267)
ForeColor Property (Page 2266)
FontUnderline Property (Page 2265)
FontSize Property (Page 2264)
FontName Property (Page 2263)
FontItalic Property (Page 2263)
FontBold Property (Page 2262)
FlashRateForeColor Property (Page 2257)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashForeColor Property (Page 2248)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
FillingIndex Property (Page 2240)
Filling Property (Page 2239)
FillColor Property (Page 2238)
BoxCount Property (Page 2171)
BoxAlignment Property (Page 2170)
BorderWidth Property (Page 2168)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2031
VBA for Automated Configuration
3.6 VBA Reference
BackColor Property (Page 2139)
AlignmentTop Property (Page 2126)
AlignmentLeft Property (Page 2125)
AdaptBorder Property (Page 2120)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDFonts Property (Page 2304)
LDTexts Property (Page 2309)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
WindowsStyle property (Page 2559)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
Textlist property (Page 2441)
WinCC: Scripting (VBS, ANSI-C, VBA)
2032 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
PictureWindow Object
Description
Represents the "Picture Window" object. The PictureWindow object is an element of the
following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIPictureWindow
Usage
Use the Add method to create a new "Picture Window" object in a picture:
Sub AddPictureWindow()
'VBA304
Dim objPictureWindow As HMIPictureWindow
Set objPictureWindow = ActiveDocument.HMIObjects.AddHMIObject("PictureWindow1",
"HMIPictureWindow")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditPictureWindow()
'VBA305
Dim objPictureWindow As HMIPictureWindow
Set objPictureWindow = ActiveDocument.HMIObjects("PictureWindow1")
objPictureWindow.Sizeable = True
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2033
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA306
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name of the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
MaximizeButton Property (Page 2328)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Zoom Property (Page 2562)
WindowBorder Property (Page 2558)
Width Property (Page 2556)
Visible Property (Page 2553)
UpdateCycle Property (Page 2466)
Top Property (Page 2449)
TagPrefix Property (Page 2437)
Sizeable Property (Page 2423)
ServerPrefix Property (Page 2419)
ScrollPositionY Property (Page 2412)
ScrollPositionX Property (Page 2411)
ScrollBars Property (Page 2410)
PictureName Property (Page 2377)
OnTop Property (Page 2357)
OffsetTop Property (Page 2356)
OffsetLeft Property (Page 2356)
Moveable Property (Page 2348)
Left Property (Page 2311)
Layer Property (Page 2299)
WinCC: Scripting (VBS, ANSI-C, VBA)
2034 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Height Property (Page 2276)
CloseButton Property (Page 2189)
CaptionText property (Page 2176)
Caption Property (Page 2175)
AdaptSize Property (Page 2121)
AdaptPicture Property (Page 2120)
Application Property (Page 2129)
Events Property (Page 2230)
GroupParent Property (Page 2275)
IndependentWindow property (Page 2282)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Operation Property (Page 2358)
Parent Property (Page 2364)
PasswordLevel Property (Page 2367)
Properties Property (Page 2391)
Selected Property (Page 2415)
ToolTipText Property (Page 2448)
Type Property (Page 2453)
WindowMonitorNumber property (Page 2559)
WindowPositionMode property (Page 2559)
ConnectionPoints property (Page 2205)
MenuToolBarConfig Property (Page 2344)
TitleBackColorActiveEnd property (Page 2442)
TitleBackColorActiveStart property (Page 2442)
TitleBackColorInactiveEnd property (Page 2443)
TitleBackColorInactiveStart property (Page 2443)
TitleForeColorActive property (Page 2443)
TitleForeColorInactive property (Page 2443)
Pinnable property (Page 2382)
Pinned property (Page 2382)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2035
VBA for Automated Configuration
3.6 VBA Reference
PieSegment Object
Description
Represents the "Pie Segment" object. The PieSegment object is an element of the following
listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIPieSegment
Usage
Use the Add method to create a new "Pie Segment" object in a picture:
Sub AddPieSegment()
'VBA307
Dim objPieSegment As HMIPieSegment
Set objPieSegment = ActiveDocument.HMIObjects.AddHMIObject("PieSegment1", "HMIPieSegment")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditPieSegment()
'VBA308
Dim objPieSegment As HMIPieSegment
Set objPieSegment = ActiveDocument.HMIObjects("PieSegment1")
objPieSegment.BorderColor = RGB(255, 0, 0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2036 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA309
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
Filling Property (Page 2239)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
StartAngle Property (Page 2428)
Radius Property (Page 2397)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
FillingIndex Property (Page 2240)
FillColor Property (Page 2238)
EndAngle Property (Page 2229)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2037
VBA for Automated Configuration
3.6 VBA Reference
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
2038 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Polygon Object
Description
Represents the "Polygon" object. The Polygon object is an element of the following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIPolygon
Usage
Use the Add method to create a new "Polygon" object in a picture:
Sub AddPolygon()
'VBA310
Dim objPolygon As HMIPolygon
Set objPolygon = ActiveDocument.HMIObjects.AddHMIObject("Polygon", "HMIPolygon")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditPolygon()
'VBA311
Dim objPolygon As HMIPolygon
Set objPolygon = ActiveDocument.HMIObjects("Polygon")
objPolygon.BorderColor = RGB (255, 0, 0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2039
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA312
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
ToolTipText Property (Page 2448)
BorderBackColor Property (Page 2159)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
RotationAngle Property (Page 2403)
ReferenceRotationTop Property (Page 2400)
ReferenceRotationLeft Property (Page 2399)
PointCount Property (Page 2382)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Index Property (Page 2283)
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
WinCC: Scripting (VBS, ANSI-C, VBA)
2040 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
FillingIndex Property (Page 2240)
Filling Property (Page 2239)
FillColor Property (Page 2238)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
ActualPointTop Property (Page 2119)
ActualPointLeft Property (Page 2118)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2041
VBA for Automated Configuration
3.6 VBA Reference
PolyLine Object
Description
Represents the "Polyline" object. The PolyLine object is an element of the following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIPolyLine
Usage
Use the Add method to create a new "Polyline" object in a picture:
Sub AddPolyLine()
'VBA313
Dim objPolyLine As HMIPolyLine
Set objPolyLine = ActiveDocument.HMIObjects.AddHMIObject("PolyLine1", "HMIPolyLine")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditPolyLine()
'VBA314
Dim objPolyLine As HMIPolyLine
Set objPolyLine = ActiveDocument.HMIObjects("PolyLine1")
objPolyLine.BorderColor = RGB(255, 0, 0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2042 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA315
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name of the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
Use the "HMIDefaultObjects(Index)" to return an object from the HMIDefaultObjects Listing:
Sub EditDefaultPropertiesOfPolyLine()
'VBA316
Dim objPolyLine As HMIPolyLine
Set objPolyLine = Application.DefaultHMIObjects("HMIPolyLine")
objPolyLine.BorderColor = RGB(255, 255, 0)
End Sub
See also
HMIDefaultObjects Object (Listing) (Page 1989)
BorderEndStyle Property (Page 2163)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
RotationAngle Property (Page 2403)
ReferenceRotationTop Property (Page 2400)
ReferenceRotationLeft Property (Page 2399)
PointCount Property (Page 2382)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Index Property (Page 2283)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2043
VBA for Automated Configuration
3.6 VBA Reference
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
FlashBorderColor Property (Page 2247)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
ActualPointTop Property (Page 2119)
ActualPointLeft Property (Page 2118)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
WinCC: Scripting (VBS, ANSI-C, VBA)
2044 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Properties Object (Listing)
Description
A listing of the Property objects that represent all the properties of an object.
VBA Object Name
HMIProperties
Usage
Use the Properties(Index) property in order to return a Property object if you cannot access
an object property directly. For "Index" you can use either the index number or the VBA property
name of the object. In the following example the Properties property has to be used to access
the individual properties of a circle. The circle will be inserted into the picture as an HMIObject
object:
Sub AddObject()
'VBA319
Dim objObject As HMIObject
Set objObject = ActiveDocument.HMIObjects.AddHMIObject("CircleAsHMIObject", "HMICircle")
'
'Standard properties (e.g. "Position") are available every time:
objObject.Top = 40
objObject.Left = 40
'
'Individual properties have to be called using
'property "Properties":
objObject.Properties("FlashBackColor") = True
End Sub
See also
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Parent Property (Page 2364)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2045
VBA for Automated Configuration
3.6 VBA Reference
Count Property (Page 2208)
Application Property (Page 2129)
Item Property (Page 2289)
Property Object
Description
Represents the property of an object. In the case of the Property object the use of the Value
property is set as the default. For this reason you can use the following notation in order for
example to assign a new value to an object property:
<Object>.<Property> = <Value>
You can use the "Dynamic" property in order to make an object property dynamic with VBA.
Use the "Events" listing in order to configure actions with VBA.
The Property object is an element of the Properties listing.
VBA Object Name
HMIProperty
Usage
Use Properties(Index) to return an individual Property object. For "Index" you can use either
the index number or the name of the object property. In the following example the name of the
first property of the Circle object will be output:
Sub ShowFirstObjectOfCollection()
'VBA317
Dim objCircle As HMICircle
Dim strName As String
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle", "HMICircle")
strName = objCircle.Properties(1).Name
MsgBox strName
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2046 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use the CreateDynamic method to make an object property dynamic. In the following example
the "Radius" property of a circle object will be made dynamic with the aid of the tag "Otto",
which is updated every two seconds:
Sub DynamicToRadiusOfNewCircle()
'VBA318
Dim objVariableTrigger As HMIVariableTrigger
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects("Circle")
Set objVariableTrigger =
objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeVariableDirect, "NewDynamic1")
objVariableTrigger.CycleType = hmiCycleType_2s
End Sub
See also
DisplayName Property (Page 2221)
Properties Object (Listing) (Page 2045)
DeleteDynamic Method (Page 1839)
CreateDynamic Method (Page 1833)
VBA Reference (Page 1752)
Creating Dynamics with VBA (Page 1694)
Editing Objects with VBA (Page 1670)
Value Property (Page 2472)
Parent Property (Page 2364)
Name Property (Page 2349)
IsDynamicable Property (Page 2287)
Events Property (Page 2230)
Dynamic Property (Page 2225)
Application Property (Page 2129)
IsPublished property (Page 2287)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2047
VBA for Automated Configuration
3.6 VBA Reference
QualityCodeStateValue Object
Description
Represents the quality code of a tag which is assigned in the dynamic dialog and used for
dynamization.
VBA Object Name
HMIQualityCodeStateValue
Object properties
The object QualityCodeStateValue has the following properties:
● Application
● Parent
● VALUE_BAD_COMMLUV
● VALUE_BAD_COMMLUV
● VALUE_BAD_CONFERROR
● VALUE_BAD_DEVICE
● VALUE_BAD_MISCSTATES
● VALUE_BAD_NONSPECIFIC
● VALUE_BAD_NOTCONNECTED
● VALUE_BAD_OUTOFSERV
● VALUE_BAD_PROCRELNOM
● VALUE_BAD_PROCRELSUB
● VALUE_HIGHLIMITED
● VALUE_LOWLIMITED
● VALUE_UNCERT_ENGVHIGHLIM
● VALUE_UNCERT_ENGVLOWLIM
● VALUE_UNCERT_ENGVONLIM
● VALUE_UNCERT_INITVAL
● VALUE_UNCERT_LUV
WinCC: Scripting (VBS, ANSI-C, VBA)
2048 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
● VALUE_UNCERT_MAINTDEM
● VALUE_UNCERT_MISCSTATES
● VALUE_UNCERT_NONSPECIFIC
● VALUE_UNCERT_PROCRELNOM
● VALUE_UNCERT_SIMVAL
● VALUE_UNCERT_SUBSTSET
● VarName
See also
VALUE_BAD_CONFERROR Property (Page 2481)
VBA Reference (Page 1752)
VarName Property (Page 2551)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2049
VBA for Automated Configuration
3.6 VBA Reference
Parent Property (Page 2364)
Application Property (Page 2129)
QualityCodeStateValues Object (Listing)
Description
A listing of QualityCodeStateValue objects which contain all quality codes in Dynamic dialog
and are used for dynamization.
VBA Object Name
HMIQualityCodeStateValues
WinCC: Scripting (VBS, ANSI-C, VBA)
2050 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Application
For example, use the Item property to define values in Dynamic dialog which will be used for
dynamization when the specified tag returns the configured quality code. In the following
example the radius of a circle is given dynamics with the dynamic dialog. Dynamization uses
the analysis of the quality code of a tag. If the tag fails to return a quality code, a substitute
value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA813
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'Activate qualitycode-statecheck
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
Object properties
The object QualityCodeStateValues has the following properties:
● Application
● Count
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2051
VBA for Automated Configuration
3.6 VBA Reference
● Item
● Parent
See also
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VBA Reference (Page 1752)
VarName Property (Page 2551)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
Parent Property (Page 2364)
Item Property (Page 2289)
Count Property (Page 2208)
Application Property (Page 2129)
WinCC: Scripting (VBS, ANSI-C, VBA)
2052 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
R-Z
Rectangle Object
Description
Represents the "Rectangle" object. The Rectangle object is an element of the following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIRectangle
Usage
Use the Add method to create a new "Rectangle" object in a picture:
Sub AddRectangle()
'VBA320
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditRectangle()
'VBA321
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects("Rectangle1")
objRectangle.BorderColor = RGB(255, 0, 0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2053
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA322
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name of the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
FillingIndex Property (Page 2240)
Filling Property (Page 2239)
FillColor Property (Page 2238)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
WinCC: Scripting (VBS, ANSI-C, VBA)
2054 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
RoundButton Object
Description
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2055
VBA for Automated Configuration
3.6 VBA Reference
Represents the "Round Button" object. The RoundButton object is an element of the following
listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIRoundButton
Usage
Use the Add method to create a new "Round Button" object in a picture:
Sub AddRoundButton()
'VBA323
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects.AddHMIObject("Roundbutton1",
"HMIRoundButton")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditRoundButton()
'VBA324
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects("Roundbutton1")
objRoundButton.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing.:
Sub ShowNameOfFirstSelectedObject()
'VBA325
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
ToolTipText Property (Page 2448)
FlashBackColor Property (Page 2246)
SelectedObjects object (Listing) (Page 2063)
WinCC: Scripting (VBS, ANSI-C, VBA)
2056 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
Toggle Property (Page 2444)
Radius Property (Page 2397)
Pressed Property (Page 2386)
PicUpUseTransColor Property (Page 2380)
PicUpTransparent Property (Page 2380)
PicUpReferenced Property (Page 2379)
PictureUp Property (Page 2378)
PictureDown Property (Page 2376)
PictureDeactivated Property (Page 2376)
PicDownUseTransColor Property (Page 2373)
PicDownTransparent Property (Page 2373)
PicDownReferenced Property (Page 2372)
PicDeactUseTransColor Property (Page 2371)
PicDeactTransparent Property (Page 2371)
PicDeactReferenced-Eigenschaft (Page 2370)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashBorderColor Property (Page 2247)
FillStyle Property (Page 2242)
FillingIndex Property (Page 2240)
Filling Property (Page 2239)
FillColor Property (Page 2238)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2057
VBA for Automated Configuration
3.6 VBA Reference
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColorTop Property (Page 2162)
BorderColor Property (Page 2160)
BorderColorBottom Property (Page 2162)
BorderBackColor Property (Page 2159)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
BackBorderWidth Property (Page 2138)
AlignmentLeft Property (Page 2125)
AlignmentTop Property (Page 2126)
Application Property (Page 2129)
DisplayOptions Property (Page 2222)
Events Property (Page 2230)
FontBold Property (Page 2262)
FontItalic Property (Page 2263)
FontName Property (Page 2263)
FontSize Property (Page 2264)
FontUnderline Property (Page 2265)
ForeColor Property (Page 2266)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDFonts Property (Page 2304)
LDTexts Property (Page 2309)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
PictAlignment property (Page 2375)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
WinCC: Scripting (VBS, ANSI-C, VBA)
2058 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
TabOrderAlpha Property (Page 2431)
Text Property (Page 2440)
Transparency property (Page 2450)
Type Property (Page 2453)
WinCCStyle property (Page 2557)
WindowsStyle property (Page 2559)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
RoundRectangle Object
Description
Represents the "Rounded Rectangle" object. The RoundRectangle object is an element of the
following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIRoundRectangle
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2059
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the Add method to create a new "Rounded Rectangle" object in a picture:
Sub AddRoundRectangle()
'VBA326
Dim objRoundRectangle As HMIRoundRectangle
Set objRoundRectangle = ActiveDocument.HMIObjects.AddHMIObject("Roundrectangle1",
"HMIRoundRectangle")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditRoundRectangle()
'VBA327
Dim objRoundRectangle As HMIRoundRectangle
Set objRoundRectangle = ActiveDocument.HMIObjects("Roundrectangle1")
objRoundRectangle.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA328
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name of the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
Width Property (Page 2556)
BorderBackColor Property (Page 2159)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
RoundCornerWidth Property (Page 2405)
WinCC: Scripting (VBS, ANSI-C, VBA)
2060 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
RoundCornerHeight Property (Page 2404)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
FillingIndex Property (Page 2240)
Filling Property (Page 2239)
FillColor Property (Page 2238)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2061
VBA for Automated Configuration
3.6 VBA Reference
Type Property (Page 2453)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
ScriptInfo Object
Description
Represents a script (C, VB) that is configured for adding dynamics to a property or action to
an event.
VBA Object Name
HMIScriptInfo
Usage
Use the CreateDynamic method to make a property dynamic with the aid of a script. In the
following example...
Sub AddDynamicAsCSkriptToProperty()
'VBA329
Dim objCScript As HMIScriptInfo
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle1", "HMICircle")
Set objCScript = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeCScript)
'
'Define triggertype and cycletime:
With objCScript
.SourceCode = ""
.Trigger.Type = hmiTriggerTypeStandardCycle
.Trigger.CycleType = hmiCycleType_2s
.Trigger.Name = "Trigger1"
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2062 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use the AddAction method to configure an action on an event. In the following example...
Sub AddActionToPropertyTypeCScript()
'VBA330
Dim objEvent As HMIEvent
Dim objCScript As HMIScriptInfo
Dim objCircle As HMICircle
'Add circle to picture. By changing of property "Radius"
'a C-action is added:
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_AB", "HMICircle")
Set objEvent = objCircle.Radius.Events(1)
Set objCScript = objEvent.Actions.AddAction(hmiActionCreationTypeCScript)
End Sub
See also
Prototype Property (Page 2392)
Delete Method (Page 1837)
VBA Reference (Page 1752)
Creating Dynamics with VBA (Page 1694)
Trigger Property (Page 2452)
SourceCode Property (Page 2426)
ScriptType Property (Page 2409)
Parent Property (Page 2364)
Compiled Property (Page 2204)
Application Property (Page 2129)
UsedLanguage property (Page 2467)
SelectedObjects object (Listing)
Description
A listing of the HMIObject objects that represent all the selected objects in a picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2063
VBA for Automated Configuration
3.6 VBA Reference
VBA Object Name
HMISelectedObjects
Usage
Use the Selection property to return the Selection listing. In the following example the names
of all the selected objects in the active picture will be output:
Sub ShowSelectionOfDocument()
'VBA331
Dim colSelection As HMISelectedObjects
Dim objObject As HMIObject
Dim strObjectList As String
Set colSelection = ActiveDocument.Selection
If colSelection.Count <> 0 Then
strObjectList = "List of selected objects:"
For Each objObject In colSelection
strObjectList = strObjectList & vbCrLf & objObject.ObjectName
Next objObject
Else
strObjectList = "No objects selected"
End If
MsgBox strObjectList
End Sub
Use the SelectAll method, for example, to select all the objects in the picture. In the following
example all the objects in the active picture are selected:
Sub SelectAllObjects()
'VBA332
ActiveDocument.Selection.SelectAll
End Sub
See also
HMIObjects Object (Listing) (Page 1994)
AlignTop Method (Page 1816)
HMIDefaultObjects Object (Listing) (Page 1989)
BringToFront Method (Page 1819)
SendToBack Method (Page 1889)
SelectAll Method (Page 1888)
SameWidthAndHeight Method (Page 1883)
SameWidth Method (Page 1882)
SameHeight Method (Page 1880)
Rotate Method (Page 1878)
WinCC: Scripting (VBS, ANSI-C, VBA)
2064 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Remove Method (Page 1876)
ForwardOneLevel Method (Page 1852)
BackwardOneLevel Method (Page 1818)
MoveSelection Method (Page 1871)
Item Method (Page 1865)
FlipVertically Method (Page 1851)
FlipHorizontally Method (Page 1849)
EvenlySpaceVertically Method (Page 1844)
EvenlySpaceHorizontally Method (Page 1843)
DuplicateSelection Method (Page 1842)
DeselectAll Method (Page 1840)
DeleteAll Method (Page 1838)
CreateGroup Method (Page 1835)
CreateCustomizedObject Method (Page 1831)
CopySelection Method (Page 1828)
CenterVertically Method (Page 1822)
CenterHorizontally Method (Page 1821)
AlignRight Method (Page 1815)
AlignLeft Method (Page 1814)
AlignBottom Method (Page 1813)
How to Edit a Customized Object with VBA (Page 1691)
How to Edit the Group Objects Using VBA (Page 1684)
How to edit Default objects, Smart objects, Windows objects and Tube objects (Page 1674)
VBA Reference (Page 1752)
Customized Objects (Page 1690)
Group Objects (Page 1682)
Default objects, Smart objects, Windows objects and Tube objects (Page 1672)
Editing Objects with VBA (Page 1670)
Parent Property (Page 2364)
Count Property (Page 2208)
Application Property (Page 2129)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2065
VBA for Automated Configuration
3.6 VBA Reference
Slider object
Description
Represents the object called "Slider Object". The Slider object is an element of the following
listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMISlider
Usage
Use the Add method to create a new "Slider Object" object in a picture:
Sub AddSlider()
'VBA333
Dim objSlider As HMISlider
Set objSlider = ActiveDocument.HMIObjects.AddHMIObject("Slider1", "HMISlider")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditSlider()
'VBA334
Dim objSlider As HMISlider
Set objSlider = ActiveDocument.HMIObjects("Slider1")
objSlider.ButtonColor = RGB(255, 0, 0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2066 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA335
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name of the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
OperationReport Property (Page 2360)
BorderFlashColorOff Property (Page 2164)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
SmallChange Property (Page 2423)
Process Property (Page 2387)
PasswordLevel Property (Page 2367)
OperationMessage Property (Page 2359)
Operation Property (Page 2358)
Min Property (Page 2345)
Max Property (Page 2327)
Left Property (Page 2311)
Layer Property (Page 2299)
Height Property (Page 2276)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2067
VBA for Automated Configuration
3.6 VBA Reference
FillStyle Property (Page 2242)
FillingIndex Property (Page 2240)
Filling Property (Page 2239)
FillColor Property (Page 2238)
ExtendedOperation Property (Page 2234)
Direction Property (Page 2220)
ColorTop Property (Page 2198)
ColorBottom Property (Page 2191)
ButtonColor Property (Page 2174)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColorTop Property (Page 2142)
BackColor Property (Page 2139)
BackColorBottom Property (Page 2142)
BackBorderWidth Property (Page 2138)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
WinCCStyle property (Page 2557)
WinCC: Scripting (VBS, ANSI-C, VBA)
2068 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
WindowsStyle property (Page 2559)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
SourceLink Object
Description
Represents the source for a direct connection.
VBA Object Name
HMISourceLink
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2069
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the SourceLink property to return the SourceLink object. In the following example the X
position of "Rectangle_A" is copied to the Y position of "Rectangle_B" in Runtime by clicking
on the button:
Sub DirectConnection()
'VBA336
Dim objButton As HMIButton
Dim objRectangleA As HMIRectangle
Dim objRectangleB As HMIRectangle
Dim objEvent As HMIEvent
Dim objDirConnection As HMIDirectConnection
'
'Add objects to active document:
Set objRectangleA = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_A", "HMIRectangle")
Set objRectangleB = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_B", "HMIRectangle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objRectangleA
.Top = 100
.Left = 100
End With
With objRectangleB
.Top = 250
.Left = 400
.BackColor = RGB(255, 0, 0)
End With
With objButton
.Top = 10
.Left = 10
.Text = "SetPosition"
End With
'
'Initiation of directconnection by mouseclick:
Set objDirConnection =
objButton.Events(1).Actions.AddAction(hmiActionCreationTypeDirectConnection)
With objDirConnection
'Sourceobject: Top-property of Rectangle_A
.SourceLink.Type = hmiSourceTypeProperty
.SourceLink.ObjectName = "Rectangle_A"
.SourceLink.AutomationName = "Top"
'
'Targetobject: Left-property of Rectangle_B
.DestinationLink.Type = hmiDestTypeProperty
.DestinationLink.ObjectName = "Rectangle_B"
.DestinationLink.AutomationName = "Left"
End With
End Sub
See also
DirectConnection Object (Page 1952)
VBA Reference (Page 1752)
WinCC: Scripting (VBS, ANSI-C, VBA)
2070 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Type Property (Page 2453)
SourceLink Property (Page 2424)
ObjectName Property (Page 2353)
AutomationName Property (Page 2133)
Application Property (Page 2129)
Parent Property (Page 2364)
StaticText Object
Description
Represents the "Static Text" object. The StaticText object is an element of the following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIStaticText
Usage
Use the Add method to create a new "Static Text" object in a picture:
Sub AddStaticText()
'VBA337
Dim objStaticText As HMIStaticText
Set objStaticText = ActiveDocument.HMIObjects.AddHMIObject("Static_Text1", "HMIStaticText")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2071
VBA for Automated Configuration
3.6 VBA Reference
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditStaticText()
'VBA338
Dim objStaticText As HMIStaticText
Set objStaticText = ActiveDocument.HMIObjects("Static_Text1")
objStaticText.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA339
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name of the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
SelectedObjects object (Listing) (Page 2063)
FontBold Property (Page 2262)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
Text Property (Page 2440)
PasswordLevel Property (Page 2367)
Orientation Property (Page 2361)
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Height Property (Page 2276)
ForeFlashColorOn Property (Page 2268)
WinCC: Scripting (VBS, ANSI-C, VBA)
2072 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
ForeFlashColorOff Property (Page 2267)
ForeColor Property (Page 2266)
FontUnderline Property (Page 2265)
FontSize Property (Page 2264)
FontName Property (Page 2263)
FontItalic Property (Page 2263)
FlashRateForeColor Property (Page 2257)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashForeColor Property (Page 2248)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
FillingIndex Property (Page 2240)
Filling Property (Page 2239)
FillColor Property (Page 2238)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
AlignmentTop Property (Page 2126)
AlignmentLeft Property (Page 2125)
AdaptBorder Property (Page 2120)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDFonts Property (Page 2304)
LDTexts Property (Page 2309)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2073
VBA for Automated Configuration
3.6 VBA Reference
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
ReferenceRotationLeft Property (Page 2399)
ReferenceRotationTop Property (Page 2400)
RotationAngle Property (Page 2403)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
StatusDisplay Object
Description
Represents the "Status Display" object. The "StatusDisplay" object is an element of the
following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMIStatusDisplay
WinCC: Scripting (VBS, ANSI-C, VBA)
2074 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the Add method to create a new "Status Display" object in a picture:
Sub AddStatusDisplay()
'VBA340
Dim objStatusDisplay As HMIStatusDisplay
Set objStatusDisplay = ActiveDocument.HMIObjects.AddHMIObject("Statusdisplay1",
"HMIStatusDisplay")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditStatusDisplay()
'VBA341
Dim objStatusDisplay As HMIStatusDisplay
Set objStatusDisplay = ActiveDocument.HMIObjects("Statusdisplay1")
objStatusDisplay.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA342
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name of the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
ToolTipText Property (Page 2448)
BasePicReferenced Property (Page 2150)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Width Property (Page 2556)
Visible Property (Page 2553)
Top Property (Page 2449)
PasswordLevel Property (Page 2367)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2075
VBA for Automated Configuration
3.6 VBA Reference
Operation Property (Page 2358)
Left Property (Page 2311)
Layer Property (Page 2299)
Index Property (Page 2283)
Height Property (Page 2276)
FlashRateFlashPic Property (Page 2256)
FlashRateBorderColor Property (Page 2255)
FlashPicUseTransColor Property (Page 2252)
FlashPicture Property (Page 2250)
FlashPicTransColor Property (Page 2250)
FlashPicReferenced Property (Page 2249)
FlashFlashPicture Property (Page 2248)
FlashBorderColor Property (Page 2247)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BasePicUseTransColor Property (Page 2152)
BasePicture Property (Page 2151)
BasePicTransColor Property (Page 2151)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
WinCC: Scripting (VBS, ANSI-C, VBA)
2076 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Type Property (Page 2453)
DrawInsideFrame property (Page 2224)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
Graphiclist property (Page 2271)
SVGLibraries object (list)
Description
$SSOLFDWLRQ
69*/LEUDULHV
69*/LEUDU\
)ROGHU,WHPV
)ROGHU,WHP
A list of the SVGLibrary objects that represent the components of the SVG objects.
The list contains two objects:
● The "Global SVG Library" and its libraries
● The "Project SVG Library" and its libraries
VBA object name
HMISVGLibraries
Use
Use the SVGLibraries property to return the SVGLibraries list.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2077
VBA for Automated Configuration
3.6 VBA Reference
In the following example, the names of the libraries will be output:
Sub ShowSVGLibraries()
'VBA915
Dim colSVGLibraries As HMISVGLibraries
Dim objSVGLibrary As HMISVGLibrary
Dim strLibraryList As String
Set colSVGLibraries = Application.SVGLibraries
For Each objSVGLibrary In colSVGLibraries
strLibraryList = strLibraryList & objSVGLibrary.Name & vbCrLf
Next objSVGLibrary
MsgBox strLibraryList
End Sub
See also
SVGLibrary object (Page 2078)
How to create and export an SVG library with VBA (Page 1658)
How to edit an SVG library with VBA (Page 1660)
Item Method (Page 1865)
Application Property (Page 2129)
FolderItems Property (Page 2260)
Folder Property (Page 2258)
SVGLibrary object
Description
$SSOLFDWLRQ
69*/LEUDULHV
69*/LEUDU\
)ROGHU,WHPV
)ROGHU,WHP
Represents the "Global SVG Library" or "Project SVG Library" of the SVG library.
The SVGLibrary object is an element of the SVGLibraries list.
VBA object name
HMISVGLibrary
WinCC: Scripting (VBS, ANSI-C, VBA)
2078 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use
Use SSVGLibraries(Index) to return an individual SymbolLibrary object.
For "Index", you can use either the index number or the name of the object.
The name of the "Global SVG Library" is output in the following examples:
Sub ShowFirstObjectOfCollection()
'VBA913
Dim strName As String
strName = Application.SVGLibraries(1).Name
MsgBox strName
End Sub
Sub ShowFirstObjectOfCollection()
'VBA914
Dim strName As String
strName = Application.SVGLibraries("NewSVGLibrary").Name
MsgBox strName
End Sub
See also
SVGLibraries object (list) (Page 2077)
How to create and export an SVG library with VBA (Page 1658)
How to edit an SVG library with VBA (Page 1660)
Item Method (Page 1865)
Application Property (Page 2129)
FolderItems Property (Page 2260)
Folder Property (Page 2258)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2079
VBA for Automated Configuration
3.6 VBA Reference
SVGObject object
Description
Represents the "SVG object" object. The SVGObject object is an element of the following
listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMISVGObject
Usage
Use the Add method to create a new "SVG object" object in a picture:
Sub AddSVGObject()
Dim objSVGObject As HMISVGObject
Set objSVGObject = ActiveDocument.HMIObjects.AddHMIObject("SVG object", "HMISVGObject")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where "Index" in this
case identifies the object by name:
Sub EditSVGObject()
Dim objSVGObject As HMISVGObject
Set objSVGObject = ActiveDocument.HMIObjects("SVG object")
objSVGObject.FillColor = RGB(255, 0, 0)
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2080 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use "Selection(Index)" to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name of the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
HMIDefaultObjects Object (Listing) (Page 1989)
HMIObjects Object (Listing) (Page 1994)
SelectedObjects object (Listing) (Page 2063)
AddHMIObject Method (Page 1807)
Left Property (Page 2311)
ToolTipText Property (Page 2448)
Top Property (Page 2449)
Visible Property (Page 2553)
Width Property (Page 2556)
PasswordLevel Property (Page 2367)
PicReferenced Property (Page 2374)
PicTransColor Property (Page 2375)
PictureName Property (Page 2377)
PicUpUseTransColor Property (Page 2380)
PicUseTransColor Property (Page 2381)
Layer Property (Page 2299)
Name Property (Page 2349)
Operation Property (Page 2358)
FillColor Property (Page 2238)
Filling Property (Page 2239)
FillingIndex Property (Page 2240)
FillStyle Property (Page 2242)
FlashBackColor Property (Page 2246)
FlashBorderColor Property (Page 2247)
FlashRateBackColor Property (Page 2253)
FlashRateBorderColor Property (Page 2255)
Height Property (Page 2276)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2081
VBA for Automated Configuration
3.6 VBA Reference
BackColor Property (Page 2139)
BackFlashColorOff Property (Page 2145)
BackFlashColorOn Property (Page 2146)
BorderBackColor Property (Page 2159)
BorderColor Property (Page 2160)
BorderFlashColorOff Property (Page 2164)
BorderFlashColorOn Property (Page 2166)
BorderStyle Property (Page 2167)
BorderWidth Property (Page 2168)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderAlpha Property (Page 2431)
TabOrderSwitch Property (Page 2434)
Transparency property (Page 2450)
Type Property (Page 2453)
ConnectionPoints property (Page 2205)
DrawInsideFrame property (Page 2224)
SymbolLibraries Object (Listing)
Description
WinCC: Scripting (VBS, ANSI-C, VBA)
2082 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
A listing of the SymbolLibrary objects that represent the Components Library. The listing
contains two objects: The first object is the "Global Library" and the second object is the "Project
Library".
VBA Object Name
HMISymbolLibraries
Usage
Use the SymbolLibraries property to return the SymbolLibraries listing. In the following example
the names of the libraries will be output:
Sub ShowSymbolLibraries()
'VBA344
Dim colSymbolLibraries As HMISymbolLibraries
Dim objSymbolLibrary As HMISymbolLibrary
Dim strLibraryList As String
Set colSymbolLibraries = Application.SymbolLibraries
For Each objSymbolLibrary In colSymbolLibraries
strLibraryList = strLibraryList & objSymbolLibrary.Name & vbCrLf
Next objSymbolLibrary
MsgBox strLibraryList
End Sub
See also
SymbolLibrary Object (Page 2084)
Item Method (Page 1865)
VBA Reference (Page 1752)
Accessing the component library with VBA (Page 1650)
Parent Property (Page 2364)
Count Property (Page 2208)
Application Property (Page 2129)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2083
VBA for Automated Configuration
3.6 VBA Reference
SymbolLibrary Object
Description
Represents the "Global Library" or "Project Library". The SymbolLibrary object is an element
of the SymbolLibraries listing.
VBA Object Name
HMISymbolLibrary
Usage
Use SymbolLibraries(Index) to return an individual SymbolLibrary object. "For Index you can
use either the index number or the name of the object. In the following example the name of
the "Global Library" will be output:
Sub ShowFirstObjectOfCollection()
'VBA343
Dim strName As String
strName = Application.SymbolLibraries(1).Name
MsgBox strName
End Sub
See also
SymbolLibraries Object (Listing) (Page 2082)
GetItemByPath Method (Page 1853)
FindByDisplayName Method (Page 1848)
VBA Reference (Page 1752)
Accessing the component library with VBA (Page 1650)
Parent Property (Page 2364)
Name Property (Page 2349)
WinCC: Scripting (VBS, ANSI-C, VBA)
2084 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
FolderItems Property (Page 2260)
Application Property (Page 2129)
TextList Object
Description
Represents the "Text List" object. The TextList object is an element of the following listings:
● Objects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all standard, Windows, and
smart objects.
VBA Object Name
HMITextList
Usage
Use the Add method to create a new "Text List" object in a picture:
Sub AddTextList()
'VBA345
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("Textlist1", "HMITextList")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2085
VBA for Automated Configuration
3.6 VBA Reference
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditTextList()
'VBA346
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects("Textlist1")
objTextList.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA347
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name of the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
Width Property (Page 2556)
ForeFlashColorOn Property (Page 2268)
BitNumber Property (Page 2155)
SelectedObjects object (Listing) (Page 2063)
HMIObjects Object (Listing) (Page 1994)
HMIDefaultObjects Object (Listing) (Page 1989)
AddHMIObject Method (Page 1807)
VBA Reference (Page 1752)
Editing Objects with VBA (Page 1670)
Visible Property (Page 2553)
UnselTextColor Property (Page 2465)
UnselBGColor Property (Page 2464)
Top Property (Page 2449)
ToolTipText Property (Page 2448)
SelTextColor Property (Page 2417)
SelBGColor Property (Page 2415)
PasswordLevel Property (Page 2367)
OutputValue Property (Page 2363)
Orientation Property (Page 2361)
WinCC: Scripting (VBS, ANSI-C, VBA)
2086 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
OperationReport Property (Page 2360)
OperationMessage Property (Page 2359)
Operation Property (Page 2358)
NumberLines Property (Page 2352)
ListType Property (Page 2318)
Left Property (Page 2311)
Layer Property (Page 2299)
LanguageSwitch Property (Page 2297)
ItemBorderWidth Property (Page 2292)
ItemBorderStyle Property (Page 2292)
ItemBorderColor Property (Page 2291)
ItemBorderBackColor Property (Page 2290)
Height Property (Page 2276)
ForeFlashColorOff Property (Page 2267)
ForeColor Property (Page 2266)
FontUnderline Property (Page 2265)
FontSize Property (Page 2264)
FontName Property (Page 2263)
FontItalic Property (Page 2263)
FontBold Property (Page 2262)
FlashRateForeColor Property (Page 2257)
FlashRateBorderColor Property (Page 2255)
FlashRateBackColor Property (Page 2253)
FlashForeColor Property (Page 2248)
FlashBorderColor Property (Page 2247)
FlashBackColor Property (Page 2246)
FillStyle Property (Page 2242)
FillColor Property (Page 2238)
EditAtOnce Property (Page 2226)
CursorControl Property (Page 2212)
BoxType Property (Page 2172)
BorderWidth Property (Page 2168)
BorderStyle Property (Page 2167)
BorderFlashColorOn Property (Page 2166)
BorderFlashColorOff Property (Page 2164)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2087
VBA for Automated Configuration
3.6 VBA Reference
BorderColor Property (Page 2160)
BorderBackColor Property (Page 2159)
BackFlashColorOn Property (Page 2146)
BackFlashColorOff Property (Page 2145)
BackColor Property (Page 2139)
AssumeOnExit Property (Page 2131)
Assignments Property (Page 2131)
AlignmentTop Property (Page 2126)
AlignmentLeft Property (Page 2125)
AdaptBorder Property (Page 2120)
Application Property (Page 2129)
Events Property (Page 2230)
GlobalColorScheme property (Page 2270)
GlobalShadow property (Page 2270)
GroupParent Property (Page 2275)
InputValue property (Page 2285)
LDTooltipTexts Property (Page 2309)
ObjectName Property (Page 2353)
Parent Property (Page 2364)
Properties Property (Page 2391)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Transparency property (Page 2450)
Type Property (Page 2453)
ConnectionPoints property (Page 2205)
DropDownListStyle property (Page 2225)
LDAssignments property (Page 2304)
TextBiblIDs property (Page 2440)
ConnectorObjects property (Page 2206)
Textlist property (Page 2441)
TextListSort property (Page 2441)
WinCC: Scripting (VBS, ANSI-C, VBA)
2088 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Toolbar Object
Description
Represents the "User Defined Toolbar" object. The Toolbar object is an element of the
CustomToolbars listing.
VBA Object Name
HMIToolbar
Usage
Use CustomToolbars(Index) to return an individual Toolbar object. "For Index you can use
either the index number or the name of the object. In the following example the "Key" parameter
of the first user-defined toolbar in the active picture will be output:
Sub ShowFirstObjectOfCollection()
'VBA348
Dim strName As String
strName = ActiveDocument.CustomToolbars(1).Key
MsgBox strName
End Sub
Use the Delete method to remove a "Toolbar" object from the "CustomToolbars" listing. In the
following example the first user-defined toolbar in the active picture will be removed:
Sub DeleteToolbar()
'VBA349
Dim objToolbar As HMIToolbar
Set objToolbar = ActiveDocument.CustomToolbars(1)
objToolbar.Delete
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2089
VBA for Automated Configuration
3.6 VBA Reference
See also
Key Property (Page 2293)
Toolbars Object (Listing) (Page 2090)
Delete Method (Page 1837)
How to Create Picture-specific Menus and Toolbars (Page 1665)
How to Create an Application-specific Toolbar (Page 1639)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
Visible Property (Page 2553)
ToolbarItems Property (Page 2446)
Parent Property (Page 2364)
Application Property (Page 2129)
Toolbars Object (Listing)
Description
A listing of the Toolbar objects that represent all the user-defined toolbars in the Graphics
Designer.
VBA Object Name
HMICustomToolbars
Usage
Note
In order for the examples to work, first create a user-defined toolbar. For an example of this,
please refer to "Creating a New Application-Specific Toolbar" in this documentation.
WinCC: Scripting (VBS, ANSI-C, VBA)
2090 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use the CustomToolbars property to return the Toolbars listing. In the following example,
values for the "Key" property of all user-defined toolbars in the active picture will be output:
Note
The Toolbars listing does not distinguish between application-specific and picture-specific
toolbars in the output.
Sub ShowCustomToolbarsOfDocument()
'VBA350
Dim colToolbars As HMIToolbars
Dim objToolbar As HMIToolbar
Dim strToolbarList As String
Set colToolbars = ActiveDocument.CustomToolbars
If 0 <> colToolbars.Count Then
For Each objToolbar In colToolbars
strToolbarList = strToolbarList & objToolbar.Key & vbCrLf
Next objToolbar
Else
strToolbarList = "No toolbars existing"
End If
MsgBox strToolbarList
End Sub
Use the Application property and the Add method if you want to create an application-specific
toolbar. Create the VBA code in either the "Project Template" document or the "Global
Template" document.
Sub InsertApplicationSpecificToolbar()
'VBA351
Dim objToolbar As HMIToolbar
Set objToolbar = Application.CustomToolbars.Add("a_Toolbar1")
End Sub
Use the ActiveDocument property and the Add method if you want to create a picture-specific
toolbar. Create the VBA code in the document called "ThisDocument":
Sub InsertDocumentSpecificToolbar()
'VBA352
Dim objToolbar As HMIToolbar
Set objToolbar = ActiveDocument.CustomToolbars.Add("d_Toolbar1")
End Sub
See also
Toolbar Object (Page 2089)
Item Method (Page 1865)
Add Method (Page 1793)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2091
VBA for Automated Configuration
3.6 VBA Reference
How to Create Picture-specific Menus and Toolbars (Page 1665)
How to Create an Application-specific Toolbar (Page 1639)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
Parent Property (Page 2364)
Count Property (Page 2208)
Application Property (Page 2129)
ToolbarItem Object
Description
Represents an object (icon or dividing line) in a user-defined toolbar in the GraphicsDesigner.
The ToolbarItem object is an element of the ToolbarItems listing.
VBA Object Name
HMIToolbarItem
Usage
Note
In order for the examples to work, first create a user-defined toolbar. For an example of this,
please refer to "Creating a New Application-Specific Toolbar" in this documentation.
WinCC: Scripting (VBS, ANSI-C, VBA)
2092 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use ToolbarItems(Index) to return an individual ToolbarItem object. "For Index you can use
either the index number or the name of the object. In the following example the type of the first
object in the first user-defined toolbar in the active picture will be output:
Sub ShowFirstObjectOfCollection()
'VBA353
Dim strType As String
strType = ActiveDocument.CustomToolbars(1).ToolbarItems(1).ToolbarItemType
MsgBox strType
End Sub
Use the Delete method to remove an object from the "ToolbarItems" listing. In the following
example the first object will be deleted from the first user-defined toolbar in the active picture:
Sub DeleteToolbarItem()
'VBA354
ActiveDocument.CustomToolbars(1).ToolbarItems(1).Delete
End Sub
See also
Macro Property (Page 2326)
ToolbarItems Object (Listing) (Page 2094)
Delete Method (Page 1837)
Configuring Menus and Toolbars (Page 1630)
How to assign VBA macros to menus and toolbars (Page 1645)
How to assign help texts to menus and toolbars (Page 1643)
How to Add a New Icon to the Toolbar (Page 1641)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
Visible Property (Page 2553)
Type Property (Page 2453)
ToolTipText Property (Page 2448)
Tag Property (Page 2435)
StatusText Property (Page 2428)
ShortCut Property (Page 2419)
Position Property (Page 2383)
Parent Property (Page 2364)
LDTooltipTexts Property (Page 2309)
LDStatusTexts Property (Page 2307)
Key Property (Page 2293)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2093
VBA for Automated Configuration
3.6 VBA Reference
Icon Property (Page 2281)
Enabled Property (Page 2227)
Application Property (Page 2129)
ToolbarItemType property (Page 2447)
ToolbarItems Object (Listing)
Description
A listing of the ToolbarItem objects that represent all the objects in a user-defined toolbar.
VBA Object Name
HMIToolbarItems
Usage
Use the ToolbarItems property to return the ToolbarItems listing. In the following example, all
object types in the first user-defined toolbar in the active picture will be output:
Note
The ToolbarItems listing does not distinguish between application-specific and picture-specific
toolbars in the output.
WinCC: Scripting (VBS, ANSI-C, VBA)
2094 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Sub ShowToolbarItems()
'VBA355
Dim colToolbarItems As HMIToolbarItems
Dim objToolbarItem As HMIToolbarItem
Dim strTypeList As String
Set colToolbarItems = ActiveDocument.CustomToolbars(1).ToolbarItems
If 0 <> colToolbarItems.Count Then
For Each objToolbarItem In colToolbarItems
strTypeList = strTypeList & objToolbarItem.ToolbarItemType & vbCrLf
Next objToolbarItem
Else
strTypeList = "No Toolbaritems existing"
End If
MsgBox strTypeList
End Sub
Use the InsertToolbarItem method, for instance, to insert an icon into an existing user-defined
toolbar. In the following example a picture-specific toolbar will be created in the active picture
and an icon will be added:
Sub InsertToolbarItem()
'VBA356
Dim objToolbar As HMIToolbar
Dim objToolbarItem As HMIToolbarItem
Set objToolbar = ActiveDocument.CustomToolbars.Add("d_Toolbar2")
Set objToolbarItem = objToolbar.ToolbarItems.InsertToolbarItem(1, "t_Item2_1",
"ToolbarItem 1")
End Sub
See also
ToolbarItem Object (Page 2092)
InsertToolbarItem Method (Page 1862)
InsertSeparator Method (Page 1859)
InsertFromMenuItem Method (Page 1854)
How to Add a New Icon to the Toolbar (Page 1641)
VBA Reference (Page 1752)
Creating Customized Menus and Toolbars (Page 1631)
Parent Property (Page 2364)
Count Property (Page 2208)
Application Property (Page 2129)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2095
VBA for Automated Configuration
3.6 VBA Reference
Trigger Object
Description
Represents the trigger (e.g. Picture Cycle) that is necessary for adding dynamics to properties
with the aid of scripts. A trigger can possess multiple tag triggers.
VBA Object Name
HMITrigger
Usage
Use the Trigger property to return the Trigger object. In this example the "Radius" property of
a circle will be made dynamic with the aid of a VB script (the output value sets the radius):
Sub AddDynamicAsVBSkriptToProperty()
'VBA357
Dim objVBScript As HMIScriptInfo
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle1", "HMICircle")
Set objVBScript = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeVBScript)
'
'Define cycletime and sourcecode
With objVBScript
.SourceCode = ""
.Trigger.Type = hmiTriggerTypeStandardCycle
.Trigger.CycleType = hmiCycleType_2s
.Trigger.Name = "Trigger1"
End With
End Sub
See also
Delete Method (Page 1837)
VBA Reference (Page 1752)
VariableTriggers Property (Page 2550)
WinCC: Scripting (VBS, ANSI-C, VBA)
2096 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Type Property (Page 2453)
Trigger Property (Page 2452)
Parent Property (Page 2364)
Name Property (Page 2349)
CycleType Property (Page 2216)
Application Property (Page 2129)
TubeArcObject object
Description
0XOWLSOH2EMHFWV
+0,'HIDXOW2EMHFWV
+0,2EMHFWV 7XEH$UF2EMHFW
6HOHFWLRQ
Represents the "Tube arc" object. The TubeArcObject object is an element of the following
lists:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all default, smart, window and
tube objects.
VBA object name
HMITubeArcObject
Usage
Use the Add method to create a new "Tube arc" object in a picture:
Sub AddTubeArcObject()
'VBA835
Dim objTubeArcObject As HMITubeArcObject
Set objTubeArcObject = ActiveDocument.HMIObjects.AddHMIObject("TubeArcObject",
"HMITubeArcObject")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2097
VBA for Automated Configuration
3.6 VBA Reference
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditTubeArcObject()
'VBA836
Dim objTubeArcObject As HMITubeArcObject
Set objTubeArcObject = ActiveDocument.HMIObjects("TubeArcObject")
objTubeArcObject.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA837
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
ObjectName Property (Page 2353)
Left Property (Page 2311)
Layer Property (Page 2299)
Top Property (Page 2449)
Width Property (Page 2556)
Height Property (Page 2276)
BorderColor Property (Page 2160)
BorderWidth Property (Page 2168)
ToolTipText Property (Page 2448)
Visible Property (Page 2553)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Transparency property (Page 2450)
GlobalShadow property (Page 2270)
GlobalColorScheme property (Page 2270)
StartAngle Property (Page 2428)
EndAngle Property (Page 2229)
RadiusHeight Property (Page 2397)
RadiusWidth Property (Page 2398)
WinCC: Scripting (VBS, ANSI-C, VBA)
2098 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Application Property (Page 2129)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
TubeDoubleTeeObject object
Description
0XOWLSOH2EMHFWV
+0,'HIDXOW2EMHFWV
+0,2EMHFWV 7XEH'RXEOH7HH2EMHFW
6HOHFWLRQ
Represents the "Double T-piece" object. The TubeDoubleTeeObject object is an element of
the following listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all default, smart, window and
tube objects.
VBA object name
HMITubeDoubleTeeObject
Usage
Use the Add method to create a new "Double T-piece" object in a picture:
Sub AddTubeDoubleTeeObject()
'VBA838
Dim objTubeDoubleTeeObject As HMITubeDoubleTeeObject
Set objTubeDoubleTeeObject = ActiveDocument.HMIObjects.AddHMIObject("Double T-piece",
"HMITubeDoubleTeeObject")
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2099
VBA for Automated Configuration
3.6 VBA Reference
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditTubeDoubleTeeObject()
'VBA839
Dim objTubeDoubleTeeObject As HMITubeDoubleTeeObject
Set objTubeDoubleTeeObject = ActiveDocument.HMIObjects("Double T-piece")
objTubeDoubleTeeObject.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA840
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
ObjectName Property (Page 2353)
Left Property (Page 2311)
Layer Property (Page 2299)
Top Property (Page 2449)
Width Property (Page 2556)
Height Property (Page 2276)
BorderColor Property (Page 2160)
BorderWidth Property (Page 2168)
ToolTipText Property (Page 2448)
Visible Property (Page 2553)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Transparency property (Page 2450)
GlobalShadow property (Page 2270)
GlobalColorScheme property (Page 2270)
Application Property (Page 2129)
Events Property (Page 2230)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
WinCC: Scripting (VBS, ANSI-C, VBA)
2100 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Type Property (Page 2453)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
TubePolyline object
Description
0XOWLSOH2EMHFWV
+0,'HIDXOW2EMHFWV
+0,2EMHFWV 7XEH3RO\OLQH
6HOHFWLRQ
Represents the "TubePolyline" object. The TubePolyline object is an element of the following
listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all default, smart, window and
tube objects.
VBA object name
HMITubePolyline
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2101
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the Add method to create a new "TubePolyline" object in a picture:
Sub AddTubePolyline()
'VBA841
Dim objTubePolyline As HMITubePolyline
Set objTubePolyline = ActiveDocument.HMIObjects.AddHMIObject("TubePolyline",
"HMITubePolyline")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditTubePolyline()
'VBA842
Dim objTubePolyline As HMITubePolyline
Set objTubePolyline = ActiveDocument.HMIObjects("TubePolyline")
objTubePolyline.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA843
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
ObjectName Property (Page 2353)
Left Property (Page 2311)
Layer Property (Page 2299)
Top Property (Page 2449)
Width Property (Page 2556)
Height Property (Page 2276)
BorderColor Property (Page 2160)
BorderWidth Property (Page 2168)
ToolTipText Property (Page 2448)
Visible Property (Page 2553)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
WinCC: Scripting (VBS, ANSI-C, VBA)
2102 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Transparency property (Page 2450)
GlobalShadow property (Page 2270)
GlobalColorScheme property (Page 2270)
PointCount Property (Page 2382)
ActualPointLeft Property (Page 2118)
ActualPointTop Property (Page 2119)
Index Property (Page 2283)
Application Property (Page 2129)
Events Property (Page 2230)
BorderStyle Property (Page 2167)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Type Property (Page 2453)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
TubeTeeObject object
Description
0XOWLSOH2EMHFWV
+0,'HIDXOW2EMHFWV
+0,2EMHFWV 7XEH7HH2EMHFW
6HOHFWLRQ
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2103
VBA for Automated Configuration
3.6 VBA Reference
Represents the "T-piece" object. The TubeTeeObject object is an element of the following lists:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
● HMIDefaultObjects: Contains the default property values of all default, smart, window and
tube objects.
VBA object name
HMITubeTeeObject
Usage
Use the Add method to create a new "T-piece" object in a picture:
Sub AddTubeTeeObject()
'VBA844
Dim objTubeTeeObject As HMITubeTeeObject
Set objTubeTeeObject = ActiveDocument.HMIObjects.AddHMIObject("T-piece",
"HMITubeTeeObject")
End Sub
Use "HMIObjects"(Index)" to return an object from the HMIObjects listing, where Index in this
case identifies the object by name:
Sub EditTubeTeeObject()
'VBA845
Dim objTubeTeeObject As HMITubeTeeObject
Set objTubeTeeObject = ActiveDocument.HMIObjects("T-piece")
objTubeTeeObject.BorderColor = RGB(255, 0, 0)
End Sub
Use "Selection"(Index) to return an object from the Selection listing:
Sub ShowNameOfFirstSelectedObject()
'VBA846
'Select all objects in the picture:
ActiveDocument.Selection.SelectAll
'Get the name from the first object of the selection:
MsgBox ActiveDocument.Selection(1).ObjectName
End Sub
See also
ObjectName Property (Page 2353)
Left Property (Page 2311)
Layer Property (Page 2299)
WinCC: Scripting (VBS, ANSI-C, VBA)
2104 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Top Property (Page 2449)
Width Property (Page 2556)
Height Property (Page 2276)
BorderColor Property (Page 2160)
BorderWidth Property (Page 2168)
ToolTipText Property (Page 2448)
Visible Property (Page 2553)
PasswordLevel Property (Page 2367)
Operation Property (Page 2358)
Transparency property (Page 2450)
GlobalShadow property (Page 2270)
GlobalColorScheme property (Page 2270)
RotationAngle Property (Page 2403)
Application Property (Page 2129)
Events Property (Page 2230)
GroupParent Property (Page 2275)
LDTooltipTexts Property (Page 2309)
Parent Property (Page 2364)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
Type Property (Page 2453)
ConnectionPoints property (Page 2205)
ConnectorObjects property (Page 2206)
VariableStateValue Object
Description
Represents the state of a tag, the value of which is assigned in the Dynamic dialog and used
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2105
VBA for Automated Configuration
3.6 VBA Reference
VBA Object Name
HMIVariableStateValue
See also
VALUE_SERVERDOWN Property (Page 2519)
VBA Reference (Page 1752)
VarName Property (Page 2551)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MIN_LIMIT Property (Page 2513)
VALUE_MAX_RANGE Property (Page 2511)
VALUE_MAX_LIMIT Property (Page 2509)
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
Parent Property (Page 2364)
Application Property (Page 2129)
VariableStateValues Object (Listing)
Description
A listing of VariableStateValue objects containing all tag statuses in Dynamic dialog to be used
for dynamization.
WinCC: Scripting (VBS, ANSI-C, VBA)
2106 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VBA Object Name
HMIVariableStateValues
Usage
Use the Item property in the Dynamic dialog to define values that will be used for creating
dynamics when the specified tag returns the configured state. In the following example the
radius of a circle is given dynamics with the The dynamization takes place be evaluating the
status of a tag. If the tag does not return a status, a substitute value (ElseCase property) is
defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA358
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'Activate variable-statecheck
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VALUE_MAX_RANGE Property (Page 2511)
VBA Reference (Page 1752)
VarName Property (Page 2551)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2107
VBA for Automated Configuration
3.6 VBA Reference
VALUE_SERVERDOWN Property (Page 2519)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MIN_LIMIT Property (Page 2513)
VALUE_MAX_LIMIT Property (Page 2509)
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
Parent Property (Page 2364)
Item Property (Page 2289)
Application Property (Page 2129)
VariableTrigger Object
Description
Represents a tag trigger.
VBA Object Name
HMIVariableTrigger
WinCC: Scripting (VBS, ANSI-C, VBA)
2108 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Application
Use the VariableTrigger object in order to edit or delete an existing tag trigger. In this example
a circle property "Top" is made dynamic with the aid of the tag "NewDynamic1":
Sub AddDynamicAsVariableDirectToProperty()
'VBA359
Dim objVariableTrigger As HMIVariableTrigger
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle1", "HMICircle")
Set objVariableTrigger = objCircle.Top.CreateDynamic(hmiDynamicCreationTypeVariableDirect,
"'NewDynamic1'")
'
'Define cycletime
With objVariableTrigger
.CycleType = hmiCycleType_2s
End With
End Sub
See also
Delete Method (Page 1837)
VariableTriggers Object (Listing) (Page 2110)
VBA Reference (Page 1752)
VariableTriggers Property (Page 2550)
Type Property (Page 2453)
Parent Property (Page 2364)
Name Property (Page 2349)
CycleType Property (Page 2216)
Application Property (Page 2129)
CycleName Property (Page 2215)
CycleTime Property (Page 2215)
VarName Property (Page 2551)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2109
VBA for Automated Configuration
3.6 VBA Reference
VariableTriggers Object (Listing)
Description
A listing of the VariableTrigger objects that represent all the tag triggers in use.
VBA Object Name
HMIVariableTriggers
Usage
Use the Add method to create a new tag trigger. In the following example the radius of a circle
is made dynamic with the aid of a VB script. A tag trigger is used as the trigger:
Sub DynamicWithVariableTriggerCycle()
'VBA360
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
'Definition of triggername and cycletime is to do with the Add-methode
Set objVarTrigger = .Trigger.VariableTriggers.Add("VarTrigger", hmiVariableCycleType_10s)
.SourceCode = ""
End With
End Sub
See also
Add Method (TagTriggers Listing) (Page 1799)
VBA Reference (Page 1752)
Parent Property (Page 2364)
Item Property (Page 2289)
WinCC: Scripting (VBS, ANSI-C, VBA)
2110 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Count Property (Page 2208)
Application Property (Page 2129)
View Object
Description
Represents a copy of a picture. The View object is an element of the Views listing.
You can use the properties of the View object among other things to control the visibility of the
CS layers and to define the zoom.
VBA Object Name
HMIView
Usage
Use Views(Index) to return an individual View object. In the following example the number of
copies of the active picture will be output:
Sub ShowNumberOfExistingViews()
'VBA361
Dim iMaxViews As Integer
iMaxViews = ActiveDocument.Views.Count
MsgBox "Number of copies from active document: " & iMaxViews
End Sub
Use the Add method to add a new View object to the "Views" listing. In the following example
a copy of the active picture is created and then activated:
Sub AddView()
'VBA362
Dim objView As HMIView
Set objView = ActiveDocument.Views.Add
objView.Activate
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2111
VBA for Automated Configuration
3.6 VBA Reference
See also
Height Property (Page 2276)
Views Object (Listing) (Page 2112)
SetCSLayerVisible Method (Page 1891)
PrintDocument Method (Page 1875)
IsCSLayerVisible Method (Page 1863)
Delete Method (Page 1837)
Add Method (Views Listing) (Page 1800)
Activate Method (Page 1792)
VBA Reference (Page 1752)
Editing a Copy of a Picture with VBA (Page 1668)
Editing Layers with VBA (Page 1666)
ExtendedZoomingEnable Property (Page 2235)
Zoom Property (Page 2562)
WindowState Property (Page 2560)
Width Property (Page 2556)
Top Property (Page 2449)
ScrollPosY Property (Page 2414)
ScrollPosX Property (Page 2413)
Parent Property (Page 2364)
Left Property (Page 2311)
IsActive Property (Page 2285)
Application Property (Page 2129)
ActiveLayer Property (Page 2117)
Views Object (Listing)
Description
A listing of the View objects that represent a copy of a picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
2112 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VBA Object Name
HMIViews
Usage
Use the Views listing to return a View object. In the following example the number of existing
copies of the active picture will be output:
Sub ShowNumberOfExistingViews()
'VBA363
Dim iMaxViews As Integer
iMaxViews = ActiveDocument.Views.Count
MsgBox "Number of copies from active document: " & iMaxViews
End Sub
Use the Add method to create a copy of a picture. In the following example a copy of the active
picture is created and then activated:
Sub AddViewToActiveDocument()
'VBA364
Dim objView As HMIView
Set objView = ActiveDocument.Views.Add
objView.Activate
End Sub
See also
Item Method (Page 1865)
View Object (Page 2111)
Add Method (Page 1793)
VBA Reference (Page 1752)
Parent Property (Page 2364)
Count Property (Page 2208)
Application Property (Page 2129)
WPFControl object
Description
Represents the "WPFControl" object. The WPFControl object is an element of the following
listings:
● HMIObjects: Contains all objects of a picture.
● Selection: Contains all selected objects of a picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2113
VBA for Automated Configuration
3.6 VBA Reference
VBA Object Name
HMIWPFControl
Application
Use the AddWPFControl method to insert a WPFControl in a picture.
In the following example, the "WPF Control" object outside the Global Assembly Cache is
inserted in the active picture.
'VBA852
Dim WPFControl As HMIWPFControl
Set WPFControl = ActiveDocument.HMIObjects.AddWPFControl("MyWPFVBAControl",
"WinCCWPFControl.TestControl", False, "Assembly=Z:\TestControl\WinCCWPFControl.dll")
See also
AddWPFControl method (Page 1812)
Delete Method (Page 1837)
Application Property (Page 2129)
AssemblyInfo property (Page 2131)
ControlType property (Page 2208)
Events Property (Page 2230)
GroupParent Property (Page 2275)
Height Property (Page 2276)
Layer Property (Page 2299)
LDTooltipTexts Property (Page 2309)
Left Property (Page 2311)
ObjectName Property (Page 2353)
Operation Property (Page 2358)
Parent Property (Page 2364)
PasswordLevel Property (Page 2367)
Properties Property (Page 2391)
Selected Property (Page 2415)
TabOrderSwitch Property (Page 2434)
TabOrderAlpha Property (Page 2431)
ToolTipText Property (Page 2448)
Top Property (Page 2449)
Type Property (Page 2453)
WinCC: Scripting (VBS, ANSI-C, VBA)
2114 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Visible Property (Page 2553)
Width Property (Page 2556)
ConnectorObjects property (Page 2206)
3.6.1.8 Properties
Actions Property
Description
Returns the Actions listing. Use the Actions property to configure an event-driven action.
Example:
In this example a button and a circle will be inserted in the active picture. In Runtime the radius
of the circle enlarges every time you click the button:
Sub CreateVBActionToClickedEvent()
'VBA365
Dim objButton As HMIButton
Dim objCircle As HMICircle
Dim objEvent As HMIEvent
Dim objVBScript As HMIScriptInfo
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_VB", "HMICircle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objCircle
.Top = 100
.Left = 100
.BackColor = RGB(255, 0, 0)
End With
With objButton
.Top = 10
.Left = 10
.Width = 120
.Text = "Increase Radius"
End With
'Define event and assign sourcecode:
Set objVBScript = objButton.Events(1).Actions.AddAction(hmiActionCreationTypeVBScript)
With objVBScript
.SourceCode = "Dim myCircle" & vbCrLf & _
"Set myCircle = HMIRuntime.ActiveScreen.ScreenItems(""Circle_VB"")" & _
vbCrLf & "myCircle.Radius = myCircle.Radius + 5"
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2115
VBA for Automated Configuration
3.6 VBA Reference
See also
Actions Object (Listing) (Page 1904)
AddAction Method (Page 1801)
Configuring Event-Driven Actions with VBA (Page 1707)
ActionType property
Description
Only used internally.
See also
VBA Reference: ActionDynamic (Page 1754)
ActiveDocument Property
Description
Returns an object of the "Document" type which represents the active picture in the Graphics
Designer. If there is no open or active picture in the Graphics Designer, you receive an error
message.
Note
The "ActiveDocument" property refers to the window that possesses the input focus. If other
editors (e.g. CrossReference) access a picture, the input focus can change. To prevent this
situation leading to errors, reference the picture unambiguously via the Documents listing.
WinCC: Scripting (VBS, ANSI-C, VBA)
2116 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "CreateMenuItem()" procedure creates the "Delete Objects" menu and adds two menu
entries ("Delete Rectangles" and "Delete Circles").
Sub CreateMenuItem()
'VBA366
Dim objMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
'
'Create new menu "Delete Objects":
Set objMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DeleteObjects", "Delete Objects")
'
'Add two menuitems to the menu "Delete Objects
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(1, "DeleteAllRectangles", "Delete
Rectangles")
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(2, "DeleteAllCircles", "Delete Circles")
End Sub
See also
Documents Object (Listing) (Page 1957)
ActiveLayer Property
Description
Defines or returns the active layer for the View object. The value range is from 0 to 31, where
"0" represents the uppermost layer and "31" the lowest layer.
Example:
The "ActiveDocumentConfiguration()" procedure accesses the properties of the current picture
in the Graphics Designer. In this example a new View object is created and layer 1 is set to
"Active":
Sub ActiveDocumentConfiguration()
'VBA367
Application.ActiveDocument.Views.Add
Application.ActiveDocument.Views(1).ActiveLayer = 2
End Sub
See also
View Object (Page 2111)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2117
VBA for Automated Configuration
3.6 VBA Reference
ActualPointLeft Property
Description
Defines or returns the X coordinate of the current corner point by reference to the picture origin
(top left) for the objects "Polygon" and "Polyline". Each corner point is identified by an index
which is derived from the number ("PointCount") of corner point available.
A change of the value can affect the properties "Width" (object width) and "Left" (x-coordinate
of the object position).
Example:
The "PolygonCoordinatesOutput()" procedure outputs the coordinates of all the corner points
in the first polyline in the current picture:
Sub PolygonCoordinatesOutput()
'VBA368
Dim objPolyline As HMIPolyLine
Dim iPosX As Integer
Dim iPosY As Integer
Dim iCounter As Integer
Dim strResult As String
iCounter = 1
Set objPolyline = ActiveDocument.HMIObjects.AddHMIObject("Polyline1", "HMIPolyLine")
For iCounter = 1 To objPolyline.PointCount
With objPolyline
.index = iCounter
iPosX = .ActualPointLeft
iPosY = .ActualPointTop
End With
strResult = strResult & vbCrLf & "Corner " & iCounter & ": x=" & iPosX & " y=" & iPosY
Next iCounter
MsgBox strResult
End Sub
See also
PointCount Property (Page 2382)
Index Property (Page 2283)
ActualPointTop Property (Page 2119)
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
Line Object (Page 2008)
WinCC: Scripting (VBS, ANSI-C, VBA)
2118 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
ActualPointTop Property
Description
Defines or returns the Y coordinate of the current corner point by reference to the picture origin
(top left) for the objects "Polygon" and "Polyline". Each corner point is identified by an index
which is derived from the number ("PointCount") of corner point available.
A change of the value can affect the properties "Height" (object height) and "Top" (y-coordinate
of the position).
Example:
The "Polygon()" procedure outputs the coordinates of all the corner points in the first polyline
in the current picture:
Sub PolygonCoordinatesOutput()
'VBA369
Dim objPolyline As HMIPolyLine
Dim iPosX As Integer
Dim iPosY As Integer
Dim iCounter As Integer
Dim strResult As String
iCounter = 1
Set objPolyline = ActiveDocument.HMIObjects.AddHMIObject("Polyline1", "HMIPolyLine")
For iCounter = 1 To objPolyline.PointCount
With objPolyline
.index = iCounter
iPosX = .ActualPointLeft
iPosY = .ActualPointTop
End With
strResult = strResult & vbCrLf & "Corner " & iCounter & ": x=" & iPosX & " y=" & iPosY
Next iCounter
MsgBox strResult
End Sub
See also
PointCount Property (Page 2382)
Index Property (Page 2283)
ActualPointLeft Property (Page 2118)
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
Line Object (Page 2008)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2119
VBA for Automated Configuration
3.6 VBA Reference
AdaptBorder Property
Description
TRUE if the field border is intended to adapt dynamically to the size of the text. BOOLEAN
write-read access.
Note
Changing the contents of a field dynamically can cause pumping in the field.
Performance is improved in Runtime by using "AdaptBorder = False".
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this example
the text size is dynamically adapted to the field size.
Sub IOFieldConfiguration()
'VBA372
Dim objIOField As HMIIOField
'
'Add new IO-Feld to active document:
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.AdaptBorder = True
End With
End Sub
See also
OptionGroup Object (Page 2029)
TextList Object (Page 2085)
StaticText Object (Page 2071)
IOField Object (Page 1996)
CheckBox Object (Page 1930)
Button Object (Page 1926)
AdaptPicture Property
Description
TRUE if the picture size is to be adapted to the picture window size. BOOLEAN write-read
access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2120 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "PictureWindowConfig" procedure accesses the properties of the picture window. In this
example the picture window will be configured:
Sub PictureWindowConfig()
'VBA373
Dim objPicWindow As HMIPictureWindow
'
'Add new picturewindow into active document:
Set objPicWindow = ActiveDocument.HMIObjects.AddHMIObject("PicWindow1", "HMIPictureWindow")
With objPicWindow
.AdaptPicture = False
.AdaptSize = False
.Caption = True
.CaptionText = "Picturewindow in runtime"
.OffsetLeft = 5
.OffsetTop = 10
'
'Replace the picturename "Test.PDL" with the name of
'an existing document from your "GraCS"-Folder of your active project
.PictureName = "Test.PDL"
.ScrollBars = True
.ServerPrefix = ""
.TagPrefix = "Struct."
.UpdateCycle = 5
.Zoom = 100
End With
End Sub
See also
PictureWindow Object (Page 2033)
AdaptSize Property
Description
TRUE if the picture window size is to be adapted to the picture size. BOOLEAN write-read
access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2121
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "PictureWindowConfig" procedure accesses the properties of the picture window. In this
example the picture window will be configured:
Sub PictureWindowConfig()
'VBA374
Dim objPicWindow As HMIPictureWindow
'
'Add new picturewindow into active document:
Set objPicWindow = ActiveDocument.HMIObjects.AddHMIObject("PicWindow1", "HMIPictureWindow")
With objPicWindow
.AdaptPicture = False
.AdaptSize = False
.Caption = True
.CaptionText = "Picturewindow in runtime"
.OffsetLeft = 5
.OffsetTop = 10
'
'Replace the picturename "Test.PDL" with the name of
'an existing document from your "GraCS"-Folder of your active project
.PictureName = "Test.PDL"
.ScrollBars = True
.ServerPrefix = ""
.TagPrefix = "Struct."
.UpdateCycle = 5
.Zoom = 100
End With
End Sub
See also
PictureWindow Object (Page 2033)
AddIns property
Description
Only used internally.
See also
Application Object (Page 1915)
WinCC: Scripting (VBS, ANSI-C, VBA)
2122 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
AlarmGoneVisible property
Description
Defines whether an outgoing state is visible.
Assigned Value Description
True The outgoing state is visible.
False The outgoing state is suppressed.
AlarmHigh Property
Description
Defines the top limit value at which an alarm should be triggered or returned.
The type of the evaluation (in percent or absolute) is defined in the "TypeAlarmHigh" property.
The "CheckAlarmHigh" property defines whether the monitoring function for the limit value is
activated.
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "50".
Sub BarGraphLimitConfiguration()
'VBA375
Dim objBarGraph As HMIBarGraph
'
'Add new BarGraph to active document:
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolut
.TypeAlarmHigh = False
'Activate monitoring
.CheckAlarmHigh = True
'Set barcolor to "yellow"
.ColorAlarmHigh = RGB(255, 255, 0)
'set upper limit to "50"
.AlarmHigh = 50
End With
End Sub
See also
TypeAlarmHigh Property (Page 2454)
ColorAlarmHigh Property (Page 2189)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2123
VBA for Automated Configuration
3.6 VBA Reference
CheckAlarmHigh Property (Page 2177)
BarGraph Object (Page 1920)
AlarmLow Property
Description
Defines the bottom limit value at which an alarm should be triggered or returned.
The type of the evaluation (in percent or absolute) is defined in the "TypeAlarmLow" property.
The "CheckAlarmLow" property defines whether the monitoring function for the limit value is
activated.
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "10".
Sub BarGraphLimitConfiguration()
'VBA376
Dim objBarGraph As HMIBarGraph
'
'Add new BarGraph to active document:
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolut
.TypeAlarmLow = False
'Activate monitoring
.CheckAlarmLow = True
'Set Barcolor to "yellow"
.ColorAlarmLow = RGB(255, 255, 0)
'set lower limit to "10"
.AlarmLow = 10
End With
End Sub
See also
TypeAlarmLow Property (Page 2455)
ColorAlarmLow Property (Page 2190)
CheckAlarmLow Property (Page 2178)
BarGraph Object (Page 1920)
WinCC: Scripting (VBS, ANSI-C, VBA)
2124 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Alignment Property
Description
Defines or returns the scale display (left/right or top/bottom) depending on the position of the
BarGraph object. The Scaling property must be set to TRUE for the scale to be displayed.
Display Assigned Value
Right or bottom TRUE
Left or top FALSE
Example:
The "BarGraphConfiguration()" procedure configures In this example the scale is to be located
to the right of the bar:
Sub BarGraphConfiguration()
'VBA377
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.Alignment = True
.Scaling = True
End With
End Sub
See also
Scaling Property (Page 2407)
Direction Property (Page 2220)
BarGraph Object (Page 1920)
AlignmentLeft Property
Description
Defines or returns the horizontal alignment of the text. Value range from 0 to 2.
Horizontal Alignment Assigned Value
Left 0
Centered 1
Right 2
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2125
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this example
the text in the I/O field will be centered horizontally:
Sub IOFieldConfiguration()
'VBA378
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.AlignmentLeft = 1
End With
End Sub
Related topics
See also
AlignmentTop Property (Page 2126)
TextList Object (Page 2085)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
GroupDisplay Object (Page 1985)
IOField Object (Page 1996)
CheckBox Object (Page 1930)
Button Object (Page 1926)
AlignmentTop Property
Description
Defines or returns the vertical alignment of the text. Value range from 0 to 2.
Horizontal Alignment Assigned Value
Up 0
Centered 1
Down 2
WinCC: Scripting (VBS, ANSI-C, VBA)
2126 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this example
the text in the I/O field will be centered in the middle:
Sub IOFieldConfiguration()
'VBA379
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.AlignmentLeft = 1
.AlignmentTop = 1
End With
End Sub
See also
AlignmentLeft Property (Page 2125)
TextList Object (Page 2085)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
GroupDisplay Object (Page 1985)
IOField Object (Page 1996)
CheckBox Object (Page 1930)
Button Object (Page 1926)
AnalogResultInfos Property
Description
Returns the AnalogResultInfos listing. Use the AnalogResultInfos property to define value
ranges and property values in the Dynamic dialog.
Example:
An example showing how to use the AnalogResultInfos property can be found in this
documentation under the heading "AnalogResultInfos Object (Listing)".
See also
DynamicDialog Object (Page 1960)
AnalogResultInfos Object (Listing) (Page 1914)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2127
VBA for Automated Configuration
3.6 VBA Reference
AngleAlpha Property
Description
Defines or returns depth angle a for the 3D-effect of the "3DBarGraph" object. Value range in
degrees from 0 to 90.
Example:
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example depth angles A and B will be assigned the values "15" and 45:
Sub HMI3DBarGraphConfiguration()
'VBA380
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
'Depth-angle a = 15 degrees
.AngleAlpha = 15
'Depth-angle b = 45 degrees
.AngleBeta = 45
End With
End Sub
See also
AngleBeta Property (Page 2129)
3DBarGraph Object (Page 1900)
WinCC: Scripting (VBS, ANSI-C, VBA)
2128 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
AngleBeta Property
Description
Defines or returns depth angle b for the 3D-effect of the "3DBarGraph" object. Value range in
degrees from 0 to 90.
Example:
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example depth angles A and B will be assigned the values "15" and 45:
Sub HMI3DBarGraphConfiguration()
'VBA381
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
'Depth-angle a = 15 degrees
.AngleAlpha = 15
'Depth-angle b = 45 degrees
.AngleBeta = 45
End With
End Sub
See also
AngleAlpha Property (Page 2128)
3DBarGraph Object (Page 1900)
Application Property
Description
Returns the Graphics Designer application when the application property is used without an
object identifier. If the application property is used with object identifier, it returns an application
object which displays the application with which the defined object was created. Read only
access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2129
VBA for Automated Configuration
3.6 VBA Reference
Example:
In this example an Excel object is created and the application name is output:
Sub CreateExcelApplication()
'VBA382
'
'Open Excel invisible
Dim objExcelApp As New Excel.Application
MsgBox objExcelApp
'Delete the reference to Excel and close it
Set objExcelApp = Nothing
End Sub
See also
Application Object (Page 1915)
SVGLibraries object (list) (Page 2077)
SVGLibrary object (Page 2078)
ApplicationDataPath Property
Description
Returns the complete path of the active picture in the Graphics Designer. Read-only access.
Example:
The "ShowApplicationDataPath()" procedure outputs the path of the current picture:
Sub ShowApplicationDataPath()
'VBA383
MsgBox Application.ApplicationDataPath
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2130 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
Application Property (Page 2129)
Application Object (Page 1915)
AssemblyInfo property
Description
Displays the information of the object registered in the Global Assembly Cache. The
information is made up of "Assembly", "Version", "Culture" and "PublicKeyToken".
If the object is not registered in the Global Assembly Cache, the path of the object is only
displayed in "Assembly".
Assignments Property
Description
A list which contains the assignments between the output values and the actual output texts
to be output.
The assignments are dependent on the list type set. The list type is defined with the ListType
property.
The number of entries depends on the total length of the string passed to the "Assignments"
property. This string cannot be longer than 500,000 bytes. This may be checked prior to
dropping access to the "Assignments" property by using the function LenB().
Example:
--
See also
ListType Property (Page 2318)
TextList Object (Page 2085)
AssumeOnExit Property
Description
TRUE, if the entered text is assumed after exiting the input field (by using the <TAB> key or
mouse click, for example). BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2131
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this example
the text that has been entered will be taken over as input on exit from the input field.
Sub IOFieldConfiguration()
'VBA385
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.AssumeOnExit = True
End With
End Sub
See also
TextList Object (Page 2085)
IOField Object (Page 1996)
AssumeOnFull Property
Description
TRUE, when the content of the input field is full (specified number of characters have been
entered) and should be exited automatically and the input accepted. BOOLEAN write-read
access.
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this example
the text that has been entered will be taken over as input on exit from the input field.
Sub IOFieldConfiguration()
'VBA386
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.AssumeOnFull = True
End With
End Sub
See also
OutputFormat Property (Page 2362)
DataFormat Property (Page 2216)
IOField Object (Page 1996)
WinCC: Scripting (VBS, ANSI-C, VBA)
2132 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
AutomationName Property
Description
Depending on the source and destination object types for the direct connection, either defines
or returns the name of a property.
The two tables show you when you must use the AutomationName property. A "--" means that
the property is assigned an empty string (") by default when the DirectConnection object is
created.
Source object type (SourceLink Property)
Type Property AutomationName Property ObjectName Property
hmiSourceTypeConstant -- Name of the constant (e.g. the
picture name)
hmiSourceTypeProperty Property of the source object Name of the source object (e.g.
(e.g. "Top") "Rectangle_A")
hmiSourceTypePropertyOfThi‐ -- --
sObject
hmiSourceTypeVariableDirect -- Tag name
hmiSourceTypeVariableIndirect -- Tag name
Destination object type (DestinationLink Property)
Type Property AutomationName Property ObjectName Property
hmiDestTypeProperty Property of the destination ob‐ Name of the destination object
ject (e.g. "Left") (e.g. "Rectangle_A")
hmiDestTypePropertyOfThisObject -- --
hmiDestTypePropertyOfActual‐ Property of the destination ob‐ --
Window ject (e.g. "Left")
hmiDestTypeVariableDirect -- Tag name
hmiDestTypeVariableIndirect -- Tag name
hmiDestTypeDirectMessage -- Tag name
hmiDestTypeIndirectMessage -- Tag name
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2133
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the X position of "Rectangle_A" is copied to the Y position of
"Rectangle_B" in Runtime by clicking on the button:
Sub DirectConnection()
'VBA387
Dim objButton As HMIButton
Dim objRectangleA As HMIRectangle
Dim objRectangleB As HMIRectangle
Dim objEvent As HMIEvent
Dim objDynConnection As HMIDirectConnection
'
'Add objects to active document:
Set objRectangleA = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_A", "HMIRectangle")
Set objRectangleB = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_B", "HMIRectangle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
'
'to position and configure objects:
With objRectangleA
.Top = 100
.Left = 100
End With
With objRectangleB
.Top = 250
.Left = 400
.BackColor = RGB(255, 0, 0)
End With
With objButton
.Top = 10
.Left = 10
.Text = "SetPosition"
End With
'
'Directconnection is initiate by mouseclick:
Set objDynConnection =
objButton.Events(1).Actions.AddAction(hmiActionCreationTypeDirectConnection)
With objDynConnection
'Sourceobject: Top-Property of Rectangle_A
.SourceLink.Type = hmiSourceTypeProperty
.SourceLink.ObjectName = "Rectangle_A"
.SourceLink.AutomationName = "Top"
'
'Targetobject: Left-Property of Rectangle_B
.DestinationLink.Type = hmiDestTypeProperty
.DestinationLink.ObjectName = "Rectangle_B"
.DestinationLink.AutomationName = "Left"
End With
End Sub
See also
DestinationLink Property (Page 2218)
Type Property (Page 2453)
WinCC: Scripting (VBS, ANSI-C, VBA)
2134 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
SourceLink Property (Page 2424)
ObjectName Property (Page 2353)
SourceLink Object (Page 2069)
DestLink Object (Page 1950)
AvailableDataLanguages Property
Description
Returns a listing of the available project languages.
Example:
The "AusgabetDataLanguages()" procedure outputs all the existing project languages together
with their language identifiers (as a decimal value):
Sub OutputDataLanguages()
'VBA388
Dim colDataLang As HMIDataLanguages
Dim objDataLang As HMIDataLanguage
Dim strLangList As String
Dim iCounter As Integer
'
'Save collection of datalanguages
'into variable "colDataLang"
Set colDataLang = Application.AvailableDataLanguages
iCounter = 1
'
'Get every languagename and the assigned ID
For Each objDataLang In colDataLang
With objDataLang
If 0 = iCounter Mod 3 Or 1 = iCounter Then
strLangList = strLangList & vbCrLf & .LanguageID & " " & .LanguageName
Else
strLangList = strLangList & " / " & .LanguageID & " " & .LanguageName
End If
End With
iCounter = iCounter + 1
Next objDataLang
MsgBox strLangList
End Sub
See also
LanguageName Property (Page 2296)
LanguageID Property (Page 2296)
How to assign help texts to menus and toolbars (Page 1643)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2135
VBA for Automated Configuration
3.6 VBA Reference
How to create menus in multiple languages (Page 1637)
Language-Dependent Configuration with VBA (Page 1628)
Average Property
Description
TRUE, if the mean value is calculated based on the last 10 values. A value change is
conditional for calculation of a new mean value. The mean value is reset when you change a
picture. If only one value is available when you change the picture, the following mean value
is calculated: (5+0+0+0+0+0+0+0+0+0)/10=0,5.
BOOLEAN write-read access.
Example
The "BarGraphConfiguration()" procedure configures In this example, value averaging will be
activated:
Sub BarGraphConfiguration()
'VBA389
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.Average = True
End With
End Sub
See also
BarGraph Object (Page 1920)
Axe Property
Description
Defines or returns the axis for displaying the measured value. Value range from 0 to 2.
Axis Assigned Value
X 0
Y 1
Z 2
WinCC: Scripting (VBS, ANSI-C, VBA)
2136 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example the Y axis for displaying the measured value will be defined:
Sub HMI3DBarGraphConfiguration()
'VBA390
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
.Axe = 1
End With
End Sub
See also
3DBarGraph Object (Page 1900)
AxisSection Property
Description
Defines or returns the distance between two long axis sections. The information on the distance
is given in scale units and is dependent on the minimum and maximum values configured.
BarGraph Object (Minimum/Maximum Value: -5/5; AxisSection = 2)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2137
VBA for Automated Configuration
3.6 VBA Reference
Example
The "BarGraphConfiguration()" procedure accesses the properties of the BarGraph object. In
this example the axis section will be set to "2".
Sub BarGraphConfiguration()
'VBA391
Dim objBar As HMIBarGraph
Set objBar = ActiveDocument.HMIObjects.AddHMIObject("Bar1",
"HMIBarGraph")
With objBar
.AxisSection = 2
End With
End Sub
See also
BarGraph Object (Page 1920)
BackBorderWidth Property
Description
Defines or returns the width of the 3D border in pixels. The value for the width is dependent
on the size of the object.
Slider
Defines or returns the width of the border in pixels. BackBorderWidth = 0 prevents the border
being displayed on the Slider object.
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the width of the 3D border will be set to "2".
Sub ButtonConfiguration()
'VBA392
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.BackBorderWidth = 2
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2138 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
Slider object (Page 2066)
RoundButton Object (Page 2055)
GroupDisplay Object (Page 1985)
Button Object (Page 1926)
BackColor Property
Description
Defines or returns the background color for the object. LONG read-write access.
The background color is not displayed if "transparent" is defined as the fill pattern.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example the background color will be set to "Yellow".
Sub RectangleConfiguration()
'VBA393
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.BackColor = RGB(255, 255, 0)
End With
End Sub
See also
EllipseSegment Object (Page 1968)
StaticText Object (Page 2071)
Slider object (Page 2066)
TextList Object (Page 2085)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2139
VBA for Automated Configuration
3.6 VBA Reference
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
GroupDisplay Object (Page 1985)
GraphicObject Object (Page 1980)
IOField Object (Page 1996)
Ellipse Object (Page 1962)
Document Object (Page 1954)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BarGraph Object (Page 1920)
3DBarGraph Object (Page 1900)
BackColor2 Property
Description
Defines or returns the bar color for the display of the current value. LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "BarGraphConfiguration()" procedure configures In this example the bar color for
displaying the current value will be set to "Yellow":
Sub BarGraphConfiguration()
'VBA394
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.BackColor2 = RGB(255, 255, 0)
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2140 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
BarGraph Object (Page 1920)
BackColor3 Property
Description
Defines or returns the color of the bar background. LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "BarGraphConfiguration()" procedure configures In this example the color of the bar
background will be set to "Blue":
Sub BarGraphConfiguration()
'VBA395
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.BackColor3 = RGB(0, 0, 255)
End With
End Sub
See also
BarGraph Object (Page 1920)
BackColor_Alarm.._Warning property
Description
Defines the color used for the background of one of the following states or message types:
● Alarm
● Warning
● Tolerance
● AS Process Control Error
● AS Control System Fault
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2141
VBA for Automated Configuration
3.6 VBA Reference
● Operator request
● OK
● Simulation
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
BackColorBottom Property
Description
Defines or returns the color for the bottom/right part of the slider. LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "SliderConfiguration()" procedure accesses the properties of the slider. In this example
the color of the bottom part of the slider will be set to "Blue":
Sub SliderConfiguration()
'VBA396
Dim objSlider As HMISlider
Set objSlider = ActiveDocument.HMIObjects.AddHMIObject("SliderObject1", "HMISlider")
With objSlider
.BackColorBottom = RGB(0, 0, 255)
End With
End Sub
See also
Slider object (Page 2066)
BackColorTop Property
Description
Defines or returns the color for the top/left part of the slider. LONG write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2142 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "SliderConfiguration()" procedure accesses the properties of the slider. In this example
the color of the top part of the slider will be set to "Yellow":
Sub SliderConfiguration()
'VBA397
Dim objSlider As HMISlider
Set objSlider = ActiveDocument.HMIObjects.AddHMIObject("SliderObject1", "HMISlider")
With objSlider
.BackColorTop = RGB(255, 255, 0)
End With
End Sub
See also
Slider object (Page 2066)
BackFillColor property
Description
Defines the color with which the background is filled at an advanced analog display.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
BackFillColor_OK property
Description
Defines the color with which the background is filled at the state "OK".
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2143
VBA for Automated Configuration
3.6 VBA Reference
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
BackFillColor_Simulation property
Description
Defines the color with which the background is filled at the "Simulation" state.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
BackFillStyle property
Description
Defines the pattern with which the background is filled at an advanced analog display.
There is a choice of 50 fill patterns. The fill pattern 0 "Solid" fills the object with the set
background color; the fill pattern 1 "Transparent" defines that neither a background nor a fill
pattern is displayed.
BackFillStyle_OK property
Description
Defines the pattern with which the background is displayed at the state "OK".
There is a choice of 50 fill patterns. The fill pattern 0 "Solid" fills the object with the set
background color; the fill pattern 1 "Transparent" defines that neither a background nor a fill
pattern is displayed.
BackFillStyle_Simulation property
Description
Defines the pattern with which the background is displayed at the "Simulation" state.
There is a choice of 50 fill patterns. The fill pattern 0 "Solid" fills the object with the set
background color; the fill pattern 1 "Transparent" defines that neither a background nor a fill
pattern is displayed.
WinCC: Scripting (VBS, ANSI-C, VBA)
2144 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
BackFlashColorOff Property
Description
Defines or returns the color of the object background for the flash status "Off". LONG write-
read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example the color when the flash status is "Off" will be set to "Yellow":
Sub RectangleConfiguration()
'VBA398
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.BackFlashColorOff = RGB(255, 255, 0)
End With
End Sub
See also
BarGraph Object (Page 1920)
StaticText Object (Page 2071)
Slider object (Page 2066)
TextList Object (Page 2085)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
GraphicObject Object (Page 1980)
IOField Object (Page 1996)
EllipseSegment Object (Page 1968)
Ellipse Object (Page 1962)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2145
VBA for Automated Configuration
3.6 VBA Reference
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BackFlashColorOn Property
Description
Defines or returns the color of the object background for the flash status "On". LONG write-
read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example the color when the flash status is "On" will be set to "Blue":
Sub RectangleConfiguration()
'VBA399
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.BackFlashColorOn = RGB(0, 0, 255)
End With
End Suba
See also
RoundButton Object (Page 2055)
StaticText Object (Page 2071)
Slider object (Page 2066)
TextList Object (Page 2085)
RoundRectangle Object (Page 2059)
Rectangle Object (Page 2053)
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
GraphicObject Object (Page 1980)
WinCC: Scripting (VBS, ANSI-C, VBA)
2146 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
IOField Object (Page 1996)
EllipseSegment Object (Page 1968)
Ellipse Object (Page 1962)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BarGraph Object (Page 1920)
Background Property
Description
TRUE, when the background of the 3D-bar graph object should be visible. BOOLEAN write-
read access.
Example:
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example the background will be set to "Transparent":
Sub HMI3DBarGraphConfiguration()
'VBA400
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
.Background = False
End With
End Sub
See also
3DBarGraph Object (Page 1900)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2147
VBA for Automated Configuration
3.6 VBA Reference
BackPictureAlignment property
Description
As the "Display type" attribute, defines the position and scaling for the background image of
the process picture.
normal The background picture is centered in the original size. When opening the
picture in runtime, it remains in the location.
Stretched (win‐ The background picture is scaled to the runtime window and process picture
dow) of the larger of the two windows. In runtime, it is scaled to the size of the
runtime window and is scaled when you resize the picture.
Tiled Graphics Designer and process picture are exhibited with the picture in its
original size.
Stretched (pic‐ The background picture is scaled to the configured size of the process pic‐
ture) ture. When opening the picture in runtime, it retains its size.
BackPictureName property
Description
Defines or returns the path and name of the file used as the background image in the process
picture.
Files of format EMF, WMF, DB, BMP, GIF, JPG, JPEG and ICO are suitable.
If no path is specified, the file is searched for in the subdirectory \GraCS. If you specify a
different path, a copy is created in the \GraCS directory.
Path specifications
The following path specification formats are possible:
● Absolute: z.B. "C:\Siemens\WinCC\Icons\myIcon.ICO.
● Relative: The starting folder for relative path specification is the "GraCS" folder of the current
project.
● <global>: Refers to the installation path for WinCC. The path specification "<global>\Icons
\myIcon" is the same as the path specification under "Absolute".
● <project>: Refers to the current project directory.
BarDepth Property
Description
Defines or returns the depth of the bar in pixels.
WinCC: Scripting (VBS, ANSI-C, VBA)
2148 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example the bar depth will be set to "40":
Sub HMI3DBarGraphConfiguration()
'VBA401
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
.BarDepth = 40
End With
End Sub
See also
3DBarGraph Object (Page 1900)
BarHeight Property
Description
Defines or returns the height of the bar in pixels.
Example:
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example the bar height will be set to "60":
Sub HMI3DBarGraphConfiguration()
'VBA402
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
.BarHeight = 60
End With
End Sub
See also
3DBarGraph Object (Page 1900)
BarWidth Property
Description
Defines or returns the width of the bar in pixels.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2149
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example the bar width will be set to "80":
Sub HMI3DBarGraphConfiguration()
'VBA403
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
.BarWidth = 80
End With
End Sub
See also
3DBarGraph Object (Page 1900)
BasePicReferenced Property
Description
TRUE, when the picture assigned in the object status display should be saved. Otherwise,
only the associated object reference is saved. BOOLEAN write-read access.
Example:
The "StatusDisplayConfiguration()" procedure accesses the properties of the Status Display.
In this example the picture assigned in the Status Display object is to be saved.
Sub StatusDisplayConfiguration()
'VBA404
Dim objStatDisp As HMIStatusDisplay
Set objStatDisp = ActiveDocument.HMIObjects.AddHMIObject("Statusdisplay1",
"HMIStatusDisplay")
With objStatDisp
.BasePicReferenced = True
End With
End Sub
See also
StatusDisplay Object (Page 2074)
WinCC: Scripting (VBS, ANSI-C, VBA)
2150 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
BasePicTransColor Property
Description
Defines or returns which color of the assigned bitmap object (.bmp, .dib) should be set to
"transparent". LONG write-read access.
The color is only set to "Transparent" if the value of the "BasePicUseTransColor" property is
"True".
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "StatusDisplayConfiguration()" procedure accesses the properties of the Status Display.
In this example the color "Yellow" will be set to "Transparent".
Sub StatusDisplayConfiguration()
'VBA405
Dim objStatDisp As HMIStatusDisplay
Set objStatDisp = ActiveDocument.HMIObjects.AddHMIObject("Statusdisplay1",
"HMIStatusDisplay")
With objStatDisp
.BasePicTransColor = RGB(255, 255, 0)
.BasePicUseTransColor = True
End With
End Sub
See also
BasePicUseTransColor Property (Page 2152)
StatusDisplay Object (Page 2074)
BasePicture Property
Description
Defines or returns the basic picture for the Status Display object.
The picture (*.BMP or *.DIB) must be located in the "GraCS" directory of the current project
so that it can be integrated.
In this context, the "BasePicReferenced" property defines whether the basic picture should be
saved together with the object status display or referenced.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2151
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "StatusDisplayConfiguration()" procedure accesses the properties of the Status Display.
In this example the picture "Testpicture.BMP" will be used as the basic picture:
Sub StatusDisplayConfiguration()
'VBA406
Dim objStatDisp As HMIStatusDisplay
Set objStatDisp = ActiveDocument.HMIObjects.AddHMIObject("Statusdisplay1",
"HMIStatusDisplay")
With objStatDisp
'
'To use this example copy a Bitmap-Graphic
'to the "GraCS"-Folder of the actual project.
'Replace the picturename "Testpicture.BMP" with the name of
'the picture you copied
.BasePicture = "Testpicture.BMP"
End With
End Sub
See also
BasePicReferenced Property (Page 2150)
StatusDisplay Object (Page 2074)
BasePicture property
Description
Specifies which picture is to be displayed for the currently selected status. Pictures with the
following formats can be inserted: EMF, WMF, BMP, GIF, JPG.
If no picture that you want to display is defined for a status, the symbol for the status display
is shown as a placeholder.
BasePicUseTransColor Property
Description
TRUE, when the configured color ("BasePicTransColor" property) of the bitmap objects should
be set to "transparent". BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2152 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "StatusDisplayConfiguration()" procedure accesses the properties of the Status Display.
In this example the color "Yellow" will be set to "Transparent":
Sub StatusDisplayConfiguration()
'VBA407
Dim objStatDisp As HMIStatusDisplay
Set objStatDisp = ActiveDocument.HMIObjects.AddHMIObject("Statusdisplay1",
"HMIStatusDisplay")
With objStatDisp
.BasePicTransColor = RGB(255, 255, 0)
.BasePicUseTransColor = True
End With
End Sub
See also
BasePicTransColor Property (Page 2151)
StatusDisplay Object (Page 2074)
BaseX Property
Description
Defines or returns for the 3DBarGraph object the horizontal distance in pixels between the
right-hand border of the bar and the left-hand border of the object field.
Example:
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example the horizontal distance will be set to "80".
Sub HMI3DBarGraphConfiguration()
'VBA408
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
.BaseX = 80
End With
End Sub
See also
3DBarGraph Object (Page 1900)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2153
VBA for Automated Configuration
3.6 VBA Reference
BaseY Property
Description
Defines or returns for the 3DBarGraph object the vertical distance in pixels between the lower
border of the bar and the upper border of the object field.
Example:
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example the vertical distance will be set to "100".
Sub HMI3DBarGraphConfiguration()
'VBA409
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
.BaseY = 100
End With
End Sub
See also
3DBarGraph Object (Page 1900)
BinaryResultInfo Property
Description
Returns the BinaryResultInfo object.
Example:
An example showing how to use the BinaryResultInfo property can be found in this
documentation under the heading "BinaryResultInfo Object".
See also
BinaryResultInfo Object (Page 1924)
BitNotSetValue Property
Description
Defines or returns the value for the dynamic property if the specified bit of a configured tag is
not set.
WinCC: Scripting (VBS, ANSI-C, VBA)
2154 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
To define which bit must be set in order to trigger a change of value, use the BitNumber
property.
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog, a tag name will be assigned, the bit to be set will be defined and the associated property
values will be assigned to the "set"/"not set" states:
Sub AddDynamicDialogToCircleRadiusTypeBit()
'VBA410
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_B", "HMICircle")
Set objDynDialog = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'NewDynamic1'")
With objDynDialog
.ResultType = hmiResultTypeBit
.Trigger.VariableTriggers(1).CycleType = hmiVariableCycleType_5s
.BitResultInfo.BitNumber = 1
.BitResultInfo.BitSetValue = 40
.BitResultInfo.BitNotSetValue = 80
End With
End Sub
See also
BitNumber Property (Page 2155)
BitResultInfo Object (Page 1925)
BitNumber Property
Description
Defines or returns the bit whose status must change in order to trigger a change of value. The
tag used must be of the type BYTE, WORD or DWORD.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2155
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog, a tag name will be assigned, the bit to be set will be defined and the associated property
values will be assigned to the "set"/"not set" states:
Sub AddDynamicDialogToCircleRadiusTypeBit()
'VBA411
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_B", "HMICircle")
Set objDynDialog = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'NewDynamic1'")
With objDynDialog
.ResultType = hmiResultTypeBit
.BitResultInfo.BitNumber = 1
.BitResultInfo.BitSetValue = 40
.BitResultInfo.BitNotSetValue = 80
End With
End Sub
See also
BitResultInfo Object (Page 1925)
VBA Reference (Page 1752)
BitPosition0..3 property
Description
Specifies the bit position of the selected tag for which the respective bit (0 to 3) of the status
value is used. The content is only evaluated when a tag is selected for the respective property
"BitSelect0..3". The tags are specified using "Process" and "Process1..3".
You can enter a value from "0" to "31". Each value can only be assigned once.
BitResultInfo Property
Description
Returns the BitResultInfo object.
Example:
An example showing how to use the BitResultInfo property can be found in this documentation
under the heading "BitResultInfo Object".
WinCC: Scripting (VBS, ANSI-C, VBA)
2156 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
BitResultInfo Object (Page 1925)
BitSelect0..3 property
Description
Specifies the status tag for which the respective (first to fourth) bit of the status value is
specified. The tags are specified using the properties "Process" and "Process1..3".
0 The respective bit of the status value is not evaluated. No status tag is used.
1 Status tag "Process" is used for the respective bit of the status value.
2 Status tag "Process1" is used for the respective bit of the status value.
3 Status tag "Process2" is used for the respective bit of the status value.
4 Status tag "Process3" is used for the respective bit of the status value.
BitSetValue Property
Description
Defines or returns the value for the dynamic property if the specified bit of a configured tag is
set.
To define which bit must be set in order to trigger a change of value, use the BitNumber
property.
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog, a tag name will be assigned, the bit to be set will be defined and the associated property
values will be assigned to the "set"/"not set" states:
Sub AddDynamicDialogToCircleRadiusTypeBit()
'VBA412
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_B", "HMICircle")
Set objDynDialog = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'NewDynamic1'")
With objDynDialog
.ResultType = hmiResultTypeBit
.BitResultInfo.BitNumber = 1
.BitResultInfo.BitSetValue = 40
.BitResultInfo.BitNotSetValue = 80
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2157
VBA for Automated Configuration
3.6 VBA Reference
See also
BitNumber Property (Page 2155)
BitResultInfo Object (Page 1925)
Bold Property
Description
TRUE if the font attribute "Bold" is set for the language-dependent text in the object. BOOLEAN
write-read access.
Example:
Note
For this example to work, you must already have configured in the languages concerned.
The following example sets the font attributes of a button for French and English:
Sub ExampleForLanguageFonts()
'VBA413
Dim colLangFonts As HMILanguageFonts
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
objButton.Text = "Displaytext"
Set colLangFonts = objButton.LDFonts
'Set french fontproperties:
With colLangFonts.ItemByLCID(1036)
.Family = "Courier New"
.Bold = True
.Italic = False
.Underlined = True
.Size = 12
End With
'Set english fontproperties:
With colLangFonts.ItemByLCID(1033)
.Family = "Times New Roman"
.Bold = False
.Italic = True
.Underlined = False
.Size = 14
End With
End Sub
See also
Underlined Property (Page 2463)
Size Property (Page 2422)
WinCC: Scripting (VBS, ANSI-C, VBA)
2158 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parent Property (Page 2364)
LanguageID Property (Page 2296)
Italic Property (Page 2288)
Family Property (Page 2236)
Application Property (Page 2129)
LanguageFont Object (Page 2000)
BorderBackColor Property
Description
Defines or returns the background color of the line for the object. LONG write-read access.
The background color is only visible if the BorderStyle property is set >0.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example the background color for the line will be set to "Yellow":
Sub RectangleConfiguration()
'VBA415
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.BorderBackColor = RGB(255, 255, 0)
End With
End Sub
See also
PieSegment Object (Page 2036)
BorderStyle Property (Page 2167)
TextList Object (Page 2085)
StatusDisplay Object (Page 2074)
StaticText Object (Page 2071)
Slider object (Page 2066)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2159
VBA for Automated Configuration
3.6 VBA Reference
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
PolyLine Object (Page 2042)
OptionGroup Object (Page 2029)
Line Object (Page 2008)
IOField Object (Page 1996)
GraphicObject Object (Page 1980)
EllipseArc Object (Page 1965)
EllipseSegment Object (Page 1968)
Ellipse Object (Page 1962)
CircularArc Object (Page 1936)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BarGraph Object (Page 1920)
BorderColor Property
Description
Defines or returns the line color for the object. LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2160 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example the line color will be set to "Blue":
Sub RectangleConfiguration()
'VBA416
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.BorderColor = RGB(0, 0, 255)
End With
End Sub
See also
GraphicObject Object (Page 1980)
TextList Object (Page 2085)
StatusDisplay Object (Page 2074)
StaticText Object (Page 2071)
Slider object (Page 2066)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
PolyLine Object (Page 2042)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
Line Object (Page 2008)
IOField Object (Page 1996)
EllipseArc Object (Page 1965)
EllipseSegment Object (Page 1968)
Ellipse Object (Page 1962)
CircularArc Object (Page 1936)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BarGraph Object (Page 1920)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2161
VBA for Automated Configuration
3.6 VBA Reference
BorderColorBottom Property
Description
Defines or returns the color for the bottom right-hand part of the 3D-border. LONG write-read
access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the 3D-border color will be defined:
Sub ButtonConfiguration()
'VBA417
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.BorderColorBottom = RGB(255, 0, 0)
.BorderColorTop = RGB(0, 0, 255)
End With
End Sub
See also
RoundButton Object (Page 2055)
Button Object (Page 1926)
BorderColorTop Property
Description
Defines or returns the color for the top left-hand part of the 3D-border. LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2162 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the 3D-border color will be defined:
Sub ButtonConfiguration()
'VBA418
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.BorderColorBottom = RGB(255, 0, 0)
.BorderColorTop = RGB(0, 0, 255)
End With
End Sub
See also
RoundButton Object (Page 2055)
Button Object (Page 1926)
BorderEndStyle Property
Description
Defines or returns the line end style of the object. LONG read-write access.
Determination of Line End Style
Determine the line end type with the aid of a five-character hexadecimal value which you then
convert into its equivalent decimal value.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2163
VBA for Automated Configuration
3.6 VBA Reference
To determine the line ends for the object, go to the "Line End Style" window and proceed as
follows:
● Left column: Configures the start of the line. Value range (from the top down) 0 to 6. The
start of the line corresponds to the first character in the hexadecimal value. In the
configuration shown, the value of the first character is "3".
● Right Column: Configures the end of the line. Value range (from the top down) 0 to 6. The
line end corresponds to the fifth character in the hexadecimal value. In the configuration
shown, the value of the fifth character is "6".
This gives a hexadecimal value of "60003". This corresponds to a decimal value of "393219",
which you then assign to the BorderEndStyle property.
Example:
The "LineConfiguration()" procedure accesses the properties of the line. In this example the
type of line end will be set to the configuration illustrated above:
Sub LineConfiguration()
'VBA419
Dim objLine As HMILine
Set objLine = ActiveDocument.HMIObjects.AddHMIObject("Line1", "HMILine")
With objLine
.BorderEndStyle = 393219
End With
End Sub
See also
PolyLine Object (Page 2042)
Line Object (Page 2008)
BorderFlashColorOff Property
Description
Defines or returns the color of the object lines for the flashing status "Off". LONG write-read
access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2164 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example the color when the flash status is "Off" will be set to "Black":
Sub RectangleConfiguration()
'VBA420
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.BorderFlashColorOff = RGB(0, 0, 0)
End With
End Sub
See also
RoundButton Object (Page 2055)
StatusDisplay Object (Page 2074)
StaticText Object (Page 2071)
Slider object (Page 2066)
TextList Object (Page 2085)
RoundRectangle Object (Page 2059)
Rectangle Object (Page 2053)
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
Line Object (Page 2008)
GraphicObject Object (Page 1980)
IOField Object (Page 1996)
EllipseSegment Object (Page 1968)
EllipseArc Object (Page 1965)
Ellipse Object (Page 1962)
CircularArc Object (Page 1936)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2165
VBA for Automated Configuration
3.6 VBA Reference
BorderFlashColorOn Property
Description
Defines or returns the color of the object lines for the flashing status "On". LONG write-read
access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example the color when the flash status is "On" will be set to "Red":
Sub RectangleConfiguration()
'VBA421
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.BorderFlashColorOn = RGB(255, 0, 0)
End With
End Sub
See also
StaticText Object (Page 2071)
StatusDisplay Object (Page 2074)
Slider object (Page 2066)
TextList Object (Page 2085)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
Line Object (Page 2008)
GraphicObject Object (Page 1980)
IOField Object (Page 1996)
WinCC: Scripting (VBS, ANSI-C, VBA)
2166 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
EllipseSegment Object (Page 1968)
EllipseArc Object (Page 1965)
Ellipse Object (Page 1962)
CircularArc Object (Page 1936)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BorderStyle Property
Description
Defines or returns the line style for the object. Value range from 0 to 4:
Line style Assigned Value
0
1
2
3
4
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example the line style will be set to "1":
Sub RectangleConfiguration()
'VBA422
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.BorderStyle = 1
End With
End Sub
See also
IOField Object (Page 1996)
StatusDisplay Object (Page 2074)
StaticText Object (Page 2071)
Slider object (Page 2066)
RoundRectangle Object (Page 2059)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2167
VBA for Automated Configuration
3.6 VBA Reference
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
Polygon Object (Page 2039)
PolyLine Object (Page 2042)
TextList Object (Page 2085)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
Line Object (Page 2008)
GraphicObject Object (Page 1980)
EllipseSegment Object (Page 1968)
EllipseArc Object (Page 1965)
Ellipse Object (Page 1962)
CircularArc Object (Page 1936)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BarGraph Object (Page 1920)
3DBarGraph Object (Page 1900)
BorderWidth Property
Description
Defines or returns the line weight (in pixels) for the object.
Example:
in the following example the line weight of a newly added circle will be set to "2".
Sub CircleConfiguration()
'VBA423
Dim objCircle As IHMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle1", "HMICircle")
With objCircle
.BorderWidth = 2
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2168 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
IOField Object (Page 1996)
StatusDisplay Object (Page 2074)
StaticText Object (Page 2071)
Slider object (Page 2066)
TextList Object (Page 2085)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
Line Object (Page 2008)
GraphicObject Object (Page 1980)
EllipseSegment Object (Page 1968)
EllipseArc Object (Page 1965)
Ellipse Object (Page 1962)
CircularArc Object (Page 1936)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BottomConnectedObjectName Property
Description
Returns the name of the starting object to which the connector is Read only access.
Example:
An example showing how to use the BottomConnectedObjectName property can be found in
this documentation under the heading "ObjConnection Object".
See also
ObjConnection object (Page 2023)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2169
VBA for Automated Configuration
3.6 VBA Reference
BottomConnectedConnectionPointIndex Property
Description
Returns the connection point on the object to which the connector is connected.
Connection Point Assigned Value
Up 0
Right 1
Down 2
Left 3
Example:
An example showing how to use the BottomConnectedObjectName property can be found in
this documentation under the heading "ObjConnection Object".
See also
ObjConnection object (Page 2023)
BoxAlignment Property
Description
TRUE, when the fields are arranged aligned to the right. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2170 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "CreateOptionGroup()" procedure creates the OptionGroup object with four option
buttons. Each option button is assigned the default name "myCustomText<Nummer>":
Sub CreateOptionGroup()
'VBA424
Dim objRadioBox As HMIOptionGroup
Dim iCounter As Integer
Set objRadioBox = ActiveDocument.HMIObjects.AddHMIObject("RadioBox_1", "HMIOptionGroup")
iCounter = 1
With objRadioBox
.Height = 100
.Width = 180
.BoxCount = 4
.BoxAlignment = False
For iCounter = 1 To .BoxCount
.index = iCounter
.Text = "CustomText" & .index
Next iCounter
End With
End Sub
See also
BoxCount Property (Page 2171)
OptionGroup Object (Page 2029)
CheckBox Object (Page 1930)
BoxCount Property
Description
Defines or returns the number of fields. Value range from 1 to 64.
Example
The "CreateOptionGroup()" procedure creates the OptionGroup object with four option buttons.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2171
VBA for Automated Configuration
3.6 VBA Reference
Each option button is assigned the default name "myCustomText<Number>":
Sub CreateOptionGroup()
'VBA425
Dim objRadioBox As HMIOptionGroup
Dim iCounter As Integer
Set objRadioBox = ActiveDocument.HMIObjects.AddHMIObject("RadioBox_1", "HMIOptionGroup")
iCounter = 1
With objRadioBox
.Height = 100
.Width = 180
.BoxCount = 4
.BoxAlignment = True
For iCounter = 1 To .BoxCount
.index = iCounter
.Text = "CustomText" & .index
Next iCounter
End With
End Sub
See also
BoxAlignment Property (Page 2170)
OptionGroup Object (Page 2029)
CheckBox Object (Page 1930)
BoxType Property
Description
Defines or returns the field type. Value range from 0 to 2.
Field type Assigned Value
Edition 0
Input 1
I/O field 2
WinCC: Scripting (VBS, ANSI-C, VBA)
2172 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this example
the field type is configured as "Input":
Sub IOFieldConfiguration()
'VBA426
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.BoxType = 1
End With
End Sub
See also
IOField Object (Page 1996)
Button1..8MessageClasses
Description
Defines one or more message events in the group display for representing the respective
command button. This is done by entering the numbers of the bits in the collective value.
If you want to assign several message events, delimit the numbers with a comma. The order
of assignment defines the priority. If there is more than one selected event for one button, the
event that has been entered first is displayed.
The same event can be visualized simultaneously in several buttons.
Button1..8Width property
Description
Defines or returns for the "Group Display" object the width of the respective button in pixels.
When the "SameSize" property is set to "TRUE", all buttons are set to the same width.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2173
VBA for Automated Configuration
3.6 VBA Reference
Example
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the width of button "1" is set to "50":
Sub GroupDisplayConfiguration()
'VBA427
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.Button1Width = 50
End With
End Sub
See also
SameSize Property (Page 2405)
GroupDisplay Object (Page 1985)
ButtonColor Property
Description
Defines or returns the color of the slider for the Slider object. LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "SliderConfiguration()" procedure accesses the properties of the slider. In this example
the color of the slider will be set to "Yellow".
Sub SliderConfiguration()
'VBA431
Dim objSlider As HMISlider
Set objSlider = ActiveDocument.HMIObjects.AddHMIObject("SliderObject1", "HMISlider")
With objSlider
.ButtonColor = RGB(255, 255, 0)
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2174 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
Slider object (Page 2066)
Caption Property
Description
TRUE, when the application or picture window has a title bar in Runtime. BOOLEAN write-read
access.
The Caption property must be set to "True" if the intention is that the application window or
picture window shall have Maximize and Close buttons.
Example:
The "ApplicationWindowConfig" procedure accesses the properties of the application window.
In this example the application window will
Sub ApplicationWindowConfig()
'VBA432
Dim objAppWindow As HMIApplicationWindow
Set objAppWindow = ActiveDocument.HMIObjects.AddHMIObject("AppWindow",
"HMIApplicationWindow")
With objAppWindow
.Caption = True
.CloseButton = False
.Height = 200
.Left = 10
.MaximizeButton = True
.Moveable = False
.OnTop = True
.Sizeable = True
.Top = 20
.Visible = True
.Width = 250
.WindowBorder = True
End With
End Sub
See also
PictureWindow Object (Page 2033)
ApplicationWindow Object (Page 1917)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2175
VBA for Automated Configuration
3.6 VBA Reference
CaptionText property
Description
Defines or returns the window title that will be displayed for the PictureWindow object in
Runtime. The window title is displayed as "Header" object property.
The Caption property must be set to "True".
Example
The "PictureWindowConfig" procedure accesses the properties of the picture window. In this
example the picture window will be configured:
Sub PictureWindowConfig()
'VBA433
Dim objPicWindow As HMIPictureWindow
Set objPicWindow = ActiveDocument.HMIObjects.AddHMIObject("PicWindow1", "HMIPictureWindow")
With objPicWindow
.AdaptPicture = False
.AdaptSize = False
.Caption = True
.CaptionText = "Picturewindow in runtime"
.OffsetLeft = 5
.OffsetTop = 10
'Replace the picturename "Test.PDL" with the name of
'an existing document from your "GraCS"-Folder of your active project
.PictureName = "Test.PDL"
.ScrollBars = True
.ServerPrefix = ""
.TagPrefix = "Struct."
.UpdateCycle = 5
.Zoom = 100
End With
End Sub
See also
PictureWindow Object (Page 2033)
CBackColorOff..ColorOn property
Description
Specifies for the selected message type and the state "Came In" which color the background
of the value to be displayed assumes for flashing status "Off" (CBackColorOff) or "On"
(CBackColorOn).
WinCC: Scripting (VBS, ANSI-C, VBA)
2176 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0).
CBackFlash property
Description
Specifies for the selected message type and status "Came In" whether the background of the
value to be displayed flashes when a message is received.
CheckAlarmHigh Property
Description
TRUE if the "Alarm High" limit value is being monitored for the BarGraph object. BOOLEAN
write-read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
via the properties AlarmHigh, ColorAlarmHigh and TypeAlarmHigh.
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "50".
Sub BarGraphLimitConfiguration()
'VBA434
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeAlarmHigh = False
'Activate monitoring
.CheckAlarmHigh = True
'Set barcolor to "yellow"
.ColorAlarmHigh = RGB(255, 255, 0)
'Set upper limit to "50"
.AlarmHigh = 50
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2177
VBA for Automated Configuration
3.6 VBA Reference
See also
TypeAlarmHigh Property (Page 2454)
ColorAlarmHigh Property (Page 2189)
AlarmHigh Property (Page 2123)
BarGraph Object (Page 1920)
CheckAlarmLow Property
Description
TRUE if the "Alarm Low" limit value is being monitored for the BarGraph object. BOOLEAN
write-read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
via the properties AlarmLow, ColorAlarmLow and TypeAlarmLow.
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "10".
Sub BarGraphLimitConfiguration()
'VBA435
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeAlarmLow = False
'Activate monitoring
.CheckAlarmLow = True
'Set barcolor to "yellow"
.ColorAlarmLow = RGB(255, 255, 0)
'Set lower limit to "10"
.AlarmLow = 10
End With
End Sub
See also
ColorAlarmLow Property (Page 2190)
TypeAlarmLow Property (Page 2455)
AlarmLow Property (Page 2124)
BarGraph Object (Page 1920)
WinCC: Scripting (VBS, ANSI-C, VBA)
2178 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Checked Property
Description
TRUE if a check mark is to appear in front of the user-defined menu entry. BOOLEAN write-
read access.
Example:
The "CreateMenuItem()" procedure creates the "Delete Objects" menu and adds two menu
entries ("Delete Rectangles" and "Delete Circles"): The first menu entry is also marked with a
tick:
Sub CreateMenuItem()
'VBA436
Dim objMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
'
'Add new menu "Delete objects" to menubar:
Set objMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DeleteObjects", "Delete objects")
'
'Add two menuitems to the new menu
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(1, "DeleteAllRectangles", "Delete
Rectangles")
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(2, "DeleteAllCircles", "Delete Circles")
With objMenu.MenuItems
.Item("DeleteAllRectangles").Checked = True
End With
End Sub
See also
MenuItems Property (Page 2342)
Configuring Menus and Toolbars (Page 1630)
CheckLimitHigh4 Property
Description
TRUE if the "Reserve 4" high limit value of the bar graph object is to be monitored. BOOLEAN
write-read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
via the properties LimitHigh4, ColorLimitHigh4 and TypeLimitHigh4.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2179
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "70".
Sub BarGraphLimitConfiguration()
'VBA437
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeLimitHigh4 = False
'Activate monitoring
.CheckLimitHigh4 = True
'set barcolor to "red"
.ColorLimitHigh4 = RGB(255, 0, 0)
'Set upper limit to "70"
.LimitHigh4 = 70
End With
End Sub
See also
TypeLimitHigh4 Property (Page 2455)
LimitHigh4 Property (Page 2312)
ColorLimitHigh4 Property (Page 2193)
BarGraph Object (Page 1920)
CheckLimitHigh5 Property
Description
TRUE if the "Reserve 5" high limit value of the bar graph object is to be monitored. BOOLEAN
write-read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
via the properties LimitHigh5, ColorLimitHigh5 and TypeLimitHigh5.
WinCC: Scripting (VBS, ANSI-C, VBA)
2180 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "80".
Sub BarGraphLimitConfiguration()
'VBA438
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeLimitHigh5 = False
'Activate monitoring
.CheckLimitHigh5 = True
'set barcolor to "black"
.ColorLimitHigh5 = RGB(0, 0, 0)
'Set upper limit to "80"
.LimitHigh5 = 80
End With
End Sub
See also
ColorLimitHigh5 Property (Page 2193)
TypeLimitHigh5 Property (Page 2456)
LimitHigh4 Property (Page 2312)
BarGraph Object (Page 1920)
CheckLimitLow4 Property
Description
TRUE if the "Reserve 4" low limit value of the bar graph object is to be monitored. BOOLEAN
write-read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
via the properties LimitLow4, ColorLimitLow4 and TypeLimitLow4.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2181
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "5".
Sub BarGraphLimitConfiguration()
'VBA439
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeLimitLow4 = False
'Activate monitoring
.CheckLimitLow4 = True
'Set barcolor to "green"
.ColorLimitLow4 = RGB(0, 255, 0)
'set lower limit to "5"
.LimitLow4 = 5
End With
End Sub
See also
TypeLimitLow4 Property (Page 2457)
LimitLow4 Property (Page 2314)
ColorLimitLow4 Property (Page 2194)
BarGraph Object (Page 1920)
CheckLimitLow5 Property
Description
TRUE if the "Reserve 5" low limit value of the bar graph object is to be monitored. BOOLEAN
write-read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
via the properties LimitLow5, ColorLimitLow5 and TypeLimitLow5.
WinCC: Scripting (VBS, ANSI-C, VBA)
2182 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "0".
Sub BarGraphLimitConfiguration()
'VBA440
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeLimitLow5 = False
'Activate monitoring
.CheckLimitLow5 = True
'Set barcolor to "white"
.ColorLimitLow5 = RGB(255, 255, 255)
'set lower limit to "0"
.LimitLow5 = 0
End With
End Sub
See also
TypeLimitLow5 Property (Page 2458)
LimitLow5 Property (Page 2315)
ColorLimitLow5 Property (Page 2195)
BarGraph Object (Page 1920)
CheckToleranceHigh Property
Description
TRUE if the "Tolerance High" limit value is being monitored for the BarGraph object. BOOLEAN
write-read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
via the properties ToleranceHigh, ColorToleranceHigh and TypeToleranceHigh.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2183
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "45".
Sub BarGraphLimitConfiguration()
'VBA441
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeToleranceHigh = False
'Activate monitoring
.CheckToleranceHigh = True
'Set barcolor to "yellow"
.ColorToleranceHigh = RGB(255, 255, 0)
'Set upper limit to "45"
.ToleranceHigh = 45
End With
End Sub
See also
TypeToleranceHigh Property (Page 2459)
ToleranceHigh Property (Page 2444)
ColorToleranceHigh Property (Page 2196)
BarGraph Object (Page 1920)
CheckToleranceLow Property
Description
TRUE if the "Tolerance Low" limit value is being monitored for the BarGraph object. BOOLEAN
write-read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
via the properties ToleranceLow, ColorToleranceLow and TypeToleranceLow.
WinCC: Scripting (VBS, ANSI-C, VBA)
2184 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "15".
Sub BarGraphLimitConfiguration()
'VBA442
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeToleranceLow = False
'Activate monitoring
.CheckToleranceLow = True
'Set barcolor to "yellow"
.ColorToleranceLow = RGB(255, 255, 0)
'Set lower limit to "15"
.ToleranceLow = 15
End With
End Sub
See also
BarGraph Object (Page 1920)
TypeToleranceLow Property (Page 2460)
ToleranceLow Property (Page 2445)
ColorToleranceLow Property (Page 2197)
CheckWarningHigh Property
Description
TRUE if the "Warning High" limit value is being monitored for the BarGraph object. BOOLEAN
write-read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
via the properties WarningHigh, ColorWarningHigh and TypeWarningHigh.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2185
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "75".
Sub BarGraphLimitConfiguration()
'VBA443
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeWarningHigh = False
'Activate monitoring
.CheckWarningHigh = True
'Set barcolor to "red"
.ColorWarningHigh = RGB(255, 0, 0)
'Set upper limit to "75"
.WarningHigh = 75
End With
End Sub
See also
WarningHigh Property (Page 2554)
TypeWarningHigh Property (Page 2461)
ColorWarningHigh Property (Page 2199)
BarGraph Object (Page 1920)
CheckWarningLow Property
Description
TRUE if the "Warning Low" limit value is being monitored for the BarGraph object. BOOLEAN
write-read access.
The limit value, the display on reaching the limit value and the type of evaluation are defined
via the properties WarningLow, ColorWarningLow and TypeWarningLow.
WinCC: Scripting (VBS, ANSI-C, VBA)
2186 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "12".
Sub BarGraphLimitConfiguration()
'VBA444
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeWarningLow = False
'Activate monitoring
.CheckWarningLow = True
'Set barcolor to "magenta"
.ColorWarningLow = RGB(255, 0, 255)
'Set lower limit to "12"
.WarningLow = 12
End With
End Sub
See also
WarningLow Property (Page 2555)
TypeWarningLow Property (Page 2462)
ColorWarningLow Property (Page 2200)
BarGraph Object (Page 1920)
ClearOnError Property
Description
TRUE if the entry in the I/O field is automatically deleted when the input is incorrect. BOOLEAN
write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2187
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this example
the I/O field is to be cleared when the input is incorrect:
Sub IOFieldConfiguration()
'VBA445
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.ClearOnError = True
End With
End Sub
See also
IOField Object (Page 1996)
ClearOnNew Property
Description
TRUE if the entry in the I/O field is deleted as soon as the I/O field gets the focus. BOOLEAN
write-read access.
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this example
the entry in the I/O field is deleted as soon as the field gets the focus:
Sub IOFieldConfiguration()
'VBA446
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.ClearOnNew = True
End With
End Sub
See also
IOField Object (Page 1996)
WinCC: Scripting (VBS, ANSI-C, VBA)
2188 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
CloseButton Property
Description
TRUE if the ApplicationWindow and PictureWindow objects possess a "Close" button in
Runtime. BOOLEAN write-read access.
Example:
The "ApplicationWindowConfig" procedure accesses the properties of the application window.
In this example the application window will have a "Close" button in Runtime:
Sub ApplicationWindowConfig()
'VBA447
Dim objAppWindow As HMIApplicationWindow
Set objAppWindow = ActiveDocument.HMIObjects.AddHMIObject("AppWindow1",
"HMIApplicationWindow")
With objAppWindow
.CloseButton = True
End With
End Sub
See also
PictureWindow Object (Page 2033)
ApplicationWindow Object (Page 1917)
CollectValue property
Description
The CollectValue property specifies as an initial value the current status of the active message
classes in each case.
The "Relevant" property has to have the value "TRUE" so that the advanced analog display
is taken into account when forming the group display .
ColorAlarmHigh Property
Description
Defines or returns the bar color for the "Alarm High" limit value. LONG write-read access.
The "CheckAlarmHigh" property must have been set to TRUE if the bar color should change
on reaching the limit value.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2189
VBA for Automated Configuration
3.6 VBA Reference
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "50 " and the bar color will change to Red.
Sub BarGraphLimitConfiguration()
'VBA449
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeAlarmHigh = False
'Activate monitoring
.CheckAlarmHigh = True
'Set barcolor to "red"
.ColorAlarmHigh = RGB(255, 0, 0)
'Set upper limit to "50"
.AlarmHigh = 50
End With
End Sub
See also
CheckAlarmHigh Property (Page 2177)
BarGraph Object (Page 1920)
ColorAlarmLow Property
Description
Defines or returns the bar color for the "Alarm Low" limit value. LONG write-read access.
The "CheckAlarmLow" property must have been set to TRUE if the bar color should change
on reaching the limit value.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2190 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "10 " and the bar color will change to Red.
Sub BarGraphLimitConfiguration()
'VBA450
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeAlarmLow = False
'Activate monitoring
.CheckAlarmLow = True
'Set barcolor to "red"
.ColorAlarmLow = RGB(255, 0, 0)
'Set lower limit to "10"
.AlarmLow = 10
End With
End Sub
See also
CheckAlarmLow Property (Page 2178)
BarGraph Object (Page 1920)
ColorBottom Property
Description
Defines or returns the color for the bottom/right stop of the slider object. LONG write-read
access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2191
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "SliderConfiguration()" procedure accesses the properties of the slider. In this example
the color for the lower/right view will be set to "Red":
Sub SliderConfiguration()
'VBA451
Dim objSlider As HMISlider
Set objSlider = ActiveDocument.HMIObjects.AddHMIObject("SliderObject1", "HMISlider")
With objSlider
.ColorBottom = RGB(255, 0, 0)
End With
End Sub
See also
Slider object (Page 2066)
ColorChangeType Property
Description
TRUE if a color change in the BarGraph object (for instance when a limit value is reached) is
to take place segment by segment. If set to FALSE, it defines the change of color for the entire
bar. BOOLEAN write-read access.
Example:
The "BarGraphLimitConfiguration()" procedure configures In this example the color change
will apply to the whole bar:
Sub BarGraphLimitConfiguration()
'VBA452
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.ColorChangeType = False
End With
End Sub
See also
BarGraph Object (Page 1920)
WinCC: Scripting (VBS, ANSI-C, VBA)
2192 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
ColorLimitHigh4 Property
Description
Defines or returns the color for the "Reserve 4" upper limit value. LONG write-read access.
The "CheckLimitHigh4" property must have been set to TRUE if the bar color should change
on reaching the limit value.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "70 " and the bar color will change to Red.
Sub BarGraphLimitConfiguration()
'VBA453
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeLimitHigh4 = False
'Activate monitoring
.CheckLimitHigh4 = True
'Set barcolor to "red"
.ColorLimitHigh4 = RGB(255, 0, 0)
'Set upper limit to "70"
.LimitHigh4 = 70
End With
End Sub
See also
CheckLimitHigh4 Property (Page 2179)
BarGraph Object (Page 1920)
ColorLimitHigh5 Property
Description
Defines or returns the color for the "Reserve 5" upper limit value. LONG write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2193
VBA for Automated Configuration
3.6 VBA Reference
The "CheckLimitHigh5" property must have been set to TRUE if the bar color should change
on reaching the limit value.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "80" and the bar color will change to "Black".
Sub BarGraphLimitConfiguration()
'VBA454
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeLimitHigh5 = False
'Activate monitoring
.CheckLimitHigh5 = True
'Set barcolor to "black"
.ColorLimitHigh5 = RGB(0, 0, 0)
'Set upper limit to "80"
.LimitHigh5 = 80
End With
End Sub
See also
CheckLimitHigh5 Property (Page 2180)
BarGraph Object (Page 1920)
ColorLimitLow4 Property
Description
Defines or returns the color for the "Reserve 4" lower limit value. LONG write-read access.
The "CheckLimitLow4" property must have been set to TRUE if the bar color should change
on reaching the limit value.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
WinCC: Scripting (VBS, ANSI-C, VBA)
2194 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "5" and the bar color will change to "Green".
Sub BarGraphLimitConfiguration()
'VBA455
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeLimitLow4 = False
'Activate monitoring
.CheckLimitLow4 = True
'Set barcolor to "green"
.ColorLimitLow4 = RGB(0, 255, 0)
'Set lower limit to "5"
.LimitLow4 = 5
End With
End Sub
See also
CheckLimitLow4 Property (Page 2181)
BarGraph Object (Page 1920)
ColorLimitLow5 Property
Description
Defines or returns the color for the "Reserve 5" lower limit value. LONG write-read access.
The "CheckLimitLow5" property must have been set to TRUE if the bar color should change
on reaching the limit value.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2195
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "0" and the bar color will change to "White".
Sub BarGraphLimitConfiguration()
'VBA456
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeLimitLow5 = False
'Activate monitoring
.CheckLimitLow5 = True
'Set barcolor to "white"
.ColorLimitLow5 = RGB(255, 255, 255)
'Set lower limit to "0"
.LimitLow5 = 0
End With
End Sub
See also
CheckLimitLow5 Property (Page 2182)
BarGraph Object (Page 1920)
ColorToleranceHigh Property
Description
Defines or returns the color for the "Tolerance High" high limit value. LONG write-read access.
The "CheckToleranceHigh" property must have been set to TRUE if the bar color should
change on reaching the limit value.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2196 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "45" and the bar color will change to "Yellow".
Sub BarGraphLimitConfiguration()
'VBA457
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeToleranceHigh = False
'Activate monitoring
.CheckToleranceHigh = True
'Set barcolor to "yellow"
.ColorToleranceHigh = RGB(255, 255, 0)
'Set upper limit to "45"
.ToleranceHigh = 45
End With
End Sub
See also
CheckToleranceHigh Property (Page 2183)
BarGraph Object (Page 1920)
ColorToleranceLow Property
Description
Defines or returns the color for the "Tolerance Low" low limit value. LONG write-read access.
The "CheckToleranceLow" property must have been set to TRUE if the bar color should change
on reaching the limit value.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2197
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "12" and the bar color will change to "Yellow".
Sub BarGraphLimitConfiguration()
'VBA458
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeToleranceLow = False
'Activate monitoring
.CheckToleranceLow = True
'Set barcolor to "yellow"
.ColorToleranceLow = RGB(255, 255, 0)
'Set lower limit to "15"
.ToleranceLow = 15
End With
End Sub
See also
CheckToleranceLow Property (Page 2184)
BarGraph Object (Page 1920)
ColorTop Property
Description
Defines or returns the color for the top/left stop of the slider object. LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2198 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "SliderConfiguration()" procedure accesses the properties of the slider. In this example
the color for the upper/left view will be set to "Orange":
Sub SliderConfiguration()
'VBA459
Dim objSlider As HMISlider
Set objSlider = ActiveDocument.HMIObjects.AddHMIObject("SliderObject1", "HMISlider")
With objSlider
.ColorTop = RGB(255, 128, 0)
End With
End Sub
See also
Slider object (Page 2066)
ColorWarningHigh Property
Description
Defines or returns the color for the "Warning High" high limit value. LONG write-read access.
The "CheckWarningHigh" property must have been set to TRUE if the bar color should change
on reaching the limit value.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2199
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "75" and the bar color will change to "Red".
Sub BarGraphLimitConfiguration()
'VBA460
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeWarningHigh = False
'Activate monitoring
.CheckWarningHigh = True
'Set barcolor to "red"
.ColorWarningHigh = RGB(255, 0, 0)
'Set upper limit to "75"
.WarningHigh = 75
End With
End Sub
See also
CheckWarningHigh Property (Page 2185)
BarGraph Object (Page 1920)
ColorWarningLow Property
Description
Defines or returns the color for the "Warning Low" low limit value. LONG write-read access.
The "CheckWarningLow" property must have been set to TRUE if the bar color should change
on reaching the limit value.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2200 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "12" and the bar color will change to "Magenta".
Sub BarGraphLimitConfiguration()
'VBA461
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeWarningLow = False
'Activate monitoring
.CheckWarningLow = True
'Set barcolor to "magenta"
.ColorWarningLow = RGB(255, 0, 255)
'Set lower limit to "12"
.WarningLow = 12
End With
End Sub
See also
CheckWarningLow Property (Page 2186)
BarGraph Object (Page 1920)
CommonVBSCode Property
Description
Defines the higher-level common declaration section of the actions for the active picture or
returns it.
The action editor of the Graphics Designer is used to configure actions at events and
properties. In the declaration section of the actions, you can declare tags for a process image
as well as create functions and procedures. In Runtime, each VBS action can access these
tags, functions and procedures if the picture is active.
If you set "CommonVBSCode", the string is copied to the "Event" and "Property" declaration
sections in the action editor. Any code there is overwritten. Therefore, set "CommonVBSCode"
first before setting the subordinate declaration sections with "CommonVBSEventArea" or
"CommonVBSPropertyArea".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2201
VBA for Automated Configuration
3.6 VBA Reference
Example
In the following example, a tag that is common to all picture objects is declared in the active
picture. The common declaration section is then output :
Sub DefineTagInActiveDocument
ActiveDocument.CommonVBSCode = "DIM actionIsdone" & vbCrLf
MsgBox ActiveDocument.CommonVBSCode
End Sub
See also
Document Object (Page 1954)
CommonVBSEventArea property
Description
Defines the "Event" declaration section of the actions for the active picture or returns it.
The action editor of the Graphics Designer is used to configure actions, for example, at events.
To this purpose, you can declare tags for a process image as well as create functions and
procedures in the "Event" declaration section of the actions. In Runtime each VBS action that
was configured for an event can access these tags, functions and procedures if the picture is
active.
If you set "CommonVBSEventArea", the string is copied to the "Event" declaration section in
the action editor. Any code there is overwritten. Therefore, first read the code set, for example
with "CommonVBSCode" before you set the declaration section with
"CommonVBSEventArea".
Example
In the following example, two tags are declared in the active picture. The "Event" declaration
section is the output:
Sub DefineTagInActiveDocument
ActiveDocument.CommonVBSCode = "DIM actionIsdone" & vbCrLf
ActiveDocument.CommonVBSEventArea = ActiveDocument.CommonVBSEventArea & "DIM
"eventHasOccurred"
MsgBox ActiveDocument.CommonVBSEventArea
End Sub
CommonVBSPropertyArea property
Description
Defines the "Property" declaration section of the actions for the active picture or returns it.
WinCC: Scripting (VBS, ANSI-C, VBA)
2202 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
The action editor of the Graphics Designer is used to configure actions for example at
properties. To this purpose you can declare tags for a process image as well as create functions
and procedures in the "Property" declaration section of the actions. In Runtime each VBS
action that was configured for a property can access these tags, functions and procedures if
the picture is active.
If you set "CommonVBSPropertyArea", the string is copied to the "Property" declaration section
in the action editor. Any code there is overwritten. Therefore, first read the code set, for example
with "CommonVBSCode" before you set the declaration section with
"CommonVBSPropertyArea".
Example
In the following example, two tags are declared in the active picture. The "Property" declaration
section is then output:
Sub DefineTagInActiveDocument
ActiveDocument.CommonVBSCode = "DIM actionIsdone" & vbCrLf
ActiveDocument CommonVBSPropertyArea = ActiveDocument.CommonVBSPropertyArea & "DIM
propertyIsChanged"
MsgBox ActiveDocument.CommonVBSPropertyArea
End Sub
CommandLine Property
Description
Returns the start parameter as a string if the application is opened via Start>Execute
"Grafexe.exe start parameter". Read only access.
Example:
In this example a message containing the start parameter is output on opening the document.
Sub Document_Opened(CancelForwarding As Boolean)
'VBA462
MsgBox Application.Commandline
End Sub
See also
Application Object (Page 1915)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2203
VBA for Automated Configuration
3.6 VBA Reference
Compiled Property
Description
TRUE if the source code of a C script or VB script was successfully compiled. BOOLEAN read
access.
Example:
In the following example a button and a circle will be inserted in the active picture. In Runtime
the radius of the circle will enlarge every time you click the button. A VB script will be used for
this purpose:
Sub IncreaseCircleRadiusWithVBScript()
'VBA463
Dim objButton As HMIButton
Dim objCircleA As HMICircle
Dim objEvent As HMIEvent
Dim objVBScript As HMIScriptInfo
Dim strCode As String
strCode = "Dim objCircle" & vbCrLf & "Set objCircle = "
strCode = strCode & "hmiRuntime.ActiveScreen.ScreenItems(""CircleVB"")"
strCode = strCode & vbCrLf & "objCircle.Radius = objCircle.Radius + 5"
Set objCircleA = ActiveDocument.HMIObjects.AddHMIObject("CircleVB", "HMICircle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objCircleA
.Top = 100
.Left = 100
End With
With objButton
.Top = 10
.Left = 10
.Width = 200
.Text = "Increase Radius"
End With
'On every mouseclick the radius will be increased:
Set objEvent = objButton.Events(1)
Set objVBScript = objButton.Events(1).Actions.AddAction(hmiActionCreationTypeVBScript)
objVBScript.SourceCode = strCode
Select Case objVBScript.Compiled
Case True
MsgBox "Compilation OK!"
Case False
MsgBox "Errors by compilation!"
End Select
End Sub
See also
SourceCode Property (Page 2426)
ScriptInfo Object (Page 2062)
WinCC: Scripting (VBS, ANSI-C, VBA)
2204 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
ConfigurationFileName Property
Description
Returns the file name and full path of the configuration file for the open project. STRING read
access.
Example:
The "ShowConfigurationFileName() procedure outputs the configuration file path for the
current picture:
Sub ShowConfigurationFileName()
'VBA464
MsgBox ActiveDocument.Application.ConfigurationFileName
End Sub
See also
Application Property (Page 2129)
Application Object (Page 1915)
ConnectionPoints property
Description
Returns the number of connection points of an object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2205
VBA for Automated Configuration
3.6 VBA Reference
Example: Number of connection points of a rectangle
In this example, a rectangle is inserted and the number of connection points is output:
Sub CountConnectionPoints()
'VBA229
Dim objRectangle As HMIRectangle
Dim objConnPoints As HMIConnectionPoints
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
Set objConnPoints = ActiveDocument.HMIObjects("Rectangle1").ConnectionPoints
MsgBox "Rectangle1 has " & objConnPoints.Count & " connectionpoints."
End Sub
ConnectorObjects property
Description
Only used internally.
See also
3DBarGraph Object (Page 1900)
ActiveXControl Object (Page 1906)
AdvancedAnalogDisplay object (Page 1907)
AdvancedStateDisplay object (Page 1911)
ApplicationWindow Object (Page 1917)
BarGraph Object (Page 1920)
Button Object (Page 1926)
CheckBox Object (Page 1930)
Circle Object (Page 1933)
CircularArc Object (Page 1936)
ComboBox object (Page 1939)
CustomizedObject Object (Page 1943)
DataSetObj object (Page 1948)
DotNetControl object (Page 1959)
Ellipse Object (Page 1962)
EllipseArc Object (Page 1965)
EllipseSegment Object (Page 1968)
FaceplateObject object (Page 1974)
GraphicObject Object (Page 1980)
Group Object (Page 1983)
WinCC: Scripting (VBS, ANSI-C, VBA)
2206 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
GroupDisplay Object (Page 1985)
IOField Object (Page 1996)
Line Object (Page 2008)
ListBox object (Page 2010)
MultiLineEdit object (Page 2020)
ObjConnection object (Page 2023)
OLEObject Object (Page 2027)
OptionGroup Object (Page 2029)
PictureWindow Object (Page 2033)
PieSegment Object (Page 2036)
Polygon Object (Page 2039)
PolyLine Object (Page 2042)
Rectangle Object (Page 2053)
RoundButton Object (Page 2055)
RoundRectangle Object (Page 2059)
Slider object (Page 2066)
StaticText Object (Page 2071)
StatusDisplay Object (Page 2074)
TextList Object (Page 2085)
TubeArcObject object (Page 2097)
TubeDoubleTeeObject object (Page 2099)
TubePolyline object (Page 2101)
TubeTeeObject object (Page 2103)
WPFControl object (Page 2113)
ConnectorType property
Description
Defines the type of connector:
Automatic Both objects are connected by a polyline made up of horizontal and vertical parts.
Simple Both objects are connected by a straight line between the connecting points.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2207
VBA for Automated Configuration
3.6 VBA Reference
ControlType property
Description
Returns the name range of the control.
CopyPasteSettings property
Description
Only used internally.
See also
Application Object (Page 1915)
CornerRadius property
Description
Defines the rounding radius of the rectangle which enclose objects in the advanced analog
display. The values are defined in pixels.
The range of values which can be displayed for the corner radius depends on the values set
for the "height" and "width" properties. The maximum corner radius value which can be
displayed is equivalent to 50% of the lower one of the "height" or "width" values. The maximum
value is used if higher values are entered.
Count Property
Description
Returns the number of elements in the specified listing. LONG read access
WinCC: Scripting (VBS, ANSI-C, VBA)
2208 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example a new picture will be created and a pair of objects will be inserted.
The number of inserted objects will be output at the end:
Sub ObjectsInActiveDocument()
'VBA465
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objDocument As Document
Set objDocument = Application.Documents.Add(hmiOpenDocumentTypeVisible)
Dim iIndex As Integer
iIndex = 1
For iIndex = 1 To 5
Set objCircle = objDocument.HMIObjects.AddHMIObject("Circle" & iIndex, "HMICircle")
Set objRectangle = objDocument.HMIObjects.AddHMIObject("Rectangle" & iIndex,
"HMIRectangle")
With objCircle
.Top = (10 * iIndex)
.Left = (10 * iIndex)
End With
With objRectangle
.Top = ((10 * iIndex) + 50)
.Left = (10 * iIndex)
End With
Next iIndex
MsgBox "There are " & objDocument.HMIObjects.Count & " objects in the document"
End Sub
See also
VariableTriggers Object (Listing) (Page 2110)
Views Object (Listing) (Page 2112)
VariableStateValues Object (Listing) (Page 2106)
ToolbarItems Object (Listing) (Page 2094)
Toolbars Object (Listing) (Page 2090)
SymbolLibraries Object (Listing) (Page 2082)
SelectedObjects object (Listing) (Page 2063)
Properties Object (Listing) (Page 2045)
HMIObjects Object (Listing) (Page 1994)
MenuItems Object (Listing) (Page 2019)
Menus Object (Listing) (Page 2015)
Layers Object (Listing) (Page 2006)
LanguageTexts Object (Listing) (Page 2004)
LanguageFonts Object (Listing) (Page 2001)
GroupedObjects Object (Listing) (Page 1988)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2209
VBA for Automated Configuration
3.6 VBA Reference
FolderItems Object (Listing) (Page 1978)
Events Object (Listing) (Page 1972)
Documents Object (Listing) (Page 1957)
HMIDefaultObjects Object (Listing) (Page 1989)
DataLanguages Object (Listing) (Page 1947)
ConnectionPoints Object (Listing) (Page 1941)
AnalogResultInfos Object (Listing) (Page 1914)
Actions Object (Listing) (Page 1904)
CQBackColorOff..ColorOn property
Description
Specifies for the selected message type and the state "Came In Acknowledged" which color
the background of the value to be displayed assumes for flashing status "Off" (CBackColorOff)
or "On" (CBackColorOn) when the arrival of a message is acknowledged..
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0).
CQBackFlash property
Description
Specifies for the selected message type and status "Came In Acknowledged" whether the
background of the value to be displayed flashes when the arrival of a message is
acknowledged.
CQTextColorOff..ColorOn property
Description
Specifies for the selected message type and the state "Came In Acknowledged" which color
the text of the value to be displayed assumes for flashing status "Off" (CTextColorOff) or "On"
(CTextColorOn) when the arrival of a message is acknowledged..
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
WinCC: Scripting (VBS, ANSI-C, VBA)
2210 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0).
CQTextFlash property
Description
Specifies for the selected message type and status "Came In Acknowledged" whether the
background of the text to be displayed flashes when the arrival of a message is acknowledged.
CTextColorOff..ColorOn property
Description
Specifies for the selected message type and the state "Came In" which color the text of the
value to be displayed assumes for flashing status "Off" (CTextColorOff) or "On"
(CTextColorOn).
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0).
CTextFlash property
Description
Specifies for the selected message type and status "Came In" whether the text of the value to
be displayed flashes when a message is received.
CurrentDataLanguage Property
Description
Defines the project language or returns the language identifier as a decimal value. LONG read-
write access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2211
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ShowDataLanguage()" procedure outputs the currently set project language:
Sub ShowDataLanguage()
'VBA466
MsgBox Application.CurrentDataLanguage
End Sub
See also
Application Property (Page 2129)
DataLanguageChanged Event (Page 1769)
Language-Dependent Configuration with VBA (Page 1628)
CurrentDesktopLanguage Property
Description
Returns the language identifier of the currently set user interface language as a decimal value.
LONG read access.
Example:
The "ShowDesktopLanguage()" procedure outputs the currently set user interface language:
Sub ShowDesktopLanguage()
'VBA467
MsgBox Application.CurrentDesktopLanguage
End Sub
See also
Application Property (Page 2129)
Application Object (Page 1915)
DesktopLanguageChanged event (Page 1770)
Language-Dependent Configuration with VBA (Page 1628)
CursorControl Property
Description
TRUE, when Alpha Cursor mode is activated, the cursor skips to the next field in the TAB
sequence after exiting the field. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2212 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
The CursorMode property must be set to TRUE.
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this example
the cursor will skip into the next field when another field is exited. For this to work, the Cursor
mode property must first be set to TRUE.
Sub IOFieldConfiguration()
'VBA468
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
Application.ActiveDocument.CursorMode = True
With objIOField
.CursorControl = True
End With
End Sub
See also
TabOrderAlpha Property (Page 2431)
TabOrderSwitch Property (Page 2434)
CursorMode Property (Page 2213)
ActiveDocument Property (Page 2116)
TextList Object (Page 2085)
IOField Object (Page 1996)
CursorMode Property
Description
TRUE if the "Alpha Cursor" mode is to be activated. FALSE if the "Tab order" mode is to be
activated. BOOLEAN write-read access.
Example:
The "ActiveDocumentConfiguration()" procedure accesses the properties of the current picture
in the Graphics Designer. In this example the "Alpha Cursor" mode will be activated:
Sub ActiveDocumentConfiguration()
'VBA469
Application.ActiveDocument.CursorMode = True
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2213
VBA for Automated Configuration
3.6 VBA Reference
See also
CursorControl Property (Page 2212)
ActiveDocument Property (Page 2116)
Documents Object (Listing) (Page 1957)
CustomMenus Property
Description
Returns a listing of the available user-defined menus.
Example:
The "ShowCustomMenuInformation()" procedure outputs the Key and Label of all user-defined
menus in the current picture:
Sub ShowCustomMenuInformation()
'VBA470
Dim strKey As String
Dim strLabel As String
Dim strOutput As String
Dim iIndex As Integer
For iIndex = 1 To ActiveDocument.CustomMenus.Count
strKey = ActiveDocument.CustomMenus(iIndex).Key
strLabel = ActiveDocument.CustomMenus(iIndex).Label
strOutput = strOutput & vbCrLf & "Key: " & strKey & " Label: " & strLabel
Next iIndex
If 0 = ActiveDocument.CustomMenus.Count Then
strOutput = "There are no custommenus for the document created."
End If
MsgBox strOutput
End Sub
See also
Application Property (Page 2129)
ActiveDocument Property (Page 2116)
Menu Object (Page 2013)
CustomToolbars Property
Description
Returns a listing of the available user-defined toolbars.
WinCC: Scripting (VBS, ANSI-C, VBA)
2214 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ShowCustomToolbarInformation()" procedure outputs the Key values of all user-defined
toolbars in the current picture:
Sub ShowCustomToolbarInformation()
'VBA471
Dim strKey As String
Dim strOutput As String
Dim iIndex As Integer
For iIndex = 1 To ActiveDocument.CustomToolbars.Count
strKey = ActiveDocument.CustomToolbars(iIndex).Key
strOutput = strOutput & vbCrLf & "Key: " & strKey
Next iIndex
If 0 = ActiveDocument.CustomToolbars.Count Then
strOutput = "There are no toolbars created for this document."
End If
MsgBox strOutput
End Sub
See also
Application Property (Page 2129)
ActiveDocument Property (Page 2116)
Toolbar Object (Page 2089)
CycleName Property
Description
Returns the name of the specified tag trigger. Read only access.
Example:
--
See also
VariableTrigger Object (Page 2108)
CycleTime Property
Description
Returns the cycle time of the specified tag trigger. Read only access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2215
VBA for Automated Configuration
3.6 VBA Reference
Example:
--
See also
VariableTrigger Object (Page 2108)
CycleType Property
Description
Defines or returns the cycle type.
Example:
The "DynamicToRadiusOfNewCircle(hmiCircle As IHMICircle)" procedure creates a dynamic
for the radius of a circle. In this example the radius of the circle will be set every two seconds:
Sub DynamicToRadiusOfNewCircle()
'VBA474
Dim objCircle As hmiCircle
Dim VariableTrigger As HMIVariableTrigger
Set objCircle = Application.ActiveDocument.HMIObjects.AddHMIObject("Circle1", "HMICircle")
Set VariableTrigger = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeVariableDirect,
"NewDynamic1")
VariableTrigger.CycleType = hmiVariableCycleType_2s
End Sub
See also
VariableTrigger Object (Page 2108)
Configuring Dynamics in the Properties of Pictures and Objects (Page 1695)
DataFormat Property
Description
Defines or returns the data type of the IOField object.
WinCC: Scripting (VBS, ANSI-C, VBA)
2216 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Range of values from 0 to 5.
Data type Assigned Value
Binary 0
Decimal 1
String 2
Hexadecimal 3
Date/time 4
Date/Time (local) 5
Example
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this
example, data type "Decimal" will be set for the I/O field:
Sub IOFieldConfiguration()
'VBA475
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.DataFormat = 1
End With
End Sub
See also
IOField Object (Page 1996)
DefaultHMIObjects Property
Description
Returns the HMIDefaultObjects listing.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2217
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ShowDefaultObjectNames()" procedure outputs all the object names contained in the
HMIDefaultObjects listing:
Sub ShowDefaultObjectNames()
'VBA476
Dim strOutput As String
Dim iIndex As Integer
For iIndex = 1 To Application.DefaultHMIObjects.Count
strOutput = strOutput & vbCrLf & Application.DefaultHMIObjects(iIndex).ObjectName
Next iIndex
MsgBox strOutput
End Sub
See also
HMIDefaultObjects Object (Listing) (Page 1989)
DestinationLink Property
Description
Returns the Destination object. Use the DestinationLink property to configure the destination
object in the case of a direct connection.
WinCC: Scripting (VBS, ANSI-C, VBA)
2218 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
Use the DestinationLink property to return the DestLink object. In the following example the X
position of "Rectangle_A" is copied to the Y position of "Rectangle_B" in Runtime by clicking
on the button:
Sub DirectConnection()
'VBA477
Dim objButton As HMIButton
Dim objRectangleA As HMIRectangle
Dim objRectangleB As HMIRectangle
Dim objEvent As HMIEvent
Dim objDirConnection As HMIDirectConnection
Set objRectangleA = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_A", "HMIRectangle")
Set objRectangleB = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_B", "HMIRectangle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objRectangleA
.Top = 100
.Left = 100
End With
With objRectangleB
.Top = 250
.Left = 400
.BackColor = RGB(255, 0, 0)
End With
With objButton
.Top = 10
.Left = 10
.Width = 100
.Text = "SetPosition"
End With
'
'Directconnection is initiated by mouseclick:
Set objDirConnection =
objButton.Events(1).Actions.AddAction(hmiActionCreationTypeDirectConnection)
With objDirConnection
'Sourceobject: Property "Top" of Rectangle_A
.SourceLink.Type = hmiSourceTypeProperty
.SourceLink.ObjectName = "Rectangle_A"
.SourceLink.AutomationName = "Top"
'
'Targetobject: Property "Left" of Rectangle_B
.DestinationLink.Type = hmiDestTypeProperty
.DestinationLink.ObjectName = "Rectangle_B"
.DestinationLink.AutomationName = "Left"
End With
End Sub
See also
AutomationName Property (Page 2133)
ObjectName Property (Page 2353)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2219
VBA for Automated Configuration
3.6 VBA Reference
Type Property (Page 2453)
DirectConnection Object (Page 1952)
Direction Property
Description
Defines or returns the bar direction. BOOLEAN write-read access.
Slider
Defines or returns the position of the Slider object. BOOLEAN write-read access.
Position/Bar Axis Assigned Value
Vertical/Negative TRUE
Horizontal/Positive FALSE
Example:
The "SliderConfiguration()" procedure accesses the properties of the slider. In this example
the position of the Slider object will be set to "Vertical":
Sub SliderConfiguration()
'VBA478
Dim objSlider As HMISlider
Set objSlider = ActiveDocument.HMIObjects.AddHMIObject("SliderObject1", "HMISlider")
With objSlider
.Direction = True
End With
End Sub
See also
Slider object (Page 2066)
3DBarGraph Object (Page 1900)
DisablePerformanceWarnings property
Description
Only used internally.
See also
Application Object (Page 1915)
WinCC: Scripting (VBS, ANSI-C, VBA)
2220 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
DisableVBAEvents Property
Description
TRUE if Event Handling is disabled. BOOLEAN write-read access.
Example:
The "DisableVBAEvents()" procedure disables Event Handling:
Sub DisableVBAEvents()
'VBA479
Application.DisableVBAEvents = False
End Sub
See also
Application Object (Page 1915)
Event Handling (Page 1717)
Display property
Description
Only used internally.
See also
ObjConnection object (Page 2023)
DisplayName Property
Description
Returns the name of the property attribute. STRING read access.
Thus the expression "MsgBox
ActiveDocument.HMIObjects("Circle_1").Properties("Height").DisplayName" would output the
result "Height".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2221
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ShowAllObjectDisplayNames()" procedure outputs all the property attribute names of
standard objects contained in the message box:
Sub ShowAllObjectDisplayNames()
'VBA480
Dim strOutput As String
Dim iIndex1 As Integer
iIndex1 = 1
strOutput = "List of all properties-displaynames from object """ &
Application.DefaultHMIObjects(1).ObjectName & """" & vbCrLf & vbCrLf
For iIndex1 = 1 To Application.DefaultHMIObjects(1).Properties.Count
strOutput = strOutput & Application.DefaultHMIObjects(1).Properties(iIndex1).DisplayName &
" / "
Next iIndex1
MsgBox strOutput
End Sub
See also
Property Object (Page 2046)
DisplayOptions Property
Description
Defines the assignment of the "Button" or "Round button" object or returns its value. Value
range from 0 to 3.
Assignment Assigned Value
Graphic or text 0
Graphic and text 1
Text only 2
Graphic only 3
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button.
WinCC: Scripting (VBS, ANSI-C, VBA)
2222 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
In this example the button is assigned "Graphic and text":
Sub ButtonConfiguration()
'VBA814
Dim objbutton As HMIButton
Set objbutton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objbutton
.DisplayOptions = 1
End With
End Sub
See also
Button Object (Page 1926)
DisplayText Property
Description
Returns the value for the "Label" or "TooltipText" property of the following objects (STRING
read access):
● Menu Object
● MenuItem Object
● ToolbarItem Object
Example:
The "ShowLabelTexts()" procedure outputs all the labels of the first user-defined menu in the
current picture:
Sub ShowLabelTexts()
'VBA481
Dim objLangText As HMILanguageText
Dim iIndex As Integer
For iIndex = 1 To ActiveDocument.CustomMenus(1).LDLabelTexts.Count
Set objLangText = ActiveDocument.CustomMenus(1).LDLabelTexts(iIndex)
MsgBox objLangText.DisplayName
Next iIndex
End Sub
See also
ToolTipText Property (Page 2448)
Label Property (Page 2295)
ToolbarItem Object (Page 2092)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2223
VBA for Automated Configuration
3.6 VBA Reference
LanguageText Object (Page 2003)
MenuItem Object (Page 2017)
Menu Object (Page 2013)
Documents Property
Description
Returns the Documents listing containing all open pictures. The open pictures are in
chronological order.
Example:
In the following example the names of all open pictures are output:
Sub ShowDocuments()
'VBA482
Dim colDocuments As Documents
Dim objDocument As Document
Dim strOutput As String
Set colDocuments = Application.Documents
strOutput = "List of all opened documents:" & vbCrLf
For Each objDocument In colDocuments
strOutput = strOutput & vbCrLf & objDocument.Name
Next objDocument
MsgBox strOutput
End Sub
See also
Application Property (Page 2129)
Application Object (Page 1915)
DrawInsideFrame property
Description
Defines for all line thicknesses greater than "1" whether the border lines are to be drawn inside
the object frame or symmetrically on the frame.
Yes The border lines are drawn inside the object frame.
No The border lines are drawn symmetrically on the object frame.
WinCC: Scripting (VBS, ANSI-C, VBA)
2224 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
DropDownListStyle property
Description
Defines whether the entries in the "TextList" object are displayed in a drop-down list box.
Dynamic Property
Description
Returns the dynamics of a property.
Example:
Use the Dynamic property if you wish to return, say, an existing dynamic. In the following
example all possibly available object property dynamics are output in the active picture:
Sub ShowPropertiesDynamicsofAllObjects()
'VBA483
Dim objObject As HMIObject
Dim colObjects As HMIObjects
Dim colProperties As HMIProperties
Dim objProperty As HMIProperty
Dim strOutput As String
Set colObjects = Application.ActiveDocument.HMIObjects
For Each objObject In colObjects
Set colProperties = objObject.Properties
For Each objProperty In colProperties
If 0 <> objProperty.DynamicStateType Then
strOutput = strOutput & vbCrLf & objObject.ObjectName & " - " & objProperty.DisplayName
& ": Statetype " & objProperty.Dynamic.DynamicStateType
End If
Next objProperty
Next objObject
MsgBox strOutput
End Sub
See also
Property Object (Page 2046)
DynamicStateType property
Description
Only used internally.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2225
VBA for Automated Configuration
3.6 VBA Reference
See also
VBA Reference: ActionDynamic (Page 1754)
EditAtOnce Property
Description
TRUE, if accessing the field with the <TAB> key permits input immediately and without further
action. BOOLEAN write-read access.
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this example
it shall be possible to enter input on skipping into the I/O field:
Sub IOFieldConfiguration()
'VBA484
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.EditAtOnce = True
End With
End Sub
See also
TextList Object (Page 2085)
IOField Object (Page 1996)
ElseCase Property
Description
Defines or returns the value for the dynamic property outside of the configured value range.
WinCC: Scripting (VBS, ANSI-C, VBA)
2226 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog, a tag name will be assigned and three analog value ranges will be created:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA485
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.Add 50, 40
.AnalogResultInfos.Add 100, 80
.AnalogResultInfos.ElseCase = 100
End With
End Sub
See also
AnalogResultInfos Object (Listing) (Page 1914)
AnalogResultInfo Object (Page 1913)
Add Method (AnalogResultInfos Listing) (Page 1793)
Enabled Property
Description
TRUE if the menu, the menu entry or the icon is activated and can be selected. Applies only
to user-defined menus and toolbars. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2227
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "CreateMenuItem()" procedure creates the "Delete Objects" menu and adds two menu
entries ("Delete Rectangles" and "Delete Circles"): In this example the second menu point in
user-defined menu "Delete Objects" is grayed out and cannot be selected in the Graphics
Designer:
Sub DisableMenuItem()
'VBA486
Dim objMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
'
'Add a new menu "Delete objects"
Set objMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DeleteObjects", "Delete objects")
'
'Add two menuitems to the new menu
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(1, "DeleteAllRectangles", "Delete
rectangles")
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(2, "DeleteAllCircles", "Delete circles")
'
'Disable menuitem "Delete circles"
With ActiveDocument.CustomMenus("DeleteObjects").MenuItems("DeleteAllCircles")
.Enabled = False
End With
End Sub
See also
ToolbarItem Object (Page 2092)
MenuItem Object (Page 2017)
Menu Object (Page 2013)
Configuring Menus and Toolbars (Page 1630)
EnableFlashing property
Description
Specifies whether the value for status "OK" and "Simulation" appears flashing or not in the
advanced analog display in Runtime.
For the flashing to be visible in Runtime, the font flashing color must be different to the
background flashing color.
WinCC: Scripting (VBS, ANSI-C, VBA)
2228 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
EndAngle Property
Description
Defines or returns the end of the object for the CircularArc, EllipseArc, EllipseSegment and
PieSegment objects. The information is in counterclockwise direction in degrees, beginning at
the 12:00 clock position.
Example:
The "PieSegmentConfiguration()" procedure accesses the properties of the Pie Segment. In
this example the pie segment begins at 40° and ends at 180°:
Sub PieSegmentConfiguration()
'VBA487
Dim objPieSegment As HMIPieSegment
Set objPieSegment = ActiveDocument.HMIObjects.AddHMIObject("PieSegment1", "HMIPieSegment")
With objPieSegment
.StartAngle = 40
.EndAngle = 180
End With
End Sub
See also
StartAngle Property (Page 2428)
PieSegment Object (Page 2036)
EllipseSegment Object (Page 1968)
EllipseArc Object (Page 1965)
CircularArc Object (Page 1936)
EventQuitMask property
Description
The events "Operator request" and "Measuring point blocked" are not acknowledgeable events
in the PCS 7 environment. Using the "@EventQuit" tag and the "EventQuitMask" property in
Runtime, these events are automatically indicated as acknowledged to prevent flashing during
the calculation of the group displays. The start value of the attribute is then 0x00000011 (17).
The value of the "EventQuitMask" property should be identical for all group display objects,
advanced analog display and advanced status display, and for the "@EventQuit" tag.
By setting further acknowledgment bits, you can indicate other events as being acknowledged
as well with the display of the group display object and the advanced analog and status display.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2229
VBA for Automated Configuration
3.6 VBA Reference
Events Property
Description
Returns the Events listing. Use the Events property to define the event that will trigger an
action. Use the index number to define the event that is intended to be configured:
● You configure an action on a property with VBA by using the "Events(9)" property, where
the index "1" stands for the event "Upon change":
● To configure an action onto an object with the aid of VBA, use the "Events(Index)" property,
where "Index" stands for the trigger event (see table):
Index EventType (depending upon the object used)
0 hmiEventTypeNotDefined
1 hmiEventTypeMouseClick
2 hmiEventTypeMouseLButtonDown
3 hmiEventTypeMouseLButtonUp
4 hmiEventTypeMouseRButtonDown
5 hmiEventTypeMouseRButtonUp
6 hmiEventTypeKeyboardDown
7 hmiEventTypeKeyboardUp
8 hmiEventTypeFocusEnter
9 hmiEventTypeObjectChange
10 hmiEventTypeOpenPicture
11 hmiEventTypePictureOpen
12 hmiEventTypePictureClose
13 hmiEventTypeObjectDefined
14 hmiEventTypeFocusEnter
15 hmiEventTypeLastTriggerType
16 hmiEventTypeObjSpecificTriggerStart
WinCC: Scripting (VBS, ANSI-C, VBA)
2230 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the X position of "Rectangle_A" is copied to the Y position of
"Rectangle_B" in Runtime by clicking on the button:
Sub DirectConnection()
'VBA488
Dim objButton As HMIButton
Dim objRectangleA As HMIRectangle
Dim objRectangleB As HMIRectangle
Dim objEvent As HMIEvent
Dim objDirConnection As HMIDirectConnection
Set objRectangleA = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_A", "HMIRectangle")
Set objRectangleB = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_B", "HMIRectangle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objRectangleA
.Top = 100
.Left = 100
End With
With objRectangleB
.Top = 250
.Left = 400
.BackColor = RGB(255, 0, 0)
End With
With objButton
.Top = 10
.Left = 10
.Width = 100
.Text = "SetPosition"
End With
'
'Directconnection is initiated by mouseclick:
Set objDirConnection =
objButton.Events(1).Actions.AddAction(hmiActionCreationTypeDirectConnection)
With objDirConnection
'Sourceobject: Property "Top" of Rectangle_A
.SourceLink.Type = hmiSourceTypeProperty
.SourceLink.ObjectName = "Rectangle_A"
.SourceLink.AutomationName = "Top"
'
'Targetobject: Property "Left" of Rectangle_B
.DestinationLink.Type = hmiDestTypeProperty
.DestinationLink.ObjectName = "Rectangle_B"
.DestinationLink.AutomationName = "Left"
End With
End Sub
See also
Events Object (Listing) (Page 1972)
Configuring Event-Driven Actions with VBA (Page 1707)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2231
VBA for Automated Configuration
3.6 VBA Reference
EventName property
Description
Returns the name of the "Event" object.
Example
In this example the event names and event types of all objects in the active pictures are put
out. In order for this example to work, insert some objects into the active picture and configure
different events.
Sub ShowEventsOfAllObjectsInActiveDocument()
'VBA252
Dim colEvents As HMIEvents
Dim objEvent As HMIEvent
Dim iMax As Integer
Dim iIndex As Integer
Dim iAnswer As Integer
Dim strEventName As String
Dim strObjectName As String
Dim varEventType As Variant
iIndex = 1
iMax = ActiveDocument.HMIObjects.Count
For iIndex = 1 To iMax
Set colEvents = ActiveDocument.HMIObjects(iIndex).Events
strObjectName = ActiveDocument.HMIObjects(iIndex).ObjectName
For Each objEvent In colEvents
strEventName = objEvent.EventName
varEventType = objEvent.EventType
iAnswer = MsgBox("Objectname: " & strObjectName & vbCrLf & "Eventtype: " & varEventType &
vbCrLf & "Eventname: " & strEventName, vbOKCancel)
If vbCancel = iAnswer Then Exit For
Next objEvent
If vbCancel = iAnswer Then Exit For
Next iIndex
End Sub
EventType Property
Description
Returns the event type that is configured on the specified object.
Index EventType (depending upon the object used)
0 hmiEventTypeNotDefined
1 hmiEventTypeMouseClick
2 hmiEventTypeMouseLButtonDown
3 hmiEventTypeMouseLButtonUp
WinCC: Scripting (VBS, ANSI-C, VBA)
2232 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Index EventType (depending upon the object used)
4 hmiEventTypeMouseRButtonDown
5 hmiEventTypeMouseRButtonUp
6 hmiEventTypeKeyboardDown
7 hmiEventTypeKeyboardUp
8 hmiEventTypeFocusEnter
9 hmiEventTypeObjectChange
10 hmiEventTypeOpenPicture
11 hmiEventTypePictureOpen
12 hmiEventTypePictureClose
13 hmiEventTypeObjectDefined
14 hmiEventTypeFocusEnter
15 hmiEventTypeLastTriggerType
16 hmiEventTypeObjSpecificTriggerStart
Example:
Use the EventType property to edit a previously configured event. In the following example
the event "Mouse Action" will be configured, but then changed to "Pressed":
Sub AddActionToObjectTypeCScript()
'VBA489
Dim objEvent As HMIEvent
Dim objCScript As HMIScriptInfo
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_AB", "HMICircle")
'
'C-action is initiated by click on object circle
Set objEvent = objCircle.Events(1)
Set objCScript = objEvent.Actions.AddAction(hmiActionCreationTypeCScript)
MsgBox "the type of the projected event is " & objEvent.EventType
End Sub
See also
Events Object (Listing) (Page 1972)
Configuring Event-Driven Actions with VBA (Page 1707)
Exponent Property
Description
TRUE if numbers are to be displayed on the BarGraph object using exponents (e.g. "1.00e
+000"). BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2233
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphConfiguration()" procedure configures In this example numbers are to be
displayed on the bar using exponents:
Sub BarGraphConfiguration()
'VBA490
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.Exponent = True
End With
End Sub
See also
BarGraph Object (Page 1920)
ExtendedOperation Property
Description
TRUE if the slider on the Slider object is set to the associated end value (minimum value/
maximum value). This is done by clicking the mouse in an area outside the current regulator
setting. BOOLEAN write-read access.
Example:
The "SliderConfiguration()" procedure accesses the properties of the slider. In this example
the ExtendedOperation property will be set to TRUE:
Sub SliderConfiguration()
'VBA491
Dim objSlider As HMISlider
Set objSlider = ActiveDocument.HMIObjects.AddHMIObject("SliderObject1", "HMISlider")
With objSlider
.ExtendedOperation = True
End With
End Sub
See also
Slider object (Page 2066)
WinCC: Scripting (VBS, ANSI-C, VBA)
2234 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
ExtendedZoomingEnable Property
Description
TRUE, if the selected process picture in Runtime may be zoomed in or out using the mouse
wheel. This happens by pushing the <CTRL> key while the mouse wheel is turned. If the mouse
wheel is turned away from the palm of the hand, the zoom factor increases.
BOOLEAN write-read access.
Requirements for using the zoom function:
● Mouse driver by Logitech or Microsoft Intellimouse
● Mouse wheel must be set to "Autoscroll".
● In the computer properties, the "Graphics Runtime" tab control must have the "Extended
zooming" function enabled for all process pictures.
Example:
The procedure "DocConfiguration()" accesses picture properties.
In this example, the property ExtendedZoomingEnable is set to TRUE:
Sub DocConfiguration()
'VBA815
Dim objDoc As Document
Set objDoc = ActiveDocument
With objDoc
.ExtendedZoomingEnable = True
End With
End Sub
FaceplateType property
Description
Sets the faceplate type of the faceplate instance and returns its name. The faceplate type is
"Const" and can therefore only be set once.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2235
VBA for Automated Configuration
3.6 VBA Reference
Usage
Use the Add method to create a new "faceplate instance" object in a picture.
"Properties.Item(3)" is used to access the FaceplateType property:
Sub FaceplateInstance_and_Properties()
'VBA847
Dim objFaceplateInstance As HMIFaceplateObject
Set objFaceplateInstance = ActiveDocument.HMIObjects.AddHMIObject("faceplate instance",
"HMIFaceplateObject")
objFaceplateInstance.Properties.Item(3).value = "Faceplate1.fpt"
MsgBox "Faceplate """ & objFaceplateInstance.Properties.Item(3).value & """ is used."
End Sub
Family Property
Description
Defines or returns the language-dependent font.
WinCC: Scripting (VBS, ANSI-C, VBA)
2236 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The following example sets the font attributes of a button for French and English:
Sub ExampleForLanguageFonts()
'VBA492
Dim colLangFonts As HMILanguageFonts
Dim objButton As HMIButton
Dim iStartLangID As Integer
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
iStartLangID = Application.CurrentDataLanguage
With objButton
.Text = "Command"
.Width = 100
End With
Set colLangFonts = objButton.LDFonts
'
'To do typesettings for french:
With colLangFonts.ItemByLCID(1036)
.Family = "Courier New"
.Bold = True
.Italic = False
.Underlined = True
.Size = 12
End With
'
'To do typesettings for english:
With colLangFonts.ItemByLCID(1033)
.Family = "Times New Roman"
.Bold = False
.Italic = True
.Underlined = False
.Size = 14
End With
With objButton
Application.CurrentDataLanguage = 1036
.Text = "Command"
MsgBox "Datalanguage is changed in french"
Application.CurrentDataLanguage = 1033
.Text = "Command"
MsgBox "Datalanguage is changed in english"
Application.CurrentDataLanguage = iStartLangID
MsgBox "Datalanguage is changed back to startlanguage."
End With
End Sub
See also
Underlined Property (Page 2463)
Size Property (Page 2422)
Parent Property (Page 2364)
Italic Property (Page 2288)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2237
VBA for Automated Configuration
3.6 VBA Reference
LanguageID Property (Page 2296)
Bold Property (Page 2158)
Application Property (Page 2129)
LanguageFont Object (Page 2000)
FillBackColor property
Description
Only used internally.
See also
Document Object (Page 1954)
FillColor Property
Description
Defines or returns the fill pattern color for the object. LONG read-write access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example the background color will be set to "Yellow".
Sub RectangleConfiguration()
'VBA493
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.FillColor = RGB(255, 255, 0)
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2238 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
Button Object (Page 1926)
StaticText Object (Page 2071)
Slider object (Page 2066)
TextList Object (Page 2085)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
GroupDisplay Object (Page 1985)
GraphicObject Object (Page 1980)
IOField Object (Page 1996)
EllipseSegment Object (Page 1968)
Ellipse Object (Page 1962)
Document Object (Page 1954)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
BarGraph Object (Page 1920)
3DBarGraph Object (Page 1900)
Filling Property
Description
TRUE if an object with closed frame lines (such as a Circle or Rectangle) can be filled (as in
the fill level of a tank, for example). BOOLEAN write-read access.
To set the fill level of the object, use the FillingIndex property.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2239
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example a rectangle can be used to display the fill level:
Sub RectangleConfiguration()
'VBA494
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.Filling = True
End With
End Sub
See also
FillingIndex Property (Page 2240)
StaticText Object (Page 2071)
Slider object (Page 2066)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
GraphicObject Object (Page 1980)
EllipseSegment Object (Page 1968)
Ellipse Object (Page 1962)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
FillingIndex Property
Description
Defines the percentage value (relative to the height of the object) to which to fill an object with
closed frame lines (such as a Circle or Rectangle).
The fill level is represented by the current background color. The unfilled background is
transparent.
WinCC: Scripting (VBS, ANSI-C, VBA)
2240 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example the rectangle will be filled to 50%:
Sub RectangleConfiguration()
'VBA495
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.Filling = True
.FillingIndex = 50
End With
End Sub
See also
PieSegment Object (Page 2036)
FillColor Property (Page 2238)
BackColor Property (Page 2139)
StaticText Object (Page 2071)
Slider object (Page 2066)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
Polygon Object (Page 2039)
OptionGroup Object (Page 2029)
GraphicObject Object (Page 1980)
EllipseSegment Object (Page 1968)
Ellipse Object (Page 1962)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
FillingDirection property
Description
0 = the object enclosed in a frame line is filled from bottom to top.
1 = the object enclosed in a frame line is filled from top to bottom.
2 = the object enclosed in a frame line is filled from left to right.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2241
VBA for Automated Configuration
3.6 VBA Reference
3 = the object enclosed in a frame line is filled from right to left.
Write/Read access.
Use the "FillingDirection" property to set the object fill direction.
Example
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example, the object is filled from left to right.
Sub RectangleConfiguration()
'VBA906
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.FillingDirection = 2
End With
End Sub
FillStyle Property
Description
Defines or returns the fill style for the object.
Fill pattern Value Fill pattern Value Fill pattern Value
65536
1048576 196611 196627
1048577 196612 196628
1048578 196613 196629
1048579 196614 196630
1048832 196615 196631
1048833 196616 196632
1048834 196617 196633
1048835 196618 196634
WinCC: Scripting (VBS, ANSI-C, VBA)
2242 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Fill pattern Value Fill pattern Value Fill pattern Value
131072 196619 196635
131073 196620 196636
131074 196621 196637
131075 196622 196638
131076 196623 196639
196608 196624 196640
196609 196625 196641
196610 196626 196642
Example
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example the fill pattern will be set to the value "196642":
Sub RectangleConfiguration()
'VBA496
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.FillStyle = 196642
End With
End Sub
See also
TextList Object (Page 2085)
StaticText Object (Page 2071)
Slider object (Page 2066)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2243
VBA for Automated Configuration
3.6 VBA Reference
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
GraphicObject Object (Page 1980)
EllipseSegment Object (Page 1968)
Ellipse Object (Page 1962)
Document Object (Page 1954)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BarGraph Object (Page 1920)
FillStyle2 Property
Description
Defines or returns the fill pattern of the bar for the BarGraph object.
Fill pattern Value Fill pattern Value Fill pattern Value
65536
1048576 196611 196627
1048577 196612 196628
1048578 196613 196629
1048579 196614 196630
1048832 196615 196631
1048833 196616 196632
1048834 196617 196633
1048835 196618 196634
131072 196619 196635
WinCC: Scripting (VBS, ANSI-C, VBA)
2244 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Fill pattern Value Fill pattern Value Fill pattern Value
131073 196620 196636
131074 196621 196637
131075 196622 196638
131076 196623 196639
196608 196624 196640
196609 196625 196641
196610 196626 196642
Example
The "BarGraphConfiguration()" procedure configures In this example the bar pattern will be
set to "196642":
Sub BarGraphConfiguration()
'VBA497
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.FillStyle2 = 196642
End With
End Sub
See also
BarGraph Object (Page 1920)
FillStyleAlignment property
Description
Defines the alignment of the fill pattern for the process picture.
Normal The fill pattern refers to the process picture. In runtime, no scaling is
performed when opening the picture.
Stretched (window) The fill pattern refers to the window in the Graphics Designer. In run‐
time, scaling is performed when opening the picture.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2245
VBA for Automated Configuration
3.6 VBA Reference
FlashBackColor Property
Description
TRUE, when flashing of the background is activated. BOOLEAN write-read access
Note
A change to the attribute does not automatically deactivate the "Windows Style" attribute.
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example, background flashing is activated:
Sub RectangleConfiguration()
'VBA498
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.FlashBackColor = True
End With
End Sub
See also
RoundButton Object (Page 2055)
StaticText Object (Page 2071)
Slider object (Page 2066)
TextList Object (Page 2085)
RoundRectangle Object (Page 2059)
Rectangle Object (Page 2053)
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
GraphicObject Object (Page 1980)
IOField Object (Page 1996)
EllipseSegment Object (Page 1968)
Ellipse Object (Page 1962)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
WinCC: Scripting (VBS, ANSI-C, VBA)
2246 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Button Object (Page 1926)
BarGraph Object (Page 1920)
FlashBorderColor Property
Description
TRUE, when flashing of the object lines is activated. BOOLEAN write-read access.
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example, flashing of the border is activated:
Sub RectangleConfiguration()
'VBA499
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.FlashBorderColor = True
End With
End Sub
See also
StaticText Object (Page 2071)
StatusDisplay Object (Page 2074)
Slider object (Page 2066)
TextList Object (Page 2085)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
Line Object (Page 2008)
GraphicObject Object (Page 1980)
IOField Object (Page 1996)
EllipseSegment Object (Page 1968)
EllipseArc Object (Page 1965)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2247
VBA for Automated Configuration
3.6 VBA Reference
Ellipse Object (Page 1962)
CircularArc Object (Page 1936)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
FlashFlashPicture Property
Description
TRUE, when flashing of the flash picture is activated. BOOLEAN write-read access
Example:
The "StatusDisplayConfiguration()" procedure accesses the properties of the Status Display.
In this example, flashing of the Flash Picture is activated:
Sub StatusDisplayConfiguration()
'VBA500
Dim objsDisplay As HMIStatusDisplay
Set objsDisplay = ActiveDocument.HMIObjects.AddHMIObject("StatusDisplay1",
"HMIStatusDisplay")
With objsDisplay
.FlashFlashPicture = True
End With
End Sub
See also
StatusDisplay Object (Page 2074)
FlashForeColor Property
Description
TRUE, when flashing of the text is activated. BOOLEAN write-read access.
Note
A change to the attribute does not automatically deactivate the "Windows Style" attribute.
WinCC: Scripting (VBS, ANSI-C, VBA)
2248 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example,
text flashing is activated:
Sub ButtonConfiguration()
'VBA501
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.FlashForeColor = True
End With
End Sub
See also
TextList Object (Page 2085)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
CheckBox Object (Page 1930)
Button Object (Page 1926)
FlashPicReferenced Property
Description
TRUE if the Flash Picture assigned in the Status Display object is to be saved. Otherwise, only
the associated object reference is saved. BOOLEAN write-read access.
Example:
The "StatusDisplayConfiguration()" procedure accesses the properties of the Status Display.
In this example the picture assigned in the Status Display object is to be saved.
Sub StatusDisplayConfiguration()
'VBA502
Dim objStatusDisplay As HMIStatusDisplay
Set objStatusDisplay = ActiveDocument.HMIObjects.AddHMIObject("StatusDisplay1",
"HMIStatusDisplay")
With objStatusDisplay
.FlashPicReferenced = True
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2249
VBA for Automated Configuration
3.6 VBA Reference
See also
StatusDisplay Object (Page 2074)
FlashPicTransColor Property
Description
Defines which color of the bitmap object (.bmp, .dib) assigned to the flash picture should be
set to "transparent". LONG write-read access.
The color is only set to "Transparent" if the value of the "FlashPicUseTransColor" property is
"True".
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "StatusDisplayConfiguration()" procedure accesses the properties of the Status Display.
In this example the color "Yellow" will be set to "Transparent".
Sub StatusDisplayConfiguration()
'VBA503
Dim objStatusDisplay As HMIStatusDisplay
Set objStatusDisplay = ActiveDocument.HMIObjects.AddHMIObject("StatusDisplay1",
"HMIStatusDisplay")
With objStatusDisplay
.FlashPicTransColor = RGB(255, 255, 0)
.FlashPicUseTransColor = True
End With
End Sub
See also
FlashPicUseTransColor Property (Page 2252)
StatusDisplay Object (Page 2074)
FlashPicture Property
Description
Defines or returns the Flash Picture for the Status Display object.
WinCC: Scripting (VBS, ANSI-C, VBA)
2250 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
The picture (*.BMP or *.DIB) must be located in the "GraCS" directory of the current project
so that it can be integrated.
The "FlashPicReferenced" property defines in this case whether the flash picture will be saved
with the Status Display object or referenced.
Example:
The "StatusDisplayConfiguration()" procedure accesses the properties of the Status Display.
In this example the picture "Testpicture.BMP" will be used as the flash picture:
Sub StatusDisplayConfiguration()
'VBA504
Dim objStatusDisplay As HMIStatusDisplay
Set objStatusDisplay = ActiveDocument.HMIObjects.AddHMIObject("StatusDisplay1",
"HMIStatusDisplay")
With objStatusDisplay
'
'To use this example copy a Bitmap-Graphic
'to the "GraCS"-Folder of the actual project.
'Replace the picturename "Testpicture.BMP" with the name of
'the picture you copied
.FlashPicture = "Testpicture.BMP"
End With
End Sub
See also
FlashPicReferenced Property (Page 2249)
StatusDisplay Object (Page 2074)
FlashPicture property
Description
Specifies which flashing picture is to be displayed for the currently selected status. Pictures
with the following formats can be inserted: EMF, WMF, BMP, GIF, JPG.
The flash picture should have the same picture size as the basic picture, otherwise its display
is distorted.
FlashPictureState property
Description
Only used internally.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2251
VBA for Automated Configuration
3.6 VBA Reference
See also
AdvancedStateDisplay object (Page 1911)
FlashPicUseTransColor Property
Description
TRUE, when the configured color ("FlashPicTransColor" property) of the bitmap objects
assigned to the flash picture should be set to "transparent". BOOLEAN write-read access.
Example:
The "StatusDisplayConfiguration()" procedure accesses the properties of the Status Display.
In this example the color "Yellow" will be set to "Transparent":
Sub StatusDisplayConfiguration()
'VBA505
Dim objStatusDisplay As HMIStatusDisplay
Set objStatusDisplay = ActiveDocument.HMIObjects.AddHMIObject("StatusDisplay1",
"HMIStatusDisplay")
With objStatusDisplay
.FlashPicTransColor = RGB(255, 255, 0)
.FlashPicUseTransColor = True
End With
End Sub
See also
FlashPicTransColor Property (Page 2250)
StatusDisplay Object (Page 2074)
FlashRate Property
Description
Defines or returns the flash frequency of the "GroupDisplay", "AdvancedAnalogDisplay" and
"AdvancedStateDisplay" objects. Value range from 0 to 2.
Flash frequency Assigned Value
Slow (approx. 0.25 Hz) 0
Medium (approx. 0.5 Hz) 1
Fast (approx. 1 Hz) 2
WinCC: Scripting (VBS, ANSI-C, VBA)
2252 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Note
Because the flashing is performed by means of software engineering, the flash frequency is
both system-dependent and hardware-bound (number of objects, processor speed, RAM size,
update time, etc.).
The information in the table is therefore only for orientation purposes.
Example
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the flash frequency will be set to "Medium":
Sub GroupDisplayConfiguration()
'VBA506
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.FlashRate = 1
End With
End Sub
See also
GroupDisplay Object (Page 1985)
FlashRateBackColor Property
Description
Defines or returns the flash frequency for the object background. Value range from 0 to 2.
Flash frequency Assigned Value
Slow (approx. 0.25 Hz) 0
Medium (approx. 0.5 Hz) 1
Fast (approx. 1 Hz) 2
Note
Because the flashing is performed by means of software engineering, the flash frequency is
both system-dependent and hardware-bound (number of objects, processor speed, RAM size,
update time, etc.).
The information in the table is therefore only for orientation purposes.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2253
VBA for Automated Configuration
3.6 VBA Reference
Example
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the flash frequency for the background will be set to "Medium":
Sub ButtonConfiguration()
'VBA507
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.FlashRateBackColor = 1
End With
End Sub
See also
StaticText Object (Page 2071)
Slider object (Page 2066)
TextList Object (Page 2085)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
GraphicObject Object (Page 1980)
IOField Object (Page 1996)
EllipseSegment Object (Page 1968)
Ellipse Object (Page 1962)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BarGraph Object (Page 1920)
WinCC: Scripting (VBS, ANSI-C, VBA)
2254 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
FlashRateBorderColor Property
Description
Defines or returns the flash frequency for the lines of the object. Value range from 0 to 2.
Flash frequency Assigned Value
Slow (approx. 0.25 Hz) 0
Medium (approx. 0.5 Hz) 1
Fast (approx. 1 Hz) 2
Note
Because the flashing is performed by means of software engineering, the flash frequency is
both system-dependent and hardware-bound (number of objects, processor speed, RAM size,
update time, etc.).
The information in the table is therefore only for orientation purposes.
Example
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the flash frequency for the border will be set to "Medium":
Sub ButtonConfiguration()
'VBA508
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.FlashRateBorderColor = 1
End With
End Sub
See also
Slider object (Page 2066)
StatusDisplay Object (Page 2074)
StaticText Object (Page 2071)
TextList Object (Page 2085)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
PieSegment Object (Page 2036)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2255
VBA for Automated Configuration
3.6 VBA Reference
OptionGroup Object (Page 2029)
Line Object (Page 2008)
GraphicObject Object (Page 1980)
IOField Object (Page 1996)
EllipseSegment Object (Page 1968)
EllipseArc Object (Page 1965)
Ellipse Object (Page 1962)
CircularArc Object (Page 1936)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
FlashRateFlashPic Property
Description
Defines or returns the flash frequency for the status display. Value range from 0 to 2.
Flash frequency Assigned Value
Slow (approx. 0.25 Hz) 0
Medium (approx. 0.5 Hz) 1
Fast (approx. 1 Hz) 2
Note
Because the flashing is performed by means of software engineering, the flash frequency is
both system-dependent and hardware-bound (number of objects, processor speed, RAM size,
update time, etc.).
The information in the table is therefore only for orientation purposes.
WinCC: Scripting (VBS, ANSI-C, VBA)
2256 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example
The "GroupDisplayConfiguration()" procedure accesses the properties of the status display.
In this example the flash frequency for the flash picture will be set to "Medium":
Sub StatusDisplayConfiguration()
'VBA509
Dim objStatusDisplay As HMIStatusDisplay
Set objStatusDisplay = ActiveDocument.HMIObjects.AddHMIObject("StatusDisplay1",
"HMIStatusDisplay")
With objStatusDisplay
.FlashRateFlashPic = 1
End With
End Sub
See also
StatusDisplay Object (Page 2074)
FlashRateForeColor Property
Description
Defines or returns the flash frequency for the object label. Value range from 0 to 2.
Flash frequency Assigned Value
Slow (approx. 0.5 Hz) 0
Medium (approx. 2 Hz) 1
Fast (approx. 8 Hz) 2
Note
Because the flashing is performed by means of software engineering, the flash frequency is
both system-dependent and hardware-bound (number of objects, processor speed, RAM size,
update time, etc.).
The information in the table is therefore only for orientation purposes.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2257
VBA for Automated Configuration
3.6 VBA Reference
Example
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the flash frequency for the label will be set to "Medium":
Sub ButtonConfiguration()
'VBA510
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.FlashRateForeColor = 1
End With
End Sub
See also
TextList Object (Page 2085)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
CheckBox Object (Page 1930)
Button Object (Page 1926)
FlashState property
Description
Only used internally.
See also
AdvancedAnalogDisplay object (Page 1907)
Folder Property
Description
Returns a folder from the components library.
WinCC: Scripting (VBS, ANSI-C, VBA)
2258 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ShowFolderItems()" procedure accesses the symbol libraries. In this example all the
folder names in the global symbol library and project symbol library will be output:
Sub ShowFolderItems()
'VBA511
Dim colFolderItems As HMIFolderItems
Dim objFolderItem As HMIFolderItem
Dim iAnswer As Integer
Dim iMaxFolder As Integer
Dim iMaxSymbolLib As Integer
Dim iSymbolLibIndex As Integer
Dim iSubFolderIndex As Integer
Dim strSubFolderName As String
Dim strFolderItemName As String
'To determine the number of symbollibraries:
iMaxSymbolLib = Application.SymbolLibraries.Count
iSymbolLibIndex = 1
For iSymbolLibIndex = 1 To iMaxSymbolLib
With Application.SymbolLibraries(iSymbolLibIndex)
Set colFolderItems = .FolderItems
'
'To determine the number of folders in actual symbollibrary:
iMaxFolder = .FolderItems.Count
MsgBox "Number of FolderItems in " & .Name & " : " & iMaxFolder
'
'Output of all subfoldernames from actual folder:
For Each objFolderItem In colFolderItems
iSubFolderIndex = 1
For iSubFolderIndex = 1 To iMaxFolder
strFolderItemName = objFolderItem.DisplayName
If 0 <> objFolderItem.Folder.Count Then
strSubFolderName = objFolderItem.Folder(iSubFolderIndex).DisplayName
iAnswer = MsgBox("SymbolLibrary: " & .Name & vbCrLf & "act. Folder: " &
strFolderItemName & vbCrLf & "act. Subfolder: " & strSubFolderName, vbOKCancel)
'
'If "Cancel" is clicked, continued with next FolderItem
If vbCancel = iAnswer Then
Exit For
End If
Else
MsgBox "There are no subfolders in " & objFolderItem.DisplayName
Exit For
End If
Next iSubFolderIndex
Next objFolderItem
End With
Next iSymbolLibIndex
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2259
VBA for Automated Configuration
3.6 VBA Reference
See also
SymbolLibraries Object (Listing) (Page 2082)
SymbolLibrary Object (Page 2084)
FolderItems Object (Listing) (Page 1978)
FolderItem Object (Page 1977)
Accessing the component library with VBA (Page 1650)
SVGLibraries object (list) (Page 2077)
SVGLibrary object (Page 2078)
FolderItems Property
Description
Returns a listing containing all the folders in the symbol library.
WinCC: Scripting (VBS, ANSI-C, VBA)
2260 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ShowFolderItems()" procedure accesses the symbol libraries. In this example all the
folder names in the global symbol library and project symbol library will be output:
Sub ShowFolderItems()
'VBA512
Dim colFolderItems As HMIFolderItems
Dim objFolderItem As HMIFolderItem
Dim iAnswer As Integer
Dim iMaxFolder As Integer
Dim iMaxSymbolLib As Integer
Dim iSymbolLibIndex As Integer
Dim iSubFolderIndex As Integer
Dim strSubFolderName As String
Dim strFolderItemName As String
'To determine the number of symbollibraries:
iMaxSymbolLib = Application.SymbolLibraries.Count
iSymbolLibIndex = 1
For iSymbolLibIndex = 1 To iMaxSymbolLib
With Application.SymbolLibraries(iSymbolLibIndex)
Set colFolderItems = .FolderItems
'
'To determine the number of folders in actual symbollibrary:
iMaxFolder = .FolderItems.Count
MsgBox "Number of FolderItems in " & .Name & " : " & iMaxFolder
'
'Output of all subfoldernames from actual folder:
For Each objFolderItem In colFolderItems
iSubFolderIndex = 1
For iSubFolderIndex = 1 To iMaxFolder
strFolderItemName = objFolderItem.DisplayName
If 0 <> objFolderItem.Folder.Count Then
strSubFolderName = objFolderItem.Folder(iSubFolderIndex).DisplayName
iAnswer = MsgBox("SymbolLibrary: " & .Name & vbCrLf & "act. Folder: " &
strFolderItemName & vbCrLf & "act. Subfolder: " & strSubFolderName, vbOKCancel)
'
'If "Cancel" is clicked, continued with next FolderItem
If vbCancel = iAnswer Then
Exit For
End If
Else
MsgBox "There are no subfolders in " & objFolderItem.DisplayName
Exit For
End If
Next iSubFolderIndex
Next objFolderItem
End With
Next iSymbolLibIndex
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2261
VBA for Automated Configuration
3.6 VBA Reference
See also
FolderItem Object (Page 1977)
SymbolLibraries Object (Listing) (Page 2082)
SymbolLibrary Object (Page 2084)
FolderItems Object (Listing) (Page 1978)
Accessing the component library with VBA (Page 1650)
SVGLibraries object (list) (Page 2077)
SVGLibrary object (Page 2078)
FontBold Property
Description
TRUE, when the text in the object should be assigned the "bold" attribute. BOOLEAN write-
read access.
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the font attribute will be set to "Bold":
Sub ButtonConfiguration()
'VBA513
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.FontBold = True
End With
End Sub
See also
TextList Object (Page 2085)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
GroupDisplay Object (Page 1985)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BarGraph Object (Page 1920)
WinCC: Scripting (VBS, ANSI-C, VBA)
2262 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
FontItalic Property
Description
TRUE, when the text in the object should be assigned the "italic" attribute. BOOLEAN write-
read access.
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the font attribute will be set to "Italic":
Sub ButtonConfiguration()
'VBA514
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.FontItalic = True
End With
End Sub
See also
StaticText Object (Page 2071)
TextList Object (Page 2085)
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
GroupDisplay Object (Page 1985)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BarGraph Object (Page 1920)
FontName Property
Description
Defines or returns the font name of the text in the object.
All the fonts installed in Windows are available for selection.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2263
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the font is set to Arial:
Sub ButtonConfiguration()
'VBA515
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.FontName = "Arial"
End With
End Sub
See also
CheckBox Object (Page 1930)
TextList Object (Page 2085)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
GroupDisplay Object (Page 1985)
Button Object (Page 1926)
BarGraph Object (Page 1920)
FontSize Property
Description
Defines or returns the font size of the text in the object in points.
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the font size will be set to 10 points:
Sub ButtonConfiguration()
'VBA516
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.FONTSIZE = 10
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2264 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
TextList Object (Page 2085)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
GroupDisplay Object (Page 1985)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BarGraph Object (Page 1920)
FontUnderline Property
Description
TRUE, when the text in the object should be assigned the "underline" attribute. BOOLEAN
write-read access.
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the font attribute will be set to "Underline":
Sub ButtonConfiguration()
'VBA517
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.FontUnderline = True
End With
End Sub
See also
TextList Object (Page 2085)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
GroupDisplay Object (Page 1985)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BarGraph Object (Page 1920)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2265
VBA for Automated Configuration
3.6 VBA Reference
ForeColor Property
Description
Defines or returns the color of the font for the text in the object. LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the font color will be set to "Red":
Sub ButtonConfiguration()
'VBA518
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.ForeColor = RGB(255, 0, 0)
End With
End Sub
See also
Button Object (Page 1926)
TextList Object (Page 2085)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
GroupDisplay Object (Page 1985)
CheckBox Object (Page 1930)
BarGraph Object (Page 1920)
WinCC: Scripting (VBS, ANSI-C, VBA)
2266 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
ForeColor_Alarm.._Warning property
Description
Defines the color used for the foreground of one of the following states or message types:
● Alarm
● Warning
● Tolerance
● AS Process Control Error
● AS Control System Fault
● Operator request
● OK
● Simulation
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
ForeFlashColorOff Property
Description
Defines or returns the color of the text for flash status "Off". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2267
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the font color when the flash status is "Off" will be set to "Red":
Sub ButtonConfiguration()
'VBA519
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.ForeFlashColorOff = RGB(255, 0, 0)
End With
End Sub
See also
CheckBox Object (Page 1930)
TextList Object (Page 2085)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
GroupDisplay Object (Page 1985)
Button Object (Page 1926)
BarGraph Object (Page 1920)
ForeFlashColorOn Property
Description
Defines or returns the color of the text for flash status "On". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2268 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the font color when the flash status is "On" will be set to "White":
Sub ButtonConfiguration()
'VBA520
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.ForeFlashColorOn = RGB(255, 255, 255)
End With
End Sub
See also
TextList Object (Page 2085)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
GroupDisplay Object (Page 1985)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BarGraph Object (Page 1920)
Format property
Description
Specifies the format in which the value is displayed in the advanced analog display.
No Character Displays the number without formatting.
(0) Displays a digit or a zero.
(#) Displays a digit or no output.
(.) Placeholder for decimal character.
(%) Placeholder for percentage.
(,) Thousand separator.
( ( E- E+ e- e+ ) Scientific format.
-+$() Display of a literal character.
Display the next character in the format character sequence.
( "ABC" ) Displays the string in inverted commas (" ").
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2269
VBA for Automated Configuration
3.6 VBA Reference
G-H
GlobalColorScheme property
Description
Defines whether the colors defined for the current design in the global color scheme will be
used for this object.
yes Uses the colors from the global color scheme defined for this type of object.
No Uses the colors from the color scheme defined for this type of object under
"Colors".
Example
--
GlobalShadow property
Description
Defines whether the object will be displayed with the shadowing defined in the active design.
yes Uses the global shadowing defined for this object type.
No No shadowing.
Example
--
GNQBackColorOff..ColorOn property
Description
Specifies for the selected message type and the state "Went Out Unacknowledged" which
color the background of the value to be displayed assumes for flashing status "Off"
(GNQBackColorOff) or "On" (GNQBackColorOn).
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0).
WinCC: Scripting (VBS, ANSI-C, VBA)
2270 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
GNQBackFlash property
Description
Specifies for the selected message type and status "Went Out Unacknowledged" whether the
background of the value to be displayed flashes when a message goes out unacknowledged.
GNQTextColorOff..ColorOn property
Description
Specifies for the selected message type and the state "Went Out Unacknowledged" which
color the text of the value to be displayed assumes for flashing status "Off" (GNQTextColorOff)
or "On" (GNQTextColorOn).
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0).
GNQTextFlash property
Description
Specifies for the selected message type and status "Went Out Unacknowledged" whether the
text of the value to be displayed flashes when a message goes out unacknowledged.
Graphiclist property
Graphic list (Graphiclist)
The graphics list is used for the picture selection when configuring the "status display" smart
object. A graphic lists facilitates the configuration of graphics and its flashing characteristics
for the various states.
Enter the name of a graphic list that you created in the WinCC Configuration Studio in the "Text
and Graphics Lists" editor.
The "Graphics list" attribute can be made dynamic with the name "Graphiclist".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2271
VBA for Automated Configuration
3.6 VBA Reference
Example
In the example the graphics list "ListGraphics1" is assigned to the status display "StateObj1":
Sub GraphicList_Example()
'VBA910
Dim objStatusDisplay As HMIStatusDisplay
Set objStatusDisplay = ActiveDocument.HMIObjects.AddHMIObject("StateObj1",
"HMIStatusDisplay")
objStatusDisplay.GraphicList = "ListGraphics1"
End Sub
See also
StatusDisplay Object (Page 2074)
Grid Property
Description
TRUE if the grid is enabled for the active picture. BOOLEAN write-read access.
The grid is only visible during the configuration phase.
Example:
The "ActiveDocumentConfiguration()" procedure accesses the properties of the current picture
in the Graphics Designer. In this example the grid for the active picture will be enabled:
Sub ActiveDocumentConfiguration()
'VBA521
Application.ActiveDocument.Grid = True
End Sub
See also
GridWidth Property (Page 2274)
GridHeight Property (Page 2273)
GridColor Property (Page 2273)
ActiveDocument Property (Page 2116)
Application Property (Page 2129)
Document Object (Page 1954)
Application Object (Page 1915)
WinCC: Scripting (VBS, ANSI-C, VBA)
2272 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
GridColor Property
Description
Defines or returns the color of the grid during the configuration phase. The Grid property must
be set to TRUE for the grid to be displayed. LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "ActiveDocumentConfiguration()" procedure accesses the properties of the current picture
in the Graphics Designer. In this example the grid color for the active picture will be set to
"Blue":
Sub ActiveDocumentConfiguration()
'VBA522
Application.ActiveDocument.Grid = True
Application.ActiveDocument.GridColor = RGB(0, 0, 255)
End Sub
See also
Grid Property (Page 2272)
ActiveDocument Property (Page 2116)
Application Property (Page 2129)
Document Object (Page 1954)
Application Object (Page 1915)
GridHeight Property
Description
Defines or returns the height (in pixels) of the grid in the current picture during the configuration
phase. The Grid property must be set to TRUE for the grid to be displayed.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2273
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ActiveDocumentConfiguration()" procedure accesses the properties of the current picture
in the Graphics Designer. In this example the grid height for the active picture will be set to
"8":
Sub ActiveDocumentConfiguration()
'VBA523
Application.ActiveDocument.Grid = True
Application.ActiveDocument.GridHeight = 8
End Sub
See also
GridWidth Property (Page 2274)
Grid Property (Page 2272)
ActiveDocument Property (Page 2116)
Application Property (Page 2129)
Document Object (Page 1954)
Application Object (Page 1915)
GridWidth Property
Description
Defines or returns the width (in pixels) of the grid in the current picture during the configuration
phase. The Grid property must be set to TRUE for the grid to be displayed.
Example:
The "ActiveDocumentConfiguration()" procedure accesses the properties of the current picture
in the Graphics Designer. In this example the grid width for the active picture will be set to "8":
Sub ActiveDocumentConfiguration()
'VBA524
Application.ActiveDocument.Grid = True
Application.ActiveDocument.GridWidth = 8
End Sub
See also
Grid Property (Page 2272)
GridHeight Property (Page 2273)
ActiveDocument Property (Page 2116)
WinCC: Scripting (VBS, ANSI-C, VBA)
2274 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Application Property (Page 2129)
Document Object (Page 1954)
Application Object (Page 1915)
GroupParent Property
Description
Returns the higher-ranking object in the specified group object. Read-only access.
Example:
--
See also
Group Object (Page 1983)
ActiveDocument Property (Page 2116)
GroupedObjects Object (Listing) (Page 1988)
Document Object (Page 1954)
Application Object (Page 1915)
GroupedHMIObjects Property
Description
Returns a listing containing all the objects in the current group.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2275
VBA for Automated Configuration
3.6 VBA Reference
Example:
In this example the group object "Group1" is created from a number of objects. An ellipse
segment is then added to the group object:
Sub CreateGroup()
'VBA526
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
objGroup.ObjectName = "Group1"
Set objEllipseSegment = ActiveDocument.HMIObjects.AddHMIObject("EllipseSegment",
"HMIEllipseSegment")
'
'Add one object to the existing group
objGroup.GroupedHMIObjects.Add ("EllipseSegment")
End Sub
See also
Group Object (Page 1983)
Height Property
Description
Defines or returns the height of the object (Document, View, Object) in pixels.
Note concerning the Document and View objects:
The default value corresponds to the vertical screen resolution set by the operating system.
The specified value can be higher than the current screen resolution. The picture can then be
moved with the aid of scroll bars.
The maximum picture height that can be set is 10000 pixels.
WinCC: Scripting (VBS, ANSI-C, VBA)
2276 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ActiveDocumentConfiguration()" procedure accesses the properties of the current picture
in the Graphics Designer. In this example the height of the current picture will be set to "1600":
Sub ActiveDocumentConfiguration()
'VBA527
Application.ActiveDocument.Height = 1600
End Sub
See also
View Object (Page 2111)
HMIObject Object (Page 1992)
Document Object (Page 1954)
Hide Property
Description
TRUE if the specified picture is opened as "Visible". BOOLEAN write-read access.
Use the Hide property in order to test, for example, whether a picture is to be visible or invisible
when opened. Other WinCC editors (such as CrossReference) open pictures so that they are
invisible, i.e. they are not displayed in the Graphics Designer. If you use the DocumentOpened
event, for example, you can use the Hide property to prevent the code in the event from being
executed by testing that the Hide property is FALSE.
Use the Add and Open methods to define whether a picture is to be visible or invisible when
opened.
Note
If you set a picture to "Invisible" (Hide = FALSE), you can then only address it via the
Documents listing. The picture is no longer available in the Graphics Designer.
Example:
In the following example, when a picture opens an output indicates whether the picture was
opened as visible or invisible:
Private Sub Document_Opened(CancelForwarding As Boolean)
'VBA802
MsgBox Me.Hide
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2277
VBA for Automated Configuration
3.6 VBA Reference
See also
Open Method (Page 1873)
Add Method (Documents Listing) (Page 1797)
Document Object (Page 1954)
HiddenInput Property
Description
TRUE, when the input value should not be displayed when being entered. Each character
entered is substituted by a *. BOOLEAN write-read access.
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this example
the input will be hidden:
Sub IOFieldConfiguration()
'VBA528
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.HiddenInput = True
End With
End Sub
See also
IOField Object (Page 1996)
HMIObjects Property
Description
Returns a listing containing all the objects in the specified picture.
To return an element from the HMIObjects listing you can use either the index number or the
object name.
WinCC: Scripting (VBS, ANSI-C, VBA)
2278 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
Use the "AddHMIObject(ObjectName, ProgID)" method to insert a new object in a picture: :
Sub AddCircle()
'VBA529
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("my Circle", "HMICircle")
End Sub
See also
Document Object (Page 1954)
HMIUdoObjects property
Description
Supplies a collection of HMIObject objects that represent the inner objects of the
"CustomizedObjects" object.
See also
CustomizedObject Object (Page 1943)
Hotkey Property
Description
Defines or returns the function key for a mouse action in the case of the Button object.
Function key Assigned Value
F1 112
F2 113
F3 114
F4 115
F5 116
F6 117
F7 118
F8 119
F9 120
F10 121
F11 122
F12 123
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2279
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
it is intended that the button can also be launched with function key "F5":
Sub ButtonConfiguration()
'VBA530
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.Hotkey = 116
End With
End Sub
See also
Button Object (Page 1926)
Hysteresis Property
Description
TRUE if the display must include hysteresis (deadband) in the case of the BarGraph object.
BOOLEAN write-read access.
Example:
The "BarGraphConfiguration()" procedure configures In this example the display shall take
place with hysteresis:
Sub BarGraphConfiguration()
'VBA531
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.Hysteresis = True
End With
End Sub
See also
BarGraph Object (Page 1920)
WinCC: Scripting (VBS, ANSI-C, VBA)
2280 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
HysteresisRange Property
Description
Defines or returns the hysteresis (deadband) as a percentage of the display value.
The Hysteresis property must be set to TRUE for the hysteresis to be calculated.
Example:
The "BarGraphConfiguration()" procedure configures In this example the hysteresis will be set
to "4%":
Sub BarGraphConfiguration()
'VBA532
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.Hysteresis = True
.HysteresisRange = 4
End With
End Sub
See also
BarGraph Object (Page 1920)
Hysteresis Property (Page 2280)
I-K
Icon Property
Description
Defines the icon (*.ICO, full path and file name) or returns the path and file name for a button
on a user-defined toolbar.
Path specifications
The following path specification formats are possible:
● Absolute: z.B. "C:\Siemens\WinCC\Icons\myIcon.ICO.
● Relative: The starting folder for relative path specification is the "GraCS" folder of the current
project.
● <global>: Refers to the installation path for WinCC. The path specification "<global>\Icons
\myIcon" is the same as the path specification under "Absolute".
● <project>: Refers to the current project directory (see example).
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2281
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "CreateToolbar()" procedure creates a user-defined toolbar with two icons:
Sub CreateToolbar()
'VBA533
Dim objToolbar As HMIToolbar
Dim objToolbarItem As HMIToolbarItem
Dim strFileWithPath
Set objToolbar = ActiveDocument.CustomToolbars.Add("Tool1_1")
Set objToolbarItem = objToolbar.ToolbarItems.InsertToolbarItem(1, "ti1_1",
"myFirstToolbaritem")
Set objToolbarItem = objToolbar.ToolbarItems.InsertToolbarItem(2, "ti1_2",
"mySecondToolbaritem")
'
'To use this example copy a *.ICO-Graphic
'to the "GraCS"-Folder of the actual project.
'Replace the filename "EZSTART.ICO" in the next commandline
'with the name of the ICO-Graphic you copied
strFileWithPath = Application.ApplicationDataPath & "EZSTART.ICO"
'
'To assign the symbol-icon to the first toolbaritem
objToolbar.ToolbarItems(1).Icon = strFileWithPath
End Sub
See also
ToolbarItems Object (Listing) (Page 2094)
ToolbarItem Object (Page 2092)
How to Add a New Icon to the Toolbar (Page 1641)
How to Create an Application-specific Toolbar (Page 1639)
IndependentWindow property
Description
Defines whether the display of the picture window in Runtime depends on the process picture
in which the picture window was configured.
yes Size and position of the picture window are independent of the process picture
and only defined by the "Window mode" attribute
No Size and position of the picture window change with the shift or scaling of the
process picture
WinCC: Scripting (VBS, ANSI-C, VBA)
2282 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Index Property
Description
Status display
Defines the status (0 bis 255) or returns it. A basic picture and flash picture can be defined for
each status value.
Line Object
Defines the start and end point for a line, and so also defines the direction. Use the
ActualPointLeft and ActualPointTop properties to define the coordinates for each starting and
finishing point.
Polygon object, PolyLine object and TubePolyline object
Defines or returns the number of the corner point whose position coordinates you want to
change or display.
CheckBox and OptionGroup objects
Defines or returns the number (1 to 32) of the field whose text is to be defined.
ComboBox and ListBox object
Defines or returns the number (1 to 32) of the line whose text is to be defined.
Example 1: Line
In the following example a line will be inserted into the active picture and the starting and
finishing points will be defined:
Sub LineAdd()
'VBA682
Dim objLine As HMILine
Dim objEvent As HMIEvent
Set objLine = ActiveDocument.HMIObjects.AddHMIObject("myLine", "HMILine")
With objLine
.BorderColor = RGB(255, 0, 0)
.index = hmiLineIndexTypeStartPoint
.ActualPointLeft = 12
.ActualPointTop = 34
.index = hmiLineIndexTypeEndPoint
.ActualPointLeft = 74
.ActualPointTop = 64
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2283
VBA for Automated Configuration
3.6 VBA Reference
Example 2: Polyline
For this example to work, insert a polyline called "Polyline1" into the active picture: The
"PolyLineCoordsOutput" procedure then outputs the coordinates of all the corner points in the
polyline:
Sub PolyLineCoordsOutput()
'VBA534
Dim iPcIndex As Integer
Dim iPosX As Integer
Dim iPosY As Integer
Dim iIndex As Integer
Dim objPolyLine As HMIPolyLine
Set objPolyLine = Application.ActiveDocument.HMIObjects.AddHMIObject("PolyLine1",
"HMIPolyLine")
'
'Determine number of corners from "PolyLine1":
iPcIndex = objPolyLine.PointCount
'
'Output of x/y-coordinates from every corner:
For iIndex = 1 To iPcIndex
With objPolyLine
.index = iIndex
iPosX = .ActualPointLeft
iPosY = .ActualPointTop
MsgBox iIndex & ". corner:" & vbCrLf & "x-coordinate: " & iPosX & vbCrLf & "y-coordinate:
" & iPosY
End With
Next iIndex
End Sub
Example 3: Check box
The "CreateOptionGroup()" procedure creates the OptionGroup object with four option
buttons. Each option button is assigned the default name "myCustomText<Nummer>":
Sub CreateOptionGroup()
'VBA535
Dim objRadioBox As HMIOptionGroup
Dim iIndex As Integer
Set objRadioBox = ActiveDocument.HMIObjects.AddHMIObject("RadioBox_1", "HMIOptionGroup")
With objRadioBox
.Height = 100
.Width = 180
.BoxCount = 4
For iIndex = 1 To .BoxCount
.index = iIndex
.Text = "myCustomText" & .index
Next iIndex
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2284 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
Line Object (Page 2008)
FlashPicture Property (Page 2250)
BasePicture Property (Page 2151)
ActualPointTop Property (Page 2119)
ActualPointLeft Property (Page 2118)
StatusDisplay Object (Page 2074)
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
OptionGroup Object (Page 2029)
InheritState property
Description
Defines whether the "Display" and "Operator Control Enable" properties of the user object can
be inherited by the individual objects of the user object.
InputValue property
Description
Defines the value to be entered by the user in the I/O field. The value is not displayed in the I/
O field when the property is set.
If you want the value to be displayed in the I/O field after confirmation with the <Return> key,
configure a direct connection between the properties "input value" and "output value". The
direct connection is only practical when no tag is connected to the output value, but the user
can nevertheless query the specified value, for example, through a script.
Example:
IsActive Property
Description
Returns TRUE if a copy of the current picture is active. BOOLEAN read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2285
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ActiveDocumentConfiguration()" procedure accesses the properties of the current picture
in the Graphics Designer. In this example a copy of the current picture will be created and an
output will indicate whether the copy is active.
Sub ActiveDocumentConfiguration()
'VBA537
Application.ActiveDocument.Views.Add
'If you comment out the following line
'and recall the procedure, the output of
'the messagebox is different
Application.ActiveDocument.Views(1).Activate
'
'Output state of copy:
MsgBox Application.ActiveDocument.Views(1).IsActive
End Sub
See also
ActiveDocument Property (Page 2116)
View Object (Page 2111)
IsConnectedToProject Property
Description
Returns TRUE if the project connection is available. BOOLEAN read access.
Example:
The "ConnectCheck()" procedure checks whether a project connection exists and outputs the
result:
Sub ConnectCheck()
'VBA538
Dim bCheck As Boolean
Dim strStatus As String
bCheck = Application.IsConnectedToProject
If bCheck = True Then
strStatus = "yes"
Else
strStatus = "no"
End If
MsgBox "Connection to project available: " & strStatus
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2286 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
Application Object (Page 1915)
IsDynamicable Property
Description
TRUE if a property can be made dynamic. BOOLEAN read access.
Example:
The HMIObjectPropertyChanged event always occurs when you change an object property in
the Graphics Designer. In this example the property name and value will be output. A check
will also be made on whether the property can be made dynamic:
Sub Document_HMIObjectPropertyChanged(ByVal Property As IHMIProperty, CancelForwarding As
Boolean)
'VBA539
Dim objProp As HMIProperty
Dim strStatus As String
Set objProp = Property
'
'Checks whether property is dynamicable
If objProp.IsDynamicable = True Then
strStatus = "yes"
Else
strStatus = "no"
End If
MsgBox "Property: " & objProp.Name & vbCrLf & "Value: " & objProp.value & vbCrLf &
"Dynamicable: " & strStatus
End Sub
Further information on the "Events" topic can be found under the heading "Executing VBA
macros in Graphics Designer".
See also
Property Object (Page 2046)
HMIObject Object (Page 1992)
HMIObjectPropertyChanged Event (Page 1777)
Executing VBA Macros in Graphics Designer (Page 1623)
IsPublished property
Description
TRUE if a property of an object is assigned to the user project.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2287
VBA for Automated Configuration
3.6 VBA Reference
Example
You have created a user object with the two objects "Rectangle1" and "Circle1". You have
assigned the "Width" property of the "Rectangle1" object to the user object.
In the following code example, you can see whether the "Width" property of the "Rectangle1"
object is assigned to the user object.
Sub IsPublished_Test()
'VBA909
Dim LibObj As HMICustomizedObject
Set LibObj = ActiveDocument.HMIObjects("Customized object1")
'Item(1) signifies "Rectangle1" object
MsgBox LibObj.HMIUdoObjects.Item(1).Properties("Width").IsPublished
End Sub
See also
FaceplateProperty object (Page 1976)
Property Object (Page 2046)
Italic Property
Description
TRUE if the font attribute "Italic" is set for the language-dependent text in the object. BOOLEAN
write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2288 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The following example sets the font attributes of a button for French and English:
Sub ExampleForLanguageFonts()
'VBA540
Dim objLangFonts As HMILanguageFonts
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
objButton.Text = "Hello"
Set objLangFonts = objButton.LDFonts
'
'To make fontsettings for french:
With objLangFonts.ItemByLCID(1036)
.Family = "Courier New"
.Bold = True
.Italic = False
.Underlined = True
.Size = 12
End With
'
'To make fontsettings for english:
With objLangFonts.ItemByLCID(1033)
.Family = "Times New Roman"
.Bold = False
.Italic = True
.Underlined = False
.Size = 14
End With
End Sub
See also
Underlined Property (Page 2463)
Size Property (Page 2422)
Parent Property (Page 2364)
LanguageID Property (Page 2296)
Family Property (Page 2236)
Bold Property (Page 2158)
Application Property (Page 2129)
LanguageFont Object (Page 2000)
Item Property
Description
Returns an element from a listing. Depending on the specified object, you can use either the
index number or the name to return a particular element.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2289
VBA for Automated Configuration
3.6 VBA Reference
Example:
This example shows both kinds of indexing. In order for the example to work, create a group
object ("Group1") with two objects. The example outputs the height of the second object in a
group:
Sub GetHeight()
'VBA541
Dim objGroup As HMIGroup
'Next line uses the property "Item" to get a group by name
Set objGroup = ActiveDocument.HMIObjects.Item("Group1")
'Otherwise next line uses index to identify a groupobject
MsgBox "The height of object 2 is: " & objGroup.GroupedHMIObjects.Item(2).Height
End Sub
See also
VariableTriggers Object (Listing) (Page 2110)
VariableStateValues Object (Listing) (Page 2106)
AnalogResultInfos Object (Listing) (Page 1914)
ItemBorderBackColor Property
Description
Defines or returns the background color of the separation lines in the selection list for the
TextList object. LONG write-read access.
The background color is only visible with the property setting ItemBorderStyle > 0.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2290 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the background color for the separation lines will be set to "Red":
Sub TextListConfiguration()
'VBA542
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.ItemBorderStyle = 1
.ItemBorderBackColor = RGB(255, 0, 0)
End With
End Sub
See also
ItemBorderStyle Property (Page 2292)
TextList Object (Page 2085)
ItemBorderColor Property
Description
Defines or returns the color of the separation lines in the selection list for the TextList object.
LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the color for the separation lines will be set to "White":
Sub TextListConfiguration()
'VBA543
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.ItemBorderStyle = 1
.ItemBorderColor = RGB(255, 255, 255)
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2291
VBA for Automated Configuration
3.6 VBA Reference
See also
TextList Object (Page 2085)
ItemBorderStyle Property
Description
Defines or returns the dividing line style in the selection list for the TextList object. Value range
from 0 to 4.
Line style Assigned Value
0
1
2
3
4
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the dividing line style will be set to "1":
Sub TextListConfiguration()
'VBA544
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.ItemBorderStyle = 1
.ItemBorderBackColor = RGB(255, 0, 0)
End With
End Sub
See also
TextList Object (Page 2085)
ItemBorderWidth Property
Description
Defines or returns the weight in pixels of the dividing lines in the selection list for the TextList
object.
WinCC: Scripting (VBS, ANSI-C, VBA)
2292 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the dividing line width will be set to "4":
'Sub E_628_TextListConfiguration()
Sub E_629_TextListConfiguration()
'VBA545
Dim objTextList As HMITextList
Set objTextList =
ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.ItemBorderWidth = 4
End With
End Sub
See also
TextList Object (Page 2085)
Key Property
Description
Returns the name that identifies the entry (menu point or icon) in the user-defined menu or
user-defined toolbar. Read only access.
Use the Key property to determine which entry was clicked. For this purpose you can use, say,
the events "MenuItemClicked" and "ToolBarItemClicked".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2293
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "CreateMenuItem()" procedure creates the "Delete Objects" menu and adds two menu
entries ("Delete Rectangles" and "Delete Circles"):
Sub CreateMenuItem()
'VBA546
Dim objMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
'
'Add new menu "Delete objects" to menubar:
Set objMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DeleteObjects", "Delete objects")
'
'Adds two menuitems to menu "Delete objects"
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(1, "DeleteAllRectangles", "Delete
Rectangles")
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(2, "DeleteAllCircles", "Delete Circles")
End Sub
In connection with the "MenuItemClicked" event, you can connect the menu entries with
procedure calls, for instance. In this example the names of the menu entries will be output:
Sub Document_MenuItemClicked(ByVal MenuItem As IHMIMenuItem)
'VBA547
Dim strClicked As String
Dim objMenuItem As HMIMenuItem
Set objMenuItem = MenuItem
'
'"strClicked can get two values:
'(1) "DeleteAllRectangles" and
'(2) "DeleteAllCircles"
strClicked = objMenuItem.Key
'
'To analyse "strClicked" with "Select Case"
Select Case strClicked
Case "DeleteAllRectangles"
'
'Instead of "MsgBox" a procedurecall (e.g. "Call <Prozedurname>") can stay here
MsgBox "'Delete rectangle' was clicked"
Case "DeleteAllCircles"
MsgBox "'Delete Circles' was clicked"
End Select
End Sub
See also
ToolbarItem Object (Page 2092)
MenuItem Object (Page 2017)
InsertToolbarItem Method (Page 1862)
InsertMenuItem Method (Page 1858)
ToolbarItemClicked Event (Page 1789)
WinCC: Scripting (VBS, ANSI-C, VBA)
2294 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
MenuItemClicked Event (Page 1782)
Creating Customized Menus and Toolbars (Page 1631)
Label Property
Description
Returns the label of the user-defined menu or menu entry in the currently set language. Read
only access.
Example:
The "CreateMenuItem()" procedure creates the "Delete Objects" menu and adds two menu
entries ("Delete Rectangles" and "Delete Circles"): In this example the labels will then be output:
Sub CreateMenuItem()
'VBA548
Dim objMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Dim iIndex As Integer
iIndex = 1
'
'Add new menu "Delete objects" to menubar
Set objMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DeleteObjects", "Delete objects")
'
'Adds two menuitems to menu "Delete objects"
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(1, "DeleteAllRectangles", "Delete
rectangles")
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(2, "DeleteAllCircles", "Delete circles")
MsgBox ActiveDocument.CustomMenus(1).Label
For iIndex = 1 To objMenu.MenuItems.Count
MsgBox objMenu.MenuItems(iIndex).Label
Next iIndex
End Sub
See also
CustomMenus Property (Page 2214)
MenuItems Object (Listing) (Page 2019)
MenuItem Object (Page 2017)
Menu Object (Page 2013)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2295
VBA for Automated Configuration
3.6 VBA Reference
LanguageID Property
Description
Returns the language identifier of the project language as a decimal value. LONG read access
Example:
The "DataLanguages()" procedure outputs the project languages together with their language
identifiers:
Sub DataLanguages()
'VBA549
Dim colDataLang As HMIDataLanguages
Dim objDataLang As HMIDataLanguage
Dim nLangID As Long
Dim strLangName As String
Dim iAnswer As Integer
Set colDataLang = Application.AvailableDataLanguages
For Each objDataLang In colDataLang
nLangID = objDataLang.LanguageID
strLangName = objDataLang.LanguageName
iAnswer = MsgBox(nLangID & " " & strLangName, vbOKCancel)
If vbCancel = iAnswer Then Exit For
Next objDataLang
End Sub
See also
DataLanguages Object (Listing) (Page 1947)
DataLanguage Object (Page 1946)
LanguageName Property
Description
Returns the project language. STRING read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2296 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "DataLanguages()" procedure outputs the project languages together with their language
identifiers:
Sub DataLanguages()
'VBA550
Dim colDataLang As HMIDataLanguages
Dim objDataLang As HMIDataLanguage
Dim nLangID As Long
Dim strLangName As String
Dim iAnswer As Integer
Set colDataLang = Application.AvailableDataLanguages
For Each objDataLang In colDataLang
nLangID = objDataLang.LanguageID
strLangName = objDataLang.LanguageName
iAnswer = MsgBox(nLangID & " " & strLangName, vbOKCancel)
If vbCancel = iAnswer Then Exit For
Next objDataLang
End Sub
See also
DataLanguages Object (Listing) (Page 1947)
DataLanguage Object (Page 1946)
LanguageSwitch Property
Description
Defines where the language-dependent assignment texts are stored or returns the value.
BOOLEAN write-read access.
TRUE, when the texts in the Text Library are managed. Translation to other language occurs
in the Text Library.
FALSE, when the texts are managed directly in the object. Translation to other language can
be carried out using Text Distributor.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2297
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the texts will be managed in the Text Library:
Sub TextListConfiguration()
'VBA551
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.LanguageSwitch = True
End With
End Sub
See also
TextList Object (Page 2085)
LastChange Property
Description
Returns the date on which the current picture was last changed. READ access.
Example:
The "ActiveDocumentConfiguration()" procedure accesses the properties of the current picture
in the Graphics Designer. In this example the date of the last change to the current picture will
be output:
Sub ActiveDocumentConfiguration()
'VBA552
Dim varLastDocChange As Variant
varLastDocChange = Application.ActiveDocument.LastChange
MsgBox "Last changing: " & varLastDocChange
End Sub
See also
Document Object (Page 1954)
WinCC: Scripting (VBS, ANSI-C, VBA)
2298 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Layer Property
Description
Defines which layer of the picture an object is located in, or returns that information. There is
a total of 32 layers available, whereby Layer "0" is the bottom layer and Layer "31" the top
layer.
The configured objects are initially in the background of a layer.
Note
In VBA the numbering starts at "1". An entry of "objRectangle.Layer = 1" is therefore located
in the lowest layer.
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example the Rectangle object will be inserted in layer "4":
Sub RectangleConfiguration()
'VBA553
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.Layer = 4
End With
End Sub
See also
HMIObject Object (Page 1992)
Editing Layers with VBA (Page 1666)
Layer00..10Checked property
Description
TRUE if the respective limit "0" to "10" is monitored in the case of the "3DBarGraph" object.
BOOLEAN write-read access.
The limit and the color representation are specified with the properties "Layer00..10Value" and
"Layer00..10Color".
The bar fill color and the fill pattern are specified with the properties "Layer00..10FillColor" and
"Layer00..10FillStyle".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2299
VBA for Automated Configuration
3.6 VBA Reference
Example
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example, limit "0" is to be monitored:
Sub HMI3DBarGraphConfiguration()
'VBA554
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
.Layer00Checked = True
End With
End Sub
See also
Layer00..10Value property (Page 2302)
Layer00..10Color property (Page 2300)
3DBarGraph Object (Page 1900)
Layer00..10Color property
Description
Defines or returns the color for the respective limit "0" to "10" of the "3DBarGraph" object.
LONG write-read access.
When monitoring of the limit value is activated using the "Layer00..10Checked" property, the
bar turns to the color defined by this attribute on reaching the limit value.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0).
WinCC: Scripting (VBS, ANSI-C, VBA)
2300 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example the color for limit "0" is defined as "Magenta":
Sub HMI3DBarGraphConfiguration()
'VBA555
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
.Layer00Checked = True
.Layer00Color = RGB(255, 0, 255)
End With
End Sub
See also
Layer00..10Checked property (Page 2299)
3DBarGraph Object (Page 1900)
Layer00..10FillColor property
Description
Defines or returns the bar fill color for the respective limit "0" to "10" of the "3DBarGraph" object.
LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0).
Layer00..10FillStyle property
Description
Defines or returns the bar fill pattern for the respective limit "0" to "10" of the "3DBarGraph"
object.
The bar fill color has to differ from the bar color to make the fill pattern visible.
There is a choice of 50 fill patterns. The "0" fill pattern fills the object with the set background
color. The "1" fill pattern means neither a background nor a fill pattern is displayed.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2301
VBA for Automated Configuration
3.6 VBA Reference
Layer00..10Value property
Description
Defines or returns the value for "Limit 0" to "Limit 10" in the case of the "3DBarGraph" object.
Monitoring only takes effect when the "Layer00..10Checked" property value is set to "TRUE".
Example
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example the value for limit "0" is defined as "0":
Sub HMI3DBarGraphConfiguration()
'VBA556
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
.Layer00Checked = True
.Layer00Value = 0
End With
End Sub
See also
Layer00..10Checked property (Page 2299)
3DBarGraph Object (Page 1900)
LayerDecluttering Property
Description
TRUE if showing and hiding objects dependent upon the minimum and maximum zoom set
for a layer has been enabled. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2302 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the settings for the lowest layer are configured in the active picture:
Sub ConfigureSettingsOfLayer()
'VBA587
Dim objLayer As HMILayer
Set objLayer = ActiveDocument.Layers(1)
With objLayer
'configure "Layer 0"
.MinZoom = 10
.MaxZoom = 100
.Name = "Configured with VBA"
End With
'define fade-in and fade-out of objects:
With ActiveDocument
.LayerDecluttering = True
.ObjectSizeDecluttering = True
.SetDeclutterObjectSize 50, 100
End With
End Sub
See also
Document Object (Page 1954)
Editing Layers with VBA (Page 1666)
Layers Property
Description
Returns a listing containing the properties of the layers in the current picture.
Note
If the "Layers" property is used, the sequence of HMI objects in the HMIObjects listing can
change.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2303
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "LayerInfo()" procedure outputs the name and zoom configuration for each layer of the
current picture:
Sub LayerInfo()
'VBA588
Dim colLayers As HMILayers
Dim objLayer As HMILayer
Dim iAnswer As Integer
Set colLayers = ActiveDocument.Layers
For Each objLayer In colLayers
With objLayer
iAnswer = MsgBox("Layername: " & .Name & vbCrLf & "max. zoom: " & .MaxZoom & vbCrLf & "min.
zoom: " & .MinZoom, vbOKCancel)
End With
If vbCancel = iAnswer Then Exit For
Next objLayer
End Sub
See also
Name Property (Page 2349)
MinZoom Property (Page 2346)
MaxZoom Property (Page 2329)
Layers Object (Listing) (Page 2006)
Layer Object (Page 2005)
LDAssignments property
Description
Returns a listing with the (foreign language) assignments of display texts that are displayed
depending on the current "Output Value" in the "TextList" object.
The assignments depend on the set list type. Specify the list type with the "ListType" property.
LDFonts Property
Description
Returns a listing containing the language identifiers for the configured fonts.
WinCC: Scripting (VBS, ANSI-C, VBA)
2304 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
Use the LDFonts property to return the LanguageFonts listing. In the following example the
language identifiers of the configured fonts will be output:
Sub ShowLanguageFont()
'VBA589
Dim colLanguageFonts As HMILanguageFonts
Dim objLanguageFont As HMILanguageFont
Dim objButton As HMIButton
Dim iMax As Integer
Dim iAnswer As Integer
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
Set colLanguageFonts = objButton.LDFonts
iMax = colLanguageFonts.Count
For Each objLanguageFont In colLanguageFonts
iAnswer = MsgBox("Projected fonts: " & iMax & vbCrLf & "Language-ID: " &
objLanguageFont.LanguageID, vbOKCancel)
If vbCancel = iAnswer Then Exit For
Next objLanguageFont
End Sub
See also
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
LanguageFonts Object (Listing) (Page 2001)
CheckBox Object (Page 1930)
Button Object (Page 1926)
LDFontsType property
Description
Only used internally.
See also
FaceplateProperty object (Page 1976)
LDLabelTexts Property
Description
Returns a listing containing the multilingual labels of the user-defined menu or menu entry.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2305
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "CreateMenuItem()" procedure creates the "Delete Objects" menu and adds two menu
entries ("Delete Rectangles" and "Delete Circles"): In this example, multilingual menu labels
will be created:
Sub CreateMenuItem()
'VBA590
Dim objMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Dim objLangText As HMILanguageText
'
'Add new menu "Delete objects" to menubar:
Set objMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DeleteObjects", "Delete objects")
'
'Add two menuitems to the new menu
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(1, "DeleteAllRectangles", "Delete
rectangles")
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(2, "DeleteAllCircles", "Delete circles")
'
'Define foreign-language labels for menu "Delete objects":
Set objLangText = objMenu.LDLabelTexts.Add(1033, "English_Delete objects")
Set objLangText = objMenu.LDLabelTexts.Add(1032, "Greek_Delete objects")
Set objLangText = objMenu.LDLabelTexts.Add(1034, "Spanish_Delete objects")
Set objLangText = objMenu.LDLabelTexts.Add(1036, "French_Delete objects")
End Sub
The "LDLabelInfo()" procedure outputs the labels configured for the "Delete Objects" menu:
Sub LDLabelInfo()
'VBA591
Dim colLangTexts As HMILanguageTexts
Dim objLangText As HMILanguageText
Dim iAnswer As Integer
'
'Save all labels of menu into collection "colLangTexts":
Set colLangTexts = ActiveDocument.CustomMenus("DeleteObjects").LDLabelTexts
For Each objLangText In colLangTexts
iAnswer = MsgBox(objLangText.DisplayName, vbOKCancel)
If vbCancel = iAnswer Then Exit For
Next objLangText
End Sub
See also
MenuItem Object (Page 2017)
Menu Object (Page 2013)
WinCC: Scripting (VBS, ANSI-C, VBA)
2306 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
LDNames Property
Description
Returns a listing containing the multilingual names of a folder in the Components Library or of
a layer.
Example:
Use the LDNames property to return the LanguageTexts listing. In the following example all
multilingual layer names will be output:
Explanation: What the example shows
Sub LDLabelInfo()
'VBA592
Dim colLayerLngTexts As HMILanguageTexts
Dim objLayerLngText As HMILanguageText
Dim iIndex As Integer
Dim iAnswer As Integer
Dim strResult As String
iIndex = 1
For iIndex = 1 To ActiveDocument.Layers.Count
'
'Save all labels of layers into collection of "colLayerLngTexts":
Set colLayerLngTexts = ActiveDocument.Layers(iIndex).LDNames
For Each objLayerLngText In colLayerLngTexts
strResult = strResult & vbCrLf & objLayerLngText.LanguageID & " - " &
objLayerLngText.DisplayName
Next objLayerLngText
iAnswer = MsgBox(strResult, vbOKCancel)
strResult = ""
If vbCancel = iAnswer Then Exit For
Next iIndex
End Sub
See also
Layer Object (Page 2005)
LanguageTexts Object (Listing) (Page 2004)
FolderItem Object (Page 1977)
LDStatusTexts Property
Description
Returns a listing containing the multilingual status line texts of a user-defined icon or menu
entry.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2307
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "CreateMenuItem()" procedure creates the "Delete Objects" menu and adds two menu
entries ("Delete Rectangles" and "Delete Circles"). In this example, multilingual status line texts
will be created:
Sub CreateMenuItem()
'VBA593
Dim objMenu As HMIMenu
Dim objMenuItem1 As HMIMenuItem
Dim objMenuItem2 As HMIMenuItem
Dim objLangStateText As HMILanguageText
'
'Add new menu "Delete objects" to menubar:
Set objMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DeleteObjects", "Delete objects")
'
'Add two menuitems to the new menu
Set objMenuItem1 = objMenu.MenuItems.InsertMenuItem(1, "DeleteAllRectangles", "Delete
rectangles")
Set objMenuItem2 = objMenu.MenuItems.InsertMenuItem(2, "DeleteAllCircles", "Delete
circles")
'
'Define foreign-language labels for menuitem "Delete rectangles":
Set objLangStateText = objMenuItem1.LDStatusTexts.Add(1033, "English_Delete rectangles")
Set objLangStateText = objMenuItem1.LDStatusTexts.Add(1032, "Greek_Delete rectangles")
Set objLangStateText = objMenuItem1.LDStatusTexts.Add(1034, "Spanish_Delete rectangles")
Set objLangStateText = objMenuItem1.LDStatusTexts.Add(1036, "French_Delete rectangles")
End Sub
The "LDStatusTextInfo()" procedure outputs the status line texts configured for the "Delete
Objects" menu:
Sub LDStatusTextInfo()
'VBA594
Dim colMenuItems As HMIMenuItems
Dim objMenuItem As HMIMenuItem
Dim colStatusLngTexts As HMILanguageTexts
Dim objStatusLngText As HMILanguageText
Dim strResult As String
Dim iAnswer As Integer
Set colMenuItems = ActiveDocument.CustomMenus("DeleteObjects").MenuItems
For Each objMenuItem In colMenuItems
strResult = "Statustexts of menuitem """ & objMenuItem.Label & """"
Set colStatusLngTexts = objMenuItem.LDStatusTexts
For Each objStatusLngText In colStatusLngTexts
strResult = strResult & vbCrLf & objStatusLngText.DisplayName
Next objStatusLngText
iAnswer = MsgBox(strResult, vbOKCancel)
If vbCancel = iAnswer Then Exit For
Next objMenuItem
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2308 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
ToolbarItem Object (Page 2092)
MenuItem Object (Page 2017)
Menu Object (Page 2013)
LDTexts Property
Description
Returns a listing containing the multilingual labels of an object.
Example:
The "LDTextInfo()" procedure outputs the labels configured for the Button object. For this
example to work, create the object "myButton" in the Graphics Designer and configure a
number of multilingual labels:
Sub LDTextInfo()
'VBA595
Dim colLDLngTexts As HMILanguageTexts
Dim objLDLngText As HMILanguageText
Dim objButton As HMIButton
Dim iAnswer As Integer
Set objButton = ActiveDocument.HMIObjects("myButton")
Set colLDLngTexts = objButton.LDTexts
For Each objLDLngText In colLDLngTexts
iAnswer = MsgBox(objLDLngText.DisplayName, vbOKCancel)
If vbCancel = iAnswer Then Exit For
Next objLDLngText
End Sub
See also
Button Object (Page 1926)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
CheckBox Object (Page 1930)
LDTooltipTexts Property
Description
Returns a listing containing the multilingual Tooltip texts for a user-defined icon or for an object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2309
VBA for Automated Configuration
3.6 VBA Reference
Example
The "CreateToolbar()" procedure creates a user-defined toolbar with two icons. Two
multilingual Tooltip texts are assigned to the first icon:
Sub CreateToolbar()
'VBA596
Dim objToolbar As HMIToolbar
Dim objToolbarItem As HMIToolbarItem
Dim objLangText As HMILanguageText
Dim strFileWithPath
'
'Create toolbar with two toolbar-items:
Set objToolbar = ActiveDocument.CustomToolbars.Add("Tool1_1")
Set objToolbarItem = objToolbar.ToolbarItems.InsertToolbarItem(1, "ti1_1",
"myFirstToolbaritem")
Set objToolbarItem = objToolbar.ToolbarItems.InsertToolbarItem(2, "ti1_2",
"mySecondToolbaritem")
'
'In order that the example runs correct copy a *.ICO-Graphic
'into the "GraCS"-Folder of the actual project.
'Replace the filename "EZSTART.ICO" in the next commandline
'with the name of the ICO-Graphic you copied
strFileWithPath = Application.ApplicationDataPath & "EZSTART.ICO"
'
'
'To assign the symbol-icon to the first toolbaritem
objToolbar.ToolbarItems(1).Icon = strFileWithPath
'
'Define foreign-language tooltiptexts
Set objLangText = objToolbar.ToolbarItems(1).LDTooltipTexts.Add(1036, "French_Tooltiptext")
Set objLangText = objToolbar.ToolbarItems(1).LDTooltipTexts.Add(1034,
"Spanish_Tooltiptext")
End Sub
The "LDTooltipInfo()" procedure outputs all the Tooltip texts configured for the first icon in the
first user-defined toolbar:
Sub LDTooltipInfo()
'VBA597
Dim colLangTexts As HMILanguageTexts
Dim objLangText As HMILanguageText
Dim iAnswer As Integer
Set colLangTexts = ActiveDocument.CustomToolbars(1).ToolbarItems(1).LDTooltipTexts
For Each objLangText In colLangTexts
iAnswer = MsgBox(objLangText.DisplayName, vbOKCancel)
If vbCancel = iAnswer Then Exit For
Next objLangText
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2310 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
ToolbarItem Object (Page 2092)
HMIObject Object (Page 1992)
Left Property
Description
Defines or returns the X coordinate of the object (measured from the top left-hand edge of the
picture) in pixels. The X-coordinate relates to the top left corner of the rectangle enclosing the
object.
View Object
Defines or returns the X coordinate of the window (measured from the top left-hand edge of
the Graphics Designer working area) in pixels.
Example:
The "RectangleConfiguration()" procedure accesses the properties of the rectangle. In this
example the rectangle will be moved 40 pixels to the right:
Sub RectangleConfiguration()
'VBA598
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.Left = 40
End With
End Sub
See also
View Object (Page 2111)
HMIObject Object (Page 1992)
LeftComma Property
Description
Defines or returns the number of digits to the left of the decimal point (0 to 20) for the BarGraph
object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2311
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphConfiguration()" procedure configures In this example the number of digits to
the left of the decimal point will be set to "4".
Sub BarGraphConfiguration()
'VBA599
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.LeftComma = 4
End With
End Sub
See also
BarGraph Object (Page 1920)
LightEffect Property
Description
TRUE if the light effect of the 3DBarGraph object is activated. BOOLEAN write-read access.
Example:
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example the light effect will be activated:
Sub HMI3DBarGraphConfiguration()
'VBA600
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
.LightEffect = True
End With
End Sub
See also
3DBarGraph Object (Page 1900)
LimitHigh4 Property
Description
Defines or returns the high limit value for "Reserve 4" in the case of the BarGraph object.
WinCC: Scripting (VBS, ANSI-C, VBA)
2312 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
The CheckLimitHigh4 property must be set to TRUE in order that the "Reserve 4" limit value
can be monitored.
The type of the evaluation (in percent or absolute) is defined in the TypeLimitHigh4 property.
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "70".
Sub BarGraphLimitConfiguration()
'VBA601
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeLimitHigh4 = False
'Activate monitoring
.CheckLimitHigh4 = True
'Set barcolor to "red"
.ColorLimitHigh4 = RGB(255, 0, 0)
'Set upper limit to "70"
.LimitHigh4 = 70
End With
End Sub
See also
TypeLimitHigh4 Property (Page 2455)
CheckLimitHigh4 Property (Page 2179)
BarGraph Object (Page 1920)
LimitHigh5 Property
Description
Defines or returns the high limit value for "Reserve 5" in the case of the BarGraph object.
The CheckLimitHigh5 property must be set to TRUE in order that the "Reserve 5" limit value
can be monitored.
The type of the evaluation (in percent or absolute) is defined in the TypeLimitHigh5 property.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2313
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "80".
Sub BarGraphLimitConfiguration()
'VBA602
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeLimitHigh5 = False
'Activate monitoring
.CheckLimitHigh5 = True
'Set barcolor to "black"
.ColorLimitHigh5 = RGB(0, 0, 0)
'Set upper limit to "80"
.LimitHigh4 = 80
End With
End Sub
See also
TypeLimitHigh5 Property (Page 2456)
CheckLimitHigh5 Property (Page 2180)
BarGraph Object (Page 1920)
LimitLow4 Property
Description
Defines or returns the low limit value for "Reserve 4" in the case of the BarGraph object.
The CheckLimitLow4 property must be set to TRUE in order that the "Reserve 4" limit value
can be monitored.
The type of the evaluation (in percent or absolute) is defined in the TypeLimitLow4 property.
WinCC: Scripting (VBS, ANSI-C, VBA)
2314 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "5".
Sub BarGraphLimitConfiguration()
'VBA603
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeLimitLow4 = False
'Activate monitoring
.CheckLimitLow4 = True
'Set barcolor to "green"
.ColorLimitLow4 = RGB(0, 255, 0)
'Set lower limit to "5"
.LimitLow4 = 5
End With
End Sub
See also
CheckLimitLow4 Property (Page 2181)
TypeLimitLow4 Property (Page 2457)
BarGraph Object (Page 1920)
LimitLow5 Property
Description
Defines or returns the low limit value for "Reserve 5" in the case of the BarGraph object.
The CheckLimitLow5 property must be set to TRUE in order that the "Reserve 5" limit value
can be monitored.
The type of the evaluation (in percent or absolute) is defined in the TypeLimitLow5 property.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2315
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "0".
Sub BarGraphLimitConfiguration()
'VBA604
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis to absolute
.TypeLimitLow5 = False
'Activate monitoring
.CheckLimitLow5 = True
'Set barcolor to "white"
.ColorLimitLow5 = RGB(255, 255, 255)
'Set lower limit to "0"
.LimitLow5 = 0
End With
End Sub
See also
BarGraph Object (Page 1920)
TypeLimitLow5 Property (Page 2458)
CheckLimitLow5 Property (Page 2182)
LimitMax Property
Description
Defines or returns the high limit value as an absolute value dependent on the data format in
the case of the IOField object.
If the value to be displayed exceeds the upper limit value, it is identified by a series of *** ,
indicating it cannot be displayed.
WinCC: Scripting (VBS, ANSI-C, VBA)
2316 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this example
the high limit for a decimal value will be set to "100":
Sub IOFieldConfiguration()
'VBA605
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.DataFormat = 1
.LimitMax = 100
End With
End Sub
See also
DataFormat Property (Page 2216)
IOField Object (Page 1996)
LimitMin Property
Description
Defines or returns the low limit value as an absolute value dependent on the data format in
the case of the IOField object.
If the value to be displayed exceeds the upper limit value, it is identified by a series of *** ,
indicating it cannot be displayed.
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this example
the high limit for a decimal value will be set to "0":
Sub IOFieldConfiguration()
'VBA606
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.DataFormat = 1
.LimitMin = 0
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2317
VBA for Automated Configuration
3.6 VBA Reference
See also
DataFormat Property (Page 2216)
IOField Object (Page 1996)
LineJoinStyle property
Description
Defines the way that corners are displayed in a tube polygon.
Angle The tubes are joined at corner points without rounding.
Round The tubes are rounded at the outside corner points.
Example
ListType Property
Description
Defines or returns the list type in the case of the TextList object. Value range from 0 to 2.
List type Assigned Value
Decimal 0
Binary 1
Bit 2
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the list type will be set to "Decimal":
Sub TextListConfiguration()
'VBA607
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.ListType = 0
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2318 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
TextList Object (Page 2085)
LockBackColor Property
Description
Defines or returns the background color of the button for a locked measuring point in the case
of the GroupDisplay object. LONG write-read access.
The LockStatus property must be set to TRUE for the background color to be displayed.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color for a locked measuring point will be set to "Red":
Sub GroupDisplayConfiguration()
'VBA608
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.LockStatus = True
.LockBackColor = RGB(255, 0, 0)
End With
End Sub
See also
LockStatus Property (Page 2321)
GroupDisplay Object (Page 1985)
LockedByCreatorID Property
Description
TRUE, if a picture was created and/or referenced by SIMATIC Manager. BOOLEAN read
access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2319
VBA for Automated Configuration
3.6 VBA Reference
If a picture was created in SIMATIC Manager, you may process and subsequently save it in
WinCC. You may, however, not delete this picture in WinCC. SIMATIC Manager administers
a code for each picture, the so-called CreatorID, which cannot be changed in WinCC.
You may process the picture in WinCC, however, overwriting the picture with a WinCC picture
(LockedByCreatorID = FALSE) will be prevented. This may be checked by examining the
LockedByCreatorID property of an existing file prior to writing during the SaveAs method. If
such a picture is saved into a new (not yet existing) or an existing WinCC picture using the
SaveAs method, the CreatorID will not be passed on.
Example 1
Inn the following example, a picture created with SIMATIC Manager (LockedByCreatorID =
TRUE) is opened, processed, and saved. The value of the LockedByCreatorID property is not
changed.
Sub SaveDocAs_1()
'VBA810
'open an existing file, change it and save it
Dim docOld As Document
Const strFile As String = "Simatic_001.Pdl"
'
Set docOld = Application.Documents.Open(Application.ApplicationDataPath & strFile,
hmiOpenDocumentTypeInvisible)
docOld.Width = docOld.Width + 1
docOld.Save
'
MsgBox "LockedByCreatorID = " & docOld.LOckedByCreatorID, vbOKOnly, "Result"
'
docOld.Close
Set docOld = Nothing
'
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2320 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example 2
In this example, a new picture is saved as a new file using the SaveAs method. To check if
the picture is permitted to be saved, the LockedByCreatorID property is checked. In the new
file the LockedByCreator property is reset.
Sub SaveDocAs_2()
'VBA811
'create a new file and overwrite it to an existing file,
'if it is not 'locked by CreatorID'
Dim docNew As Document
Dim docOld As Document
Const strFile As String = "Simatic_001.Pdl"
'
Set docNew = Application.Documents.Add(hmiOpenDocumentTypeInvisible)
Set docOld = Application.Documents.Open(Application.ApplicationDataPath & strFile,
hmiOpenDocumentTypeInvisible)
'
If docOld.LockedByCreatorID = False Then
docOld.Close
docNew.SaveAs(Application.ApplicationDataPath & strFile)
Else
MsgBox "File cannot be stored (LockedByCreatorID). ", vbOKOnly, "Result"
End If
'
docOld.Close
docNew.Close
Set docOld = Nothing
Set docNew = Nothing
'
End Sub
See also
SaveAs Method (Page 1886)
Document Object (Page 1954)
LockStatus Property
Description
TRUE if a locked measuring point is to be displayed with the Object GroupDisplay. BOOLEAN
write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2321
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color for a locked measuring point will be set to "Red":
Sub GroupDisplayConfiguration()
'VBA609
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.LockStatus = True
.LockBackColor = RGB(255, 0, 0)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
LockText Property
Description
Defines the button labels for a locked measuring point in the case of the GroupDisplay object.
The LockStatus property must be set to TRUE for the label to be displayed.
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the label for a locked measuring point will be set to "Locked":
Sub GroupDisplayConfiguration()
'VBA610
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.LockStatus = True
.LockText = "gesperrt"
End With
End Sub
See also
LockStatus Property (Page 2321)
GroupDisplay Object (Page 1985)
WinCC: Scripting (VBS, ANSI-C, VBA)
2322 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
LockTextColor Property
Description
Defines or returns the color of the button label for a locked measuring point in the case of the
GroupDisplay object. LONG write-read access.
The LockStatus property must be set to TRUE for the background color to be displayed.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the button label for a locked measuring point will be set to "Yellow":
Sub GroupDisplayConfiguration()
'VBA611
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.LockStatus = True
.LockTextColor = RGB(0, 255, 255)
End With
End Sub
See also
LockStatus Property (Page 2321)
GroupDisplay Object (Page 1985)
LongStrokesBold Property
Description
TRUE if the long strokes on the scale of the BarGraph object are to be displayed in bold.
BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2323
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphConfiguration()" procedure configures In this example the long strokes will not
be displayed in bold:
Sub BarGraphConfiguration()
'VBA612
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.LongStrokesBold = False
End With
End Sub
See also
BarGraph Object (Page 1920)
LongStrokesOnly Property
Description
TRUE if just the long strokes on the scale of the BarGraph object are to be displayed.
BOOLEAN write-read access.
Example:
The "BarGraphConfiguration()" procedure configures In this example, only the long strokes
will be displayed:
Sub BarGraphConfiguration()
'VBA613
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.LongStrokesOnly = True
End With
End Sub
See also
BarGraph Object (Page 1920)
WinCC: Scripting (VBS, ANSI-C, VBA)
2324 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
LongStrokesSize Property
Description
The "BarGraphConfiguration()" procedure configures
Example:
In this example the length of the axis section strokes will be set to "10".
Sub BarGraphConfiguration()
'VBA614
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.LongStrokesSize = 10
End With
End Sub
See also
AxisSection Property (Page 2137)
BarGraph Object (Page 1920)
LongStrokesTextEach Property
Description
Defines or returns which strokes will be labeled when displaying the scale on the BarGraph
object (1 = every stroke, 2 = every second stroke, etc.).
Example:
The "BarGraphConfiguration()" procedure configures In this example every third stroke will be
labeled:
Sub BarGraphConfiguration()
'VBA615
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
LongStrokesTextEach = 3
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2325
VBA for Automated Configuration
3.6 VBA Reference
See also
BarGraph Object (Page 1920)
Macro Property
Description
For a user-defined menu entry or icon, defines the VBA macro that will be executed upon
selection.
Example:
In the following example, a user-defined menu with two menu entries is created, which retrieve
two different VBA macros:
Sub CreateDocumentMenusUsingMacroProperty()
'VBA616
Dim objDocMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Set objDocMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DocMenu1", "Doc_Menu_1")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(1, "dmItem1_1", "My first menuitem")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(2, "dmItem1_2", "My second menuitem")
'
'To assign a macro to every menuitem:
With ActiveDocument.CustomMenus("DocMenu1")
.MenuItems("dmItem1_1").Macro = "TestMacro1"
.MenuItems("dmItem1_2").Macro = "TestMacro2"
End With
End Sub
You can call the following two procedures via the menu items in the user-defined menu
"DocMenu1":
Sub TestMacro1()
MsgBox "TestMacro1 is executed"
End Sub
Sub TestMacro2()
MsgBox "TestMacro2 is executed"
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2326 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
ToolbarItem Object (Page 2092)
MenuItem Object (Page 2017)
How to assign VBA macros to menus and toolbars (Page 1645)
Marker Property
Description
TRUE if the limit values are to be displayed as a scale value in the case of the BarGraph object.
BOOLEAN write-read access.
Example:
The "BarGraphConfiguration()" procedure configures In this example, the limit values will be
displayed as scale values:
Sub BarGraphConfiguration()
'VBA617
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.Marker = True
End With
End Sub
See also
BarGraph Object (Page 1920)
Max Property
Description
Defines or returns the absolute value in the case of a full value display.
This value is displayed if the scale display is active.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2327
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphConfiguration()" procedure configures In this example the absolute value will
be set to "10".
Sub BarGraphConfiguration()
'VBA618
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.Max = 10
End With
End Sub
See also
Slider object (Page 2066)
BarGraph Object (Page 1920)
3DBarGraph Object (Page 1900)
MaxIndex property
Description
Shows the highest index of all configurable alarm and status combinations at the
"HMIAdvancedStateDisplay" object.
MaximizeButton Property
Description
TRUE if the ApplicationWindow object can be maximized in Runtime. BOOLEAN write-read
access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2328 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ApplicationWindowConfig" procedure accesses the properties of the application window.
In this example the application window will receive a Maximize button in Runtime:
Sub ApplicationWindowConfig()
'VBA619
Dim objAppWindow As HMIApplicationWindow
Set objAppWindow = ActiveDocument.HMIObjects.AddHMIObject("AppWindow1",
"HMIApplicationWindow")
With objAppWindow
.MaximizeButton = True
End With
End Sub
See also
ApplicationWindow Object (Page 1917)
MaxZoom Property
Description
Defines or returns the maximum zoom level for the layer.
Example:
The "LayerInfo()" procedure outputs the name and zoom configuration for each layer of the
current picture:
Sub LayerInfo()
'VBA620
Dim colLayers As HMILayers
Dim objSingleLayer As HMILayer
Dim iAnswer As Integer
Set colLayers = ActiveDocument.Layers
For Each objSingleLayer In colLayers
With objSingleLayer
iAnswer = MsgBox("Layername: " & .Name & vbCrLf & "Min. zoom: " & .MinZoom & vbCrLf & "Max.
zoom: " & .MaxZoom, vbOKCancel)
End With
If vbCancel = iAnswer Then Exit For
Next objSingleLayer
End Sub
See also
Layer Object (Page 2005)
Editing Layers with VBA (Page 1666)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2329
VBA for Automated Configuration
3.6 VBA Reference
MCGUBackColorOff-Eigenschaft
Description
In the case of the GroupDisplay object, defines or returns the background color for the "Went
Out Unacknowledged" status when the flash status is "Off". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color when the flash status is "Off" will be set to "Red":
Sub GroupDisplayConfiguration()
'VBA621
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCGUBackColorOff = RGB(255, 0, 0)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
MCGUBackColorOn Property
Description
In the case of the GroupDisplay object, defines or returns the background color for the "Went
Out Unacknowledged" status when the flash status is "On". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2330 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color when the flash status is "On" will be set to "White":
Sub GroupDisplayConfiguration()
'VBA622
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCGUBackColorOn = RGB(255, 255, 255)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
MCGUBackFlash Property
Description
TRUE if the background to the GroupDisplay object is to flash when a message goes out
unacknowledged. BOOLEAN write-read access.
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color is to flash when a message goes out unacknowledged:
Sub GroupDisplayConfiguration()
'VBA623
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCGUBackFlash = True
End With
End Sub
See also
GroupDisplay Object (Page 1985)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2331
VBA for Automated Configuration
3.6 VBA Reference
MCGUTextColorOff Property
Description
In the case of the GroupDisplay object, defines or returns the text color for the "Went Out
Unacknowledged" status when the flash status is "Off". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color to the text when the flash status is "Off" will be set to
"Blue":
Sub GroupDisplayConfiguration()
'VBA624
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCGUTextColorOff = RGB(0, 0, 255)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
MCGUTextColorOn Property
Description
In the case of the GroupDisplay object, defines or returns the background color to the text for
the "Went Out Unacknowledged" status when the flash status is "On". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2332 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color to the text when the flash status is "On" will be set to
"Black":
Sub GroupDisplayConfiguration()
'VBA625
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCGUTextColorOn = RGB(0, 0, 0)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
MCGUTextFlash Property
Description
TRUE if the font for the GroupDisplay object is to flash when a message goes out
unacknowledged. BOOLEAN write-read access.
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the font is to flash when a message goes out unacknowledged:
Sub GroupDisplayConfiguration()
'VBA626
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCGUTextFlash = True
End With
End Sub
See also
GroupDisplay Object (Page 1985)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2333
VBA for Automated Configuration
3.6 VBA Reference
MCKOBackColorOff Property
Description
In the case of the GroupDisplay object, defines or returns the background color for the "Came
In" status when the flash status is "Off". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color when the flash status is "Off" will be set to "Red":
Sub GroupDisplayConfiguration()
'VBA627
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCKOBackColorOff = RGB(255, 0, 0)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
MCKOBackColorOn Property
Description
In the case of the GroupDisplay object, defines or returns the background color for the "Came
In" status when the flash status is "On". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2334 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color when the flash status is "On" will be set to "White":
Sub GroupDisplayConfiguration()
'VBA628
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCKOBackColorOn = RGB(255, 255, 255)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
MCKOBackFlash Property
Description
TRUE if the background to the GroupDisplay object is to flash when a message goes out
unacknowledged. BOOLEAN write-read access.
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color is to flash when a message goes out unacknowledged:
Sub GroupDisplayConfiguration()
'VBA629
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCKOBackFlash = True
End With
End Sub
See also
GroupDisplay Object (Page 1985)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2335
VBA for Automated Configuration
3.6 VBA Reference
MCKOTextColorOff Property
Description
In the case of the GroupDisplay object, defines or returns the text color for the "Came In" status
when the flash status is "Off". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color to the text when the flash status is "Off" will be set to
"Blue":
Sub GroupDisplayConfiguration()
'VBA630
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCKOTextColorOff = RGB(0, 0, 255)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
MCKOTextColorOn Property
Description
In the case of the GroupDisplay object, defines or returns the background color to the text for
the "Came In" status when the flash status is "On". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2336 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color to the text when the flash status is "On" will be set to
"Black":
Sub GroupDisplayConfiguration()
'VBA631
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCKOTextColorOn = RGB(0, 0, 0)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
MCKOTextFlash Property
Description
TRUE if the font for the GroupDisplay object is to flash when a message goes out
unacknowledged. BOOLEAN write-read access.
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the font is to flash when a message goes out unacknowledged:
Sub GroupDisplayConfiguration()
'VBA632
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCKOTextFlash = True
End With
End Sub
See also
GroupDisplay Object (Page 1985)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2337
VBA for Automated Configuration
3.6 VBA Reference
MCKQBackColorOff Property
Description
In the case of the GroupDisplay object, defines or returns the background color for the "Went
Out Acknowledged" status when the flash status is "Off". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color when the flash status is "Off" will be set to "Red":
Sub GroupDisplayConfiguration()
'VBA633
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCKQBackColorOff = RGB(255, 0, 0)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
MCKQBackColorOn Property
Description
In the case of the GroupDisplay object, defines or returns the background color for the "Went
Out Acknowledged" status when the flash status is "On". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2338 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color when the flash status is "On" will be set to "White":
Sub GroupDisplayConfiguration()
'VBA634
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCKQBackColorOn = RGB(255, 255, 255)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
MCKQBackFlash Property
Description
TRUE if the background to the GroupDisplay object is to flash when a message goes out
acknowledged. BOOLEAN write-read access.
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color is to flash when a message goes out unacknowledged:
Sub GroupDisplayConfiguration()
'VBA635
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCKQBackFlash = True
End With
End Sub
See also
GroupDisplay Object (Page 1985)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2339
VBA for Automated Configuration
3.6 VBA Reference
MCKQTextColorOff Property
Description
In the case of the GroupDisplay object, defines or returns the text color for the "Went Out
Acknowledged" status when the flash status is "Off". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color to the text when the flash status is "Off" will be set to
"Blue":
Sub GroupDisplayConfiguration()
'VBA636
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCKQTextColorOff = RGB(0, 0, 255)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
MCKQTextColorOn Property
Description
In the case of the GroupDisplay object, defines or returns the background color to the text for
the "Went Out Acknowledged" status when the flash status is "On". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
2340 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color to the text when the flash status is "On" will be set to
"Black":
Sub GroupDisplayConfiguration()
'VBA637
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCKQTextColorOn = RGB(0, 0, 0)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
MCKQTextFlash Property
Description
TRUE if the font for the GroupDisplay object is to flash when a message goes out
acknowledged. BOOLEAN write-read access.
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the font is to flash when a message goes out unacknowledged:
Sub GroupDisplayConfiguration()
'VBA638
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MCKQTextFlash = True
End With
End Sub
See also
GroupDisplay Object (Page 1985)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2341
VBA for Automated Configuration
3.6 VBA Reference
MCText Property
Description
Defines or returns the label for the appropriate message class in the case of the GroupDisplay
object.
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the label for the "Alarm High" message class will be set to "Alarm High":
Sub GroupDisplayConfiguration()
'VBA639
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MessageClass = 0
.MCText = "Alarm High"
End With
End Sub
See also
MessageClass Property (Page 2345)
GroupDisplay Object (Page 1985)
MenuItems Property
Description
Returns a listing containing all the menu entries in the user-defined menu.
WinCC: Scripting (VBS, ANSI-C, VBA)
2342 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "CreateMenuItem()" procedure creates the "Delete Objects" menu and adds two menu
entries ("Delete Rectangles" and "Delete Circles"). In this example the labels will then be output:
Sub CreateMenuItem()
'VBA640
Dim objMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Dim iIndex As Integer
iIndex = 1
'
'Add new menu "Delete objects" to the menubar:
Set objMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DeleteObjects", "Delete objects")
'
'Add two menuitems to menu "Delete objects"
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(1, "DeleteAllRectangles", "Delete
rectangles")
Set objMenuItem = objMenu.MenuItems.InsertMenuItem(2, "DeleteAllCircles", "Delete circles")
'
'Output label of menu:
MsgBox ActiveDocument.CustomMenus(1).Label
'
'Output labels of all menuitems:
For iIndex = 1 To objMenu.MenuItems.Count
MsgBox objMenu.MenuItems(iIndex).Label
Next iIndex
End Sub
See also
Menu Object (Page 2013)
MenuItem Object (Page 2017)
MenuItemType Property
Description
Returns the type for a user-defined menu entry. Read only access.
Returned Value Type of Menu Entry
0 Separator (Separator)
1 Submenu (SubMenu)
2 Menu Entry (MenuItem)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2343
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ShowMenuTypes()" procedure outputs the types for the menu entries in the first user-
defined menu:
Sub ShowMenuTypes()
'VBA641
Dim iMaxMenuItems As Integer
Dim iMenuItemType As Integer
Dim strMenuItemType As String
Dim iIndex As Integer
iMaxMenuItems = ActiveDocument.CustomMenus(1).MenuItems.Count
For iIndex = 1 To iMaxMenuItems
iMenuItemType = ActiveDocument.CustomMenus(1).MenuItems(iIndex).MenuItemType
Select Case iMenuItemType
Case 0
strMenuItemType = "Trennstrich (Separator)"
Case 1
strMenuItemType = "Untermenü (SubMenu)"
Case 2
strMenuItemType = "Menüeintrag (MenuItem)"
End Select
MsgBox iIndex & ". Menuitemtype: " & strMenuItemType
Next iIndex
End Sub
See also
MenuItem Object (Page 2017)
Menu Object (Page 2013)
MenuToolBarConfig Property
Description
Specifies the configuration file with the user-defined menu and toolbars for the
"HMIPictureWindow" object or returns the name of the configuration file. STRING write-read
access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2344 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
MessageClass Property
Description
Specifies the respective message type (Alarm High, Alarm Low, Warning High, Warning Low,
etc.) for which the attribute settings "Display Text", "Came In", "Came In Acknowledged" and
"Went Out Unacknowledged" are configured for the "GroupDisplay" and
"AdvancedAnalogDisplay" objects.
MessageClass Assigned Value
AlarmHigh 0
AlarmLow 1
WarningHigh 2
WarningLow 3
Tolerance High 4
Tolerance Low 5
AS Control System Fault 6
AS Process Control Error 7
OS Process Control Error 8
Example
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the background color for the "AlarmHigh" message type when the flash status
is "Off" will be set to "Red":
Sub GroupDisplayConfiguration()
'VBA642
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.MessageClass = 0
.MCGUBackColorOff = RGB(255, 0, 0)
End With
End Sub
See also
GroupDisplay Object (Page 1985)
Min Property
Description
Defines or returns the absolute value in the case of the smallest value display.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2345
VBA for Automated Configuration
3.6 VBA Reference
This value is displayed if the scale display is active.
Example:
The "BarGraphConfiguration()" procedure configures In this example the absolute value will
be set to "1".
Sub BarGraphConfiguration()
'VBA643
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.Min = 1
End With
End Sub
See also
Slider object (Page 2066)
BarGraph Object (Page 1920)
3DBarGraph Object (Page 1900)
MinZoom Property
Description
Defines or returns the minimum zoom level for the layer.
WinCC: Scripting (VBS, ANSI-C, VBA)
2346 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "LayerInfo()" procedure outputs the name and zoom configuration for each layer of the
current picture:
Sub LayerInfo()
'VBA644
Dim colLayers As HMILayers
Dim objLayer As HMILayer
Dim strMaxZoom As String
Dim strMinZoom As String
Dim strLayerName As String
Dim iAnswer As Integer
Set colLayers = ActiveDocument.Layers
For Each objLayer In colLayers
With objLayer
strMinZoom = .MinZoom
strMaxZoom = .MaxZoom
strLayerName = .Name
iAnswer = MsgBox("Layername: " & strLayerName & vbCrLf & "Min. zoom: " & strMinZoom &
vbCrLf & "Max. zoom: " & strMaxZoom, vbOKCancel)
End With
If vbCancel = iAnswer Then Exit For
Next objLayer
End Sub
See also
Layer Object (Page 2005)
Editing Layers with VBA (Page 1666)
Modified Property
Description
TRUE if the source code for a script or picture has been changed. BOOLEAN read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2347
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example a check will be made on whether the active picture has been changed:
Sub CheckModificationOfActiveDocument()
'VBA645
Dim strCheck As String
Dim bModified As Boolean
bModified = ActiveDocument.Modified
Select Case bModified
Case True
strCheck = "Active document is modified"
Case False
strCheck = "Active document is not modified"
End Select
MsgBox strCheck
End Sub
See also
ScriptInfo Object (Page 2062)
Document Object (Page 1954)
Moveable Property
Description
TRUE if the ApplicationWindow and PictureWindow objects can be moved in Runtime.
BOOLEAN write-read access.
Example:
The "ApplicationWindowConfig" procedure accesses the properties of the application window.
In this example it shall be possible to move the application window in Runtime:
Sub ApplicationWindowConfig()
'VBA646
Dim objAppWindow As HMIApplicationWindow
Set objAppWindow = ActiveDocument.HMIObjects.AddHMIObject("AppWindow1",
"HMIApplicationWindow")
With objAppWindow
.Moveable = True
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2348 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
PictureWindow Object (Page 2033)
ApplicationWindow Object (Page 1917)
N-O
Name Property
Description
Returns the name of the object. STRING read access.
Example:
The "LayerInfo()" procedure outputs the name and zoom configuration for each layer of the
current picture:
Sub LayerInfo()
'VBA647
Dim colLayers As HMILayers
Dim objLayer As HMILayer
Dim strMaxZoom As String
Dim strMinZoom As String
Dim strLayerName As String
Dim iAnswer As Integer
Set colLayers = ActiveDocument.Layers
For Each objLayer In colLayers
With objLayer
strMinZoom = .MinZoom
strMaxZoom = .MaxZoom
strLayerName = .Name
iAnswer = MsgBox("Layername: " & strLayerName & vbCrLf & "Min. zoom: " & strMinZoom &
vbCrLf & "Max. zoom: " & strMaxZoom, vbOKCancel)
End With
If vbCancel = iAnswer Then Exit For
Next objLayer
End Sub
See also
Trigger Object (Page 2096)
SymbolLibrary Object (Page 2084)
Property Object (Page 2046)
HMIObject Object (Page 1992)
Layer Object (Page 2005)
FolderItem Object (Page 1977)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2349
VBA for Automated Configuration
3.6 VBA Reference
Document Object (Page 1954)
Application Object (Page 1915)
Name Property (FolderItem)
Description
Returns the internal name of the specified object of the "FolderItem" type. Read only access.
Example:
In this example the internal name is output for the "PC" object contained in the Global
Components Library:
Sub ShowInternalNameOfFolderItem()
'VBA536
Dim objGlobalLib As HMISymbolLibrary
Set objGlobalLib = Application.SymbolLibraries(1)
MsgBox objGlobalLib.FolderItems(2).Folder(2).Folder.Item(1).Name
End Sub
See also
FolderItem Object (Page 1977)
Accessing the component library with VBA (Page 1650)
NegativeValue Property
Description
Use the BinaryResultInfo property to return the BinaryResultInfo object.
WinCC: Scripting (VBS, ANSI-C, VBA)
2350 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog, a tag name will be assigned and the associated property values will be assigned to
both the binary value ranges:
Sub AddDynamicDialogToCircleRadiusTypeBinary()
'VBA648
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_C", "HMICircle")
Set objDynDialog = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'NewDynamic1'")
With objDynDialog
.ResultType = hmiResultTypeBool
.BinaryResultInfo.NegativeValue = 20
.BinaryResultInfo.PositiveValue = 40
End With
End Sub
See also
VBA Reference (Page 1752)
PositiveValue Property (Page 2384)
BinaryResultInfo Object (Page 1924)
NibbleSelect property
Description
Only used internally.
See also
AdvancedStateDisplay object (Page 1911)
Number Property
Description
Returns the layer number of a "Layer" type object. The counting starts with 1. The first layer,
"Layer0", returns the value "0". READ access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2351
VBA for Automated Configuration
3.6 VBA Reference
Example:
This example outputs the name, number and index of a layer:
Sub ShowLayerWithNumbers()
'VBA803
Dim colLayers As HMILayers
Dim objLayer As HMILayer
Dim iAnswer As Integer
Dim iIndex As Integer
iIndex = 1
Set colLayers = ActiveDocument.Layers
For Each objLayer In colLayers
iAnswer = MsgBox("Layername: " & objLayer.Name & vbCrLf & "Layernumber: " & objLayer.Number
& vbCrLf & "Layersindex: " & iIndex, vbOKCancel)
iIndex = iIndex + 1
If vbCancel = iAnswer Then Exit For
Next objLayer
End Sub
See also
Layer Object (Page 2005)
NumberLines Property
Description
TextList
Defines for the "TextList object" how many lines the selection list should contain or returns the
value. If the configured lines with their number, font size and font do not fit into the dimensions
of the object, a vertical scroll bar is added to the selection list.
Combo box and list box
Defines or returns the number of lines of text for the "Combo box" and "List box" objects. You
can define a maximum of 32,000 lines.
At the same time, the value of the "Number of rows" attribute specifies the high limit value for
the "Index" attribute in the "Font" property group. Changing the value can have the following
effects:
● Increasing the number: New lines are added at the bottom. The default labeling of the new
filed can be changed using the "Text" attribute in the "Font" property group.
● Reducing the number: All lines are removed for which the value of the "Index" attribute is
higher than the new number.
WinCC: Scripting (VBS, ANSI-C, VBA)
2352 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example
The "TextListConfiguration()" procedure accesses the properties of the "TextList" object. In
this example a selection list is created and the number of visible lines is set to three:
Sub TextListConfiguration()
'VBA649
Dim objTextList As HMITextList
'
'Insert new TextList in current picture:
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.NumberLines=3
End With
End Sub
See also
TextList Object (Page 2085)
ObjectName Property
Description
Depending on the source and destination object types for the direct connection, either defines
or returns the name of the constant, object or tag.
The two tables show you when you must use the ObjectName property. A "--" means that the
property is assigned an empty string (") by default when the DirectConnection object is created.
Source object type (SourceLink Property)
Type Property AutomationName Property ObjectName Property
hmiSourceTypeConstant -- Name of the constant (e.g. the
picture name)
hmiSourceTypeProperty Property of the source object Name of the source object (e.g.
(e.g. "Top") "Rectangle_A")
hmiSourceTypePropertyOfThi‐ -- --
sObject
hmiSourceTypeVariableDirect -- Tag name
hmiSourceTypeVariableIndirect -- Tag name
Destination object type (DestinationLink Property)
Type Property AutomationName Property ObjectName Property
hmiDestTypeProperty Property of the destination ob‐ Name of the destination object
ject (e.g. "Left") (e.g. "Rectangle_A")
hmiDestTypePropertyOfThisObject -- --
hmiDestTypePropertyOfActual‐ Property of the destination ob‐ --
Window ject (e.g. "Left")
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2353
VBA for Automated Configuration
3.6 VBA Reference
Type Property AutomationName Property ObjectName Property
hmiDestTypeVariableDirect -- Tag name
hmiDestTypeVariableIndirect -- Tag name
hmiDestTypeDirectMessage -- Tag name
hmiDestTypeIndirectMessage -- Tag name
Example:
In the following example the X position of "Rectangle_A" is copied to the Y position of
"Rectangle_B" in Runtime by clicking on the button:
Sub DirectConnection()
'VBA650
Dim objButton As HMIButton
Dim objRectangleA As HMIRectangle
Dim objRectangleB As HMIRectangle
Dim objEvent As HMIEvent
Dim objDirConnection As HMIDirectConnection
Set objRectangleA = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_A", "HMIRectangle")
Set objRectangleB = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_B", "HMIRectangle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objRectangleA
.Top = 100
.Left = 100
End With
With objRectangleB
.Top = 250
.Left = 400
.BackColor = RGB(255, 0, 0)
End With
With objButton
.Top = 10
.Left = 10
.Width = 100
.Text = "SetPosition"
End With
'
'Directconnection is initiated by mouseclick:
Set objDirConnection =
objButton.Events(1).Actions.AddAction(hmiActionCreationTypeDirectConnection)
With objDirConnection
'Sourceobject: Property "Top" of Rectangle_A
.SourceLink.Type = hmiSourceTypeProperty
.SourceLink.ObjectName = "Rectangle_A"
.SourceLink.AutomationName = "Top"
'
'Targetobject: Property "Left" of Rectangle_B
.DestinationLink.Type = hmiDestTypeProperty
.DestinationLink.ObjectName = "Rectangle_B"
.DestinationLink.AutomationName = "Left"
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2354 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
Type Property (Page 2453)
SourceLink Property (Page 2424)
DestinationLink Property (Page 2218)
AutomationName Property (Page 2133)
SourceLink Object (Page 2069)
DestLink Object (Page 1950)
ObjectSizeDecluttering Property
Description
TRUE, if objects of the specified picture outside of two configured sizes are to be faded out.
BOOLEAN write-read access.
Define the size range with the aid of the SetDeclutterObjectSize method.
Example:
In the following example the settings for the lowest layer are configured in the active picture:
Sub ConfigureSettingsOfLayer()
'VBA651
Dim objLayer As HMILayer
Set objLayer = ActiveDocument.Layers(1)
With objLayer
'Configure "Layer 0"
.MinZoom = 10
.MaxZoom = 100
.Name = "Configured with VBA"
End With
'Define fade-in and fade-out of objects:
With ActiveDocument
.LayerDecluttering = True
.ObjectSizeDecluttering = True
.SetDeclutterObjectSize 50, 100
End With
End Sub
See also
Document Object (Page 1954)
Editing Layers with VBA (Page 1666)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2355
VBA for Automated Configuration
3.6 VBA Reference
OffsetLeft Property
Description
Defines or returns the distance of the picture from the left edge of the picture window.
Example:
The "PictureWindowConfig" procedure accesses the properties of the picture window. In this
example the picture window will be configured
Sub PictureWindowConfig()
'VBA652
Dim objPicWindow As HMIPictureWindow
Set objPicWindow = ActiveDocument.HMIObjects.AddHMIObject("PicWindow1", "HMIPictureWindow")
With objPicWindow
.AdaptPicture = False
.AdaptSize = False
.Caption = True
.CaptionText = "Picturewindow in runtime"
.OffsetLeft = 5
.OffsetTop = 10
'Replace the picturename "Test.PDL" with the name of
'an existing document from your "GraCS"-Folder of your active project
.PictureName = "Test.PDL"
.ScrollBars = True
.ServerPrefix = ""
.TagPrefix = "Struct."
.UpdateCycle = 5
.Zoom = 100
End With
End Sub
See also
PictureWindow Object (Page 2033)
OffsetTop Property
Description
Defines or returns the distance of the picture from the top edge of the picture window.
WinCC: Scripting (VBS, ANSI-C, VBA)
2356 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "PictureWindowConfig" procedure accesses the properties of the picture window. In this
example the picture window will be configured
Sub PictureWindowConfig()
'VBA653
Dim objPicWindow As HMIPictureWindow
Set objPicWindow = ActiveDocument.HMIObjects.AddHMIObject("PicWindow1", "HMIPictureWindow")
With objPicWindow
.AdaptPicture = False
.AdaptSize = False
.Caption = True
.CaptionText = "Picturewindow in runtime"
.OffsetLeft = 5
.OffsetTop = 10
'Replace the picturename "Test.PDL" with the name of
'an existing document from your "GraCS"-Folder of your active project
.PictureName = "Test.PDL"
.ScrollBars = True
.ServerPrefix = ""
.TagPrefix = "Struct."
.UpdateCycle = 5
.Zoom = 100
End With
End Sub
See also
PictureWindow Object (Page 2033)
OnTop Property
Description
TRUE if the ApplicationWindow object is always in the foreground in Runtime. BOOLEAN write-
read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2357
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ApplicationWindowConfig" procedure accesses the properties of the application window.
In this example the application window will always be in the foreground in Runtime:
Sub ApplicationWindowConfig()
'VBA654
Dim objAppWindow As HMIApplicationWindow
Set objAppWindow = ActiveDocument.HMIObjects.AddHMIObject("AppWindow1",
"HMIApplicationWindow")
With objAppWindow
.OnTop = True
End With
End Sub
See also
ApplicationWindow Object (Page 1917)
Operation Property
Description
TRUE if the object can be used or operated in Runtime. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2358 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In this example the status of the operator-control enables will be output for all objects in the
active picture:
Sub ShowOperationStatusOfAllObjects()
'VBA655
Dim objObject As HMIObject
Dim bStatus As Boolean
Dim strStatus As String
Dim strName As String
Dim iMax As Integer
Dim iIndex As Integer
Dim iAnswer As Integer
iMax = ActiveDocument.HMIObjects.Count
iIndex = 1
For iIndex = 1 To iMax
strName = ActiveDocument.HMIObjects(iIndex).ObjectName
bStatus = ActiveDocument.HMIObjects(iIndex).Operation
Select Case bStatus
Case True
strStatus = "yes"
Case False
strStatus = "no"
End Select
iAnswer = MsgBox("Object: " & strName & vbCrLf & "Operator-Control enable: " & strStatus,
vbOKCancel)
If vbCancel = iAnswer Then Exit For
Next iIndex
If 0 = iMax Then MsgBox "No objects in the active document."
End Sub
See also
HMIObject Object (Page 1992)
Document Object (Page 1954)
OperationMessage Property
Description
TRUE, if a message should be output upon successful operation. The reason for the operation
can only be input if the "OperationReport" property is set to "True". BOOLEAN write-read
access.
The operation is sent to the message system, and is archived. Using the message system, a
message may be output in a message line, for example.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2359
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this
example, an operation is supposed to be sent to the message system:
Sub IOFieldConfiguration()
'VBA656
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.OperationReport = True
.OperationMessage = True
End With
End Sub
See also
OperationReport Property (Page 2360)
TextList Object (Page 2085)
Slider object (Page 2066)
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
CheckBox Object (Page 1930)
OperationReport Property
Description
TRUE, if the reason for an operation should be recorded. BOOLEAN write-read access.
When the object is used or operated in Runtime, a dialog opens in which the operator can
input the reason for the operation in the form of text. The operation is sent to the message
system, and is archived.
WinCC: Scripting (VBS, ANSI-C, VBA)
2360 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this
example, an operation is supposed to be sent to the message system:
Sub IOFieldConfiguration()
'VBA657
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.OperationReport = True
.OperationMessage = True
End With
End Sub
See also
OperationMessage Property (Page 2359)
TextList Object (Page 2085)
Slider object (Page 2066)
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
CheckBox Object (Page 1930)
Orientation Property
Description
TRUE, when the text in the object should be displayed horizontally. BOOLEAN write-read
access.
Note
It is only the text that is displayed either horizontally or vertically. The position of the object
remains unchanged.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2361
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the text will be displayed vertically:
Sub ButtonConfiguration()
'VBA658
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.Width = 150
.Height = 150
.Text = "Text is displayed vertical"
.Orientation = False
End With
End Sub
See also
TextList Object (Page 2085)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
IOField Object (Page 1996)
CheckBox Object (Page 1930)
Button Object (Page 1926)
OriginalPropertyName property
Description
Only used internally.
See also
FaceplateObjects object (Page 1976)
OutputFormat Property
Description
Defines how the output value shall be displayed, or returns the set value. The representation
is dependent on the data format.
WinCC: Scripting (VBS, ANSI-C, VBA)
2362 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this
example, data type "Decimal" will be set for the I/O field: The output value will be displayed
with two decimals and three digits to the right of the decimal point:
Sub IOFieldConfiguration()
'VBA659
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.DataFormat = 1
.OutputFormat = "99,999"
End With
End Sub
See also
DataFormat Property (Page 2216)
IOField Object (Page 1996)
OutputValue Property
Description
Defines or returns presetting for the value to be displayed.
This value is used in Runtime when the associated tag cannot be connected or updated when
a picture is started.
Example
The "IOFieldConfiguration()" procedure accesses the properties of the I/O field. In this
example, the output value is set to "0":
Sub IOFieldConfiguration()
'VBA660
Dim objIOField As HMIIOField
Set objIOField = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
With objIOField
.OutputValue = "0"
End With
End Sub
See also
TextList Object (Page 2085)
IOField Object (Page 1996)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2363
VBA for Automated Configuration
3.6 VBA Reference
OutputValue property
Description
Specifies the interconnection with any analog / text tag. The analog display represents the
value of this tag in the configured colors depending on the alarm state.
P-Q
PaintColor_QualityCodeBad property
Description
Defines the color in which the grid is shown when a poor status exists, for example, if the
connection to the server is interrupted.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
PaintColor_QualityCodeUnCertain property
Description
Defines the color with which the grid is shown in an uncertain status.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Parent Property
Description
Returns the higher-ranking object in the specified object. Read only access.
Example:
In the following example a copy of the active picture is created and the name of the picture is
then output with the aid of the Parent property:
WinCC: Scripting (VBS, ANSI-C, VBA)
2364 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Sub ExampleForParent()
'VBA661
Dim objView As HMIView
Set objView = ActiveDocument.Views.Add
MsgBox objView.Parent.Name
End Sub
See also
Toolbars Object (Listing) (Page 2090)
Menu Object (Page 2013)
Document Object (Page 1954)
Views Object (Listing) (Page 2112)
View Object (Page 2111)
VariableTriggers Object (Listing) (Page 2110)
VariableTrigger Object (Page 2108)
VariableStateValues Object (Listing) (Page 2106)
VariableStateValue Object (Page 2105)
Trigger Object (Page 2096)
ToolbarItems Object (Listing) (Page 2094)
ToolbarItem Object (Page 2092)
Toolbar Object (Page 2089)
TextList Object (Page 2085)
SymbolLibraries Object (Listing) (Page 2082)
SymbolLibrary Object (Page 2084)
StatusDisplay Object (Page 2074)
StaticText Object (Page 2071)
SourceLink Object (Page 2069)
Slider object (Page 2066)
SelectedObjects object (Listing) (Page 2063)
ScriptInfo Object (Page 2062)
RoundRectangle Object (Page 2059)
RoundButton Object (Page 2055)
Rectangle Object (Page 2053)
Properties Object (Listing) (Page 2045)
Property Object (Page 2046)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2365
VBA for Automated Configuration
3.6 VBA Reference
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
PictureWindow Object (Page 2033)
PieSegment Object (Page 2036)
OptionGroup Object (Page 2029)
OLEObject Object (Page 2027)
MenuItems Object (Listing) (Page 2019)
MenuItem Object (Page 2017)
Menus Object (Listing) (Page 2015)
Line Object (Page 2008)
Layers Object (Listing) (Page 2006)
Layer Object (Page 2005)
LanguageTexts Object (Listing) (Page 2004)
LanguageText Object (Page 2003)
LanguageFonts Object (Listing) (Page 2001)
LanguageFont Object (Page 2000)
IOField Object (Page 1996)
HMIObjects Object (Listing) (Page 1994)
HMIObject Object (Page 1992)
HMIDefaultObjects Object (Listing) (Page 1989)
GroupedObjects Object (Listing) (Page 1988)
GroupDisplay Object (Page 1985)
Group Object (Page 1983)
GraphicObject Object (Page 1980)
FolderItems Object (Listing) (Page 1978)
FolderItem Object (Page 1977)
Events Object (Listing) (Page 1972)
Event Object (Page 1971)
EllipseSegment Object (Page 1968)
EllipseArc Object (Page 1965)
Ellipse Object (Page 1962)
DynamicDialog Object (Page 1960)
Documents Object (Listing) (Page 1957)
DirectConnection Object (Page 1952)
DestLink Object (Page 1950)
WinCC: Scripting (VBS, ANSI-C, VBA)
2366 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
DataLanguages Object (Listing) (Page 1947)
DataLanguage Object (Page 1946)
CustomizedObject Object (Page 1943)
ConnectionPoints Object (Listing) (Page 1941)
CircularArc Object (Page 1936)
Circle Object (Page 1933)
CheckBox Object (Page 1930)
Button Object (Page 1926)
BitResultInfo Object (Page 1925)
BinaryResultInfo Object (Page 1924)
BarGraph Object (Page 1920)
ApplicationWindow Object (Page 1917)
Actions Object (Listing) (Page 1904)
3DBarGraph Object (Page 1900)
ParentCookie property
Description
Only used internally.
See also
FaceplateProperty object (Page 1976)
PasswordLevel Property
Description
Defines the authorization for operation (e.g. no input or no triggering actions) of the object.
PasswordLevel Assigned Value
<No Access Security> 0
User Administration 1
Value input 2
Process controlling 3
Picture editing 4
Screen change 5
Window selection 6
Hard copy 7
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2367
VBA for Automated Configuration
3.6 VBA Reference
PasswordLevel Assigned Value
Confirm alarms 8
Lock alarms 9
Free alarms 10
Message editing 11
Start archive 12
Stop archive 13
Edit archive values 14
Archive editing 15
Action editing 16
Project Manager 17
Activate remote 1000
Configure remote 1001
Just monitor 1002
You must first define the operator authorizations in the User Administrator.
Example:
--
See also
HMIObject Object (Page 1992)
Path Property
Description
Returns the full path of the folder in which the specified picture is stored. Read only access.
Example:
In this example the path to the folder of the active picture will be output:
Sub ShowDocumentPath()
'VBA663
MsgBox ActiveDocument.Path
End Sub
See also
Document Object (Page 1954)
WinCC: Scripting (VBS, ANSI-C, VBA)
2368 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Pathname Property
Description
Returns the internal access path to the Components Library for the specified object of the
"FolderItem" type. Read only access.
Example:
In this example the internal access path is output for the "PC" object contained in the Global
Components Library:
Sub ShowInternalNameOfFolderItem()
'VBA664
Dim objGlobalLib As HMISymbolLibrary
Set objGlobalLib = Application.SymbolLibraries(1)
MsgBox objGlobalLib.FolderItems(2).Folder(2).Folder.Item(1).PathName
End Sub
See also
FolderItem Object (Page 1977)
Accessing the component library with VBA (Page 1650)
PdlProtection property
Description
Sets a password for a process picture or faceplate type or deletes the password. Write access.
Note
Significance of the password protection
With the PdlProtection property, you can only assign a password to process pictures or
faceplate types to, for example, protect the VBA scripts contained in the pictures against
unauthorized access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2369
VBA for Automated Configuration
3.6 VBA Reference
Examples
In this example, a password is set for the active picture:
Sub ProtectPicture()
'VBA854
ActiveDocument.PdlProtection = "Test123"
End Sub
Password protection for the active picture is removed in this example:
Sub UnprotectPicture()
'VBA855
ActiveDocument.PdlProtection = ""
End Sub
Note
Write access only
Read access to the password is prevented due to security reasons.
PicDeactReferenced-Eigenschaft
Description
TRUE if the picture assigned to the "Deactivated" status is to be saved in the RoundButton
object. Otherwise, only the associated object reference is saved. BOOLEAN write-read access.
Example:
The "RoundButtonConfiguration()" procedure accesses the properties of the RoundButton. In
this example the picture assigned to the "Deactivated" status will be referenced:
Sub RoundButtonConfiguration()
'VBA665
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects.AddHMIObject("RButton1", "HMIRoundButton")
With objRoundButton
.PicDeactReferenced = False
End With
End Sub
See also
RoundButton Object (Page 2055)
WinCC: Scripting (VBS, ANSI-C, VBA)
2370 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
PicDeactTransparent Property
Description
Defines or returns which color of the bitmap object (.bmp, .dib) assigned to the "Disabled"
status should be set to "transparent". LONG write-read access.
The color is only set to "Transparent" if the value of the "PicDeactUseTransColor" property is
"True".
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "RoundButtonConfiguration()" procedure accesses the properties of the RoundButton. In
this example the color "Red" assigned in the Bitmap object is to be displayed transparent when
in the "Deactivated" status.
Sub RoundButtonConfiguration()
'VBA666
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects.AddHMIObject("RButton1", "HMIRoundButton")
With objRoundButton
.PicDeactTransparent = RGB(255, 0, 0)
.PicDeactUseTransColor = True
End With
End Sub
See also
PicDeactUseTransColor Property (Page 2371)
RoundButton Object (Page 2055)
PicDeactUseTransColor Property
Description
TRUE, when the transparent color defined by the "PicDeactTransparent" property for the
"Disable" status should be used. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2371
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "RoundButtonConfiguration()" procedure accesses the properties of the RoundButton. In
this example the color "Red" assigned in the Bitmap object is to be displayed transparent when
in the "Deactivated" status:
Sub RoundButtonConfiguration()
'VBA667
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects.AddHMIObject("RButton1", "HMIRoundButton")
With objRoundButton
.PicDeactTransparent = RGB(255, 0, 0)
.PicDeactUseTransColor = True
End With
End Sub
See also
PicDeactTransparent Property (Page 2371)
RoundButton Object (Page 2055)
PicDownReferenced Property
Description
TRUE if the picture assigned to the "On" status is to be saved in the RoundButton object.
Otherwise, only the associated object reference is saved. BOOLEAN write-read access.
Example:
The "RoundButtonConfiguration()" procedure accesses the properties of the RoundButton. In
this example the picture assigned to the "On" status will be referenced:
Sub RoundButtonConfiguration()
'VBA668
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects.AddHMIObject("RButton1", "HMIRoundButton")
With objRoundButton
.PicDownReferenced = False
End With
End Sub
See also
RoundButton Object (Page 2055)
WinCC: Scripting (VBS, ANSI-C, VBA)
2372 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
PicDownTransparent Property
Description
Defines or returns which color of the bitmap object (.bmp, .dib) assigned to the "On" status
should be set to "transparent". LONG write-read access.
The color is only set to "Transparent" if the value of the "PicDownUseTransColor" property is
"True".
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "RoundButtonConfiguration()" procedure accesses the properties of the RoundButton. In
this example the color "Yellow" assigned in the Bitmap object is to be displayed transparent
when in the "Deactivated" status.
Sub RoundButtonConfiguration()
'VBA669
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects.AddHMIObject("RButton1", "HMIRoundButton")
With objRoundButton
.PicDownTransparent = RGB(255, 255, 0)
.PicDownUseTransColor = True
End With
End Sub
See also
PicDownUseTransColor Property (Page 2373)
RoundButton Object (Page 2055)
PicDownUseTransColor Property
Description
TRUE, when the transparent color defined by the "PicDownTransparent" property for the "On"
status should be used. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2373
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "RoundButtonConfiguration()" procedure accesses the properties of the RoundButton. In
this example the color "Yellow" assigned in the Bitmap object is to be displayed transparent
when in the "Deactivated" status:
Sub RoundButtonConfiguration()
'VBA670
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects.AddHMIObject("RButton1", "HMIRoundButton")
With objRoundButton
.PicDownTransparent = RGB(255, 255, 0)
.PicDownUseTransColor = True
End With
End Sub
See also
PicDownTransparent Property (Page 2373)
RoundButton Object (Page 2055)
PicReferenced Property
Description
TRUE if the picture assigned to the GraphicObject object is to be referenced and not saved in
the object. BOOLEAN write-read access.
Example:
The "GraphicObjectConfiguration()" procedure accesses the properties of the graphics object.
In this example the assigned picture will be referenced:
Sub GraphicObjectConfiguration()
'VBA671
Dim objGraphicObject As HMIGraphicObject
Set objGraphicObject = ActiveDocument.HMIObjects.AddHMIObject("GraphicObject1",
"HMIGraphicObject")
With objGraphicObject
.PicReferenced = True
End With
End Sub
See also
GraphicObject Object (Page 1980)
WinCC: Scripting (VBS, ANSI-C, VBA)
2374 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
PictAlignment property
Description
As the "Picture alignment" attribute, it defines the position and scaling of the picture placed on
the button or round button.
centered The picture is positioned, centered in the original proportions.
Left justified The picture is positioned with original proportions, with left justification on
the left side of the button.
Right justified The picture is positioned with original proportions, with right justification on
the right side of the button.
Stretched The picture is scaled to a square and is adapted to the size of the button.
PicTransColor Property
Description
Defines or returns which color of the assigned bitmap object (.bmp, .dib) should be set to
"transparent". LONG write-read access.
The color is only set to "Transparent" if the value of the "PicUseTransColor" property is "True".
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "GraphicObjectConfiguration()" procedure accesses the properties of the graphics object.
In this example the color "Blue" assigned in the Bitmap object is to be displayed transparent:
Sub GraphicObjectConfiguration()
'VBA672
Dim objGraphicObject As HMIGraphicObject
Set objGraphicObject = ActiveDocument.HMIObjects.AddHMIObject("GraphicObject1",
"HMIGraphicObject")
With objGraphicObject
.PicTransColor = 16711680
.PicUseTransColor = True
End With
End Sub
See also
GraphicObject Object (Page 1980)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2375
VBA for Automated Configuration
3.6 VBA Reference
PictureDeactivated Property
Description
Defines the picture to be displayed in the "Disable" status or returns the picture name.
The picture (*.BMP or *.DIB) must be located in the "GraCS" directory of the current project
so that it can be integrated.
Example:
The "ButtonConfiguration()" procedure accesses the properties of the round button. In this
example the pictures for the "On" and "Off" states will be defined:
Sub ButtonConfiguration()
'VBA673
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects.AddHMIObject("RButton1", "HMIRoundButton")
With objRoundButton
'
'Toi use this example copy a Bitmap-Graphic
'to the "GraCS"-Folder of the actual project.
'Replace the picturename "TestPicture1.BMP" with the name of
'the picture you copied
.PictureDeactivated = "TestPicture1.BMP"
End With
End Sub
See also
RoundButton Object (Page 2055)
PicReferenced Property (Page 2374)
PictureDown Property
Description
Defines the picture to be displayed in the "On" status or returns the picture name.
The picture (*.BMP or *.DIB) must be located in the "GraCS" directory of the current project
so that it can be integrated.
WinCC: Scripting (VBS, ANSI-C, VBA)
2376 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ButtonConfiguration()" procedure accesses the properties of the round button. In this
example the pictures for the "On" and "Off" states will be defined:
Sub ButtonConfiguration()
'VBA674
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
'
'To use this example copy two Bitmap-Graphics
'to the "GraCS"-Folder of the actual project.
'Replace the picturenames "TestPicture1.BMP" and "TestPicture2.BMP"
'with the names of the pictures you copied
.PictureDown = "TestPicture1.BMP"
.PictureUp = "TestPicture2.BMP"
End With
End Sub
See also
RoundButton Object (Page 2055)
PictureName Property
Description
Defines the picture to be displayed in the picture window in Runtime or returns the picture
name.
The picture (*.BMP or *.DIB) must be located in the "GraCS" directory of the current project
so that it can be integrated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2377
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "PictureWindowConfig" procedure accesses the properties of the picture window. In this
example the picture window will be configured:
Sub PictureWindowConfig()
'VBA675
Dim objPicWindow As HMIPictureWindow
Set objPicWindow = ActiveDocument.HMIObjects.AddHMIObject("PicWindow1", "HMIPictureWindow")
With objPicWindow
.AdaptPicture = False
.AdaptSize = False
.Caption = True
.CaptionText = "Picturewindow in runtime"
.OffsetLeft = 5
.OffsetTop = 10
'Replace the picturename "Test.PDL" with the name of
'an existing document from your "GraCS"-Folder of your active project
.PictureName = "Test.PDL"
.ScrollBars = True
.ServerPrefix = ""
.TagPrefix = "Struct."
.UpdateCycle = 5
.Zoom = 100
End With
End Sub
See also
PictureWindow Object (Page 2033)
PictureUp Property
Description
Defines the picture to be displayed in the "Off" status or returns the picture name.
The picture (*.BMP or *.DIB) must be located in the "GraCS" directory of the current project
so that it can be integrated.
WinCC: Scripting (VBS, ANSI-C, VBA)
2378 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the pictures for the "On" and "Off" states will be defined:
Sub ButtonConfiguration()
'VBA676
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
'
'To use this example copy two Bitmap-Graphics
'to the "GraCS"-Folder of the actual project.
'Replace the picturenames "TestPicture1.BMP" and "TestPicture2.BMP"
'with the names of the pictures you copied
.PictureDown = "TestPicture1.BMP"
.PictureUp = "TestPicture2.BMP"
End With
End Sub
See also
RoundButton Object (Page 2055)
Button Object (Page 1926)
PicUpReferenced Property
Description
TRUE if the picture assigned to the "Off" status is to be saved in the RoundButton object.
Otherwise, only the associated object reference is saved. BOOLEAN write-read access.
Example:
The "RoundButtonConfiguration()" procedure accesses the properties of the RoundButton. In
this example the picture assigned to the "Off" status will be referenced:
Sub RoundButtonConfiguration()
'VBA677
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects.AddHMIObject("RButton1", "HMIRoundButton")
With objRoundButton
.PicUpReferenced = False
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2379
VBA for Automated Configuration
3.6 VBA Reference
See also
RoundButton Object (Page 2055)
PicUpTransparent Property
Description
Defines or returns which color of the bitmap object (.bmp, .dib) assigned to the "Off" status
should be set to "transparent". LONG write-read access.
The color is only set to "Transparent" if the value of the "PicUpUseTransColor" property is
"True".
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "RoundButtonConfiguration()" procedure accesses the properties of the RoundButton. In
this example the color "Blue" assigned in the Bitmap object is to be displayed transparent in
the status "Off".
Sub RoundButtonConfiguration()
'VBA678
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects.AddHMIObject("RButton1", "HMIRoundButton")
With objRoundButton
.PicUpTransparent = RGB(0, 0, 255)
.PicUpUseTransColor = True
End With
End Sub
See also
PicUpUseTransColor Property (Page 2380)
RoundButton Object (Page 2055)
PicUpUseTransColor Property
Description
TRUE, when the transparent color defined by the "PicUpTransparent" property for "Off" status
should be used. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2380 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "RoundButtonConfiguration()" procedure accesses the properties of the RoundButton. In
this example the color "Blue" assigned in the Bitmap object is to be displayed transparent in
the status "Off":
Sub RoundButtonConfiguration()
'VBA679
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects.AddHMIObject("RButton1", "HMIRoundButton")
With objRoundButton
.PicUpTransparent = RGB(0, 0, 255)
.PicUpUseTransColor = True
End With
End Sub
See also
PicUpTransparent Property (Page 2380)
RoundButton Object (Page 2055)
PicUseTransColor Property
Description
TRUE if the transparent color defined with the "PicTransColor" property is to be used for the
"Deactivated" status. BOOLEAN write-read access.
Example:
The "GraphicObjectConfiguration()" procedure accesses the properties of the graphics object.
In this example the color "Blue" assigned in the Bitmap object is to be displayed transparent:
Sub GraphicObjectConfiguration()
'VBA680
Dim objGraphicObject As HMIGraphicObject
Set objGraphicObject = ActiveDocument.HMIObjects.AddHMIObject("GraphicObject1",
"HMIGraphicObject")
With objGraphicObject
.PicTransColor = RGB(0, 0, 255)
.PicUseTransColor = True
End With
End Sub
See also
PicTransColor Property (Page 2375)
GraphicObject Object (Page 1980)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2381
VBA for Automated Configuration
3.6 VBA Reference
Pinnable property
Description
Only used internally.
See also
PictureWindow Object (Page 2033)
Pinned property
Description
Only used internally.
See also
PictureWindow Object (Page 2033)
PointCount Property
Description
Defines or returns the number of corner points in the case of the Polygon and Polyline objects.
Each corner point has position coordinates and is identified via an index.
WinCC: Scripting (VBS, ANSI-C, VBA)
2382 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
For this example to work, insert a polyline called "Polyline1" into the active picture: The
"PolyLineCoordsOutput" procedure then outputs the coordinates of all the corner points in the
polyline:
Sub PolyLineCoordsOutput()
'VBA681
Dim iPcIndex As Integer
Dim iPosX As Integer
Dim iPosY As Integer
Dim iIndex As Integer
Dim objPolyLine As HMIPolyLine
Set objPolyLine = Application.ActiveDocument.HMIObjects.AddHMIObject("PolyLine1",
"HMIPolyLine")
'
'Determine number of corners from "PolyLine1":
iPcIndex = objPolyLine.PointCount
'
'Output of x/y-coordinates from every corner:
For iIndex = 1 To iPcIndex
With objPolyLine
.index = iIndex
iPosX = .ActualPointLeft
iPosY = .ActualPointTop
MsgBox iIndex & ". corner:" & vbCrLf & "x-coordinate: " & iPosX & vbCrLf & "y-coordinate:
" & iPosY
End With
Next iIndex
End Sub
List of links
See also
Index Property (Page 2283)
ActualPointTop Property (Page 2119)
ActualPointLeft Property (Page 2118)
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
Position Property
Description
The value for position determines the sequence, in which menu entries and icons are assigned
in user-defined menus and toolbars or how user-defined menus are arranged in the menu bar.
Write/Read access.
A value of "1" means position 1 (start).
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2383
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the position of all menu entries in the first user-defined menu in the
active picture will be output: So that this example will work, first carry out the example shown
under the heading "InsertSubMenu".
Sub ShowPositionOfCustomMenuItems()
'VBA683
Dim objMenu As HMIMenu
Dim iMaxMenuItems As Integer
Dim iPosition As Integer
Dim iIndex As Integer
Set objMenu = ActiveDocument.CustomMenus(1)
iMaxMenuItems = objMenu.MenuItems.Count
For iIndex = 1 To iMaxMenuItems
iPosition = objMenu.MenuItems(iIndex).Position
MsgBox "Position of the " & iIndex & ". menuitem: " & iPosition
Next iIndex
End Sub
See also
ToolbarItem Object (Page 2092)
MenuItem Object (Page 2017)
Menu Object (Page 2013)
InsertSubmenu Method (Page 1860)
PositiveValue Property
Description
Defines the value for the dynamic property if the configured tag returns a non-zero value, or
returns the value.
WinCC: Scripting (VBS, ANSI-C, VBA)
2384 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
Use the BinaryResultInfo property to return the BinaryResultInfo object. In the following
example the radius of a circle will be dynamically configured using the Dynamic dialog, a tag
name will be assigned and the associated property values will be assigned to both the binary
value ranges:
Sub AddDynamicDialogToCircleRadiusTypeBool()
'VBA684
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_C", "HMICircle")
Set objDynDialog = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'NewDynamic1'")
With objDynDialog
.ResultType = hmiResultTypeBool
.BinaryResultInfo.NegativeValue = 20
.BinaryResultInfo.PositiveValue = 40
End With
End Sub
See also
NegativeValue Property (Page 2350)
BinaryResultInfo Object (Page 1924)
VBA Reference (Page 1752)
PredefinedAngels Property
Description
Defines or returns the depth of the display of the 3DBarGraph object. Value range from 0 to 3.
Display Assigned Value
Cavalier 0
Isometric 1
Axonometric 2
Freely Defined 3
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2385
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example the depth display will be set to "Isometric":
Sub HMI3DBarGraphConfiguration()
'VBA685
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
'Depth-angle a = 15 degrees
.AngleAlpha = 15
.PredefinedAngles = 1
'Depth-angle b = 45 degrees
.AngleBeta = 45
End With
End Sub
See also
3DBarGraph Object (Page 1900)
Pressed Property
Description
TRUE, when the Button or RoundButton object is pressed. BOOLEAN write-read access.
Example:
The "RoundButtonConfiguration()" procedure accesses the properties of the RoundButton. In
this example the RoundButton object will be set to "Pressed":
Sub RoundButtonConfiguration()
'VBA686
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects.AddHMIObject("RButton1", "HMIRoundButton")
With objRoundButton
.Pressed = True
End With
End Sub
See also
RoundButton Object (Page 2055)
WinCC: Scripting (VBS, ANSI-C, VBA)
2386 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
PrioAlarm..Warning property
Description
Specifies the priority at one of the following states or message types:
● Alarm
● Warning
● Tolerance
● AS Process Control Error
● AS Control System Fault
● Operator request
PrioBit16..31 property
Description
The property indicates the priority of the respective bit in the group value for the alarm
evaluation for the advanced analog and status display. The alarm evaluation starts at the
highest priority (priority 1). Bits that are not used for the alarm evaluation are assigned priority
0.
If the group value contains multiple bits, the priority determines which status is displayed.
Process Property
Description
Defines or returns presetting for the value to be displayed.
This value is used in Runtime when the associated tag cannot be connected or updated when
a picture is started.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2387
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "HMI3DBarGraphConfiguration()" procedure accesses the properties of the 3DBarGraph
object. In this example the default value will be set to "100":
Sub HMI3DBarGraphConfiguration()
'VBA687
Dim obj3DBar As HMI3DBarGraph
Set obj3DBar = ActiveDocument.HMIObjects.AddHMIObject("3DBar1", "HMI3DBarGraph")
With obj3DBar
'Depth-angle a = 15 degrees
.AngleAlpha = 15
'Depth-angle b = 45 degrees
.AngleBeta = 45
.Process = 100
End With
End Sub
See also
Slider object (Page 2066)
OptionGroup Object (Page 2029)
CheckBox Object (Page 1930)
BarGraph Object (Page 1920)
3DBarGraph Object (Page 1900)
Process property
Description
Here the first tag is stored that is used for status value calculation for the
"HMIAdvancedStateDisplay" object.
Use the "BitPosition0..3" properties to specify the bit position of these tags that is taken into
account for the status value calculation. This results in the statuses to which you can then
assign pictures.
Process1 property
Description
Here the second tag is stored that is used for status value calculation for the
"HMIAdvancedStateDisplay" object.
Use the "BitPosition0..3" properties to specify the bit position of these tags that is taken into
account for the status value calculation. This results in the statuses to which you can then
assign pictures.
WinCC: Scripting (VBS, ANSI-C, VBA)
2388 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Process2 property
Description
Here the third tag is stored that is used for status value calculation for the
"HMIAdvancedStateDisplay" object.
Use the "BitPosition0..3" properties to specify the bit position of these tags that is taken into
account for the status value calculation. This results in the statuses to which you can then
assign pictures.
Process3 property
Description
Here the fourth tag is stored that is used for status value calculation for the
"HMIAdvancedStateDisplay" object.
Use the "BitPosition0..3" properties to specify the bit position of these tags that is taken into
account for the status value calculation. This results in the statuses to which you can then
assign pictures.
ProfileName Property
Description
Returns the name of the specified application. Read only access.
Example:
In this example the name of the "Graphics Designer" application will be output:
Sub ShowProfileName()
'VBA688
MsgBox Application.ProfileName
End Sub
See also
Application Object (Page 1915)
ProgID Property
Description
Returns the ProgID of an ActiveX Control. STRING read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2389
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the ActiveX Control "WinCC Gauge Control" is inserted in the active
picture. The ProgID is then output:
Sub AddActiveXControl()
'VBA689
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
MsgBox "ProgID of ActiveX-control: " & .HMIObjects("WinCC_Gauge").ProgID
End With
End Sub
See also
ActiveXControl Object (Page 1906)
AddActiveXControl Method (Page 1802)
ProjectName Property
Description
Returns the project name. Read access.
Example:
In this example the name and type of the loaded project will be output.
Sub ShowProjectInfo()
'VBA690
Dim iProjectType As Integer
Dim strProjectName As String
Dim strProjectType As String
iProjectType = Application.ProjectType
strProjectName = Application.ProjectName
Select Case iProjectType
Case 0
strProjectType = "Single-User System"
Case 1
strProjectType = "Multi-User System"
Case 2
strProjectType = "Client System"
End Select
MsgBox "Projecttype: " & strProjectType & vbCrLf & "Projectname: " & strProjectName
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2390 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
Application Object (Page 1915)
ProjectType Property
Description
Returns the project type. Value range from 0 to 2. Read access.
Project type Assigned Value
Single-user project 0
Multi-user project 1
client project 2
Example:
In this example the name and type of the loaded project will be output:
Sub ShowProjectInfo()
'VBA691
Dim iProjectType As Integer
Dim strProjectName As String
Dim strProjectType As String
iProjectType = Application.ProjectType
strProjectName = Application.ProjectName
Select Case iProjectType
Case 0
strProjectType = "Single-User System"
Case 1
strProjectType = "Multi-User System"
Case 2
strProjectType = "Client System"
End Select
MsgBox "Projecttype: " & strProjectType & vbCrLf & "Projectname: " & strProjectName
End Sub
See also
Application Object (Page 1915)
Properties Property
Description
Returns a Properties listing containing all the properties of the specified object. Read only
access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2391
VBA for Automated Configuration
3.6 VBA Reference
To return an element from the Properties listing you can use either the index number or the
name of the VBA property.
You must use the Properties property if, for example, you wish to access the properties of
objects located in a group object.
Example:
Examples showing how to use the Properties property can be found in this documentation
under the following headings:
● "Editing Objects with VBA"
● "Group objects"
● "Customized Objects"
See also
HMIObject Object (Page 1992)
Customized Objects (Page 1690)
Group Objects (Page 1682)
Editing Objects with VBA (Page 1670)
Prototype Property
Description
Returns the function heading of a script. The function heading is assigned by default if no
source code is configured.
WinCC: Scripting (VBS, ANSI-C, VBA)
2392 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example a button and a circle will be inserted in the active picture. In Runtime
the radius of the circle will enlarge every time you click the button. In this case only the prototype
of the VB script is output:
Sub ExampleForPrototype()
'VBA692
Dim objButton As HMIButton
Dim objCircleA As HMICircle
Dim objEvent As HMIEvent
Dim objVBScript As HMIScriptInfo
Set objCircleA = ActiveDocument.HMIObjects.AddHMIObject("CircleA", "HMICircle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objCircleA
.Top = 100
.Left = 100
End With
With objButton
.Top = 10
.Left = 10
.Width = 200
.Text = "Increase Radius"
End With
'On every mouseclick the radius have to increase:
Set objEvent = objButton.Events(1)
Set objVBScript = objButton.Events(1).Actions.AddAction(hmiActionCreationTypeVBScript)
MsgBox objVBScript.Prototype
End Sub
See also
ScriptInfo Object (Page 2062)
QualityCodeStateChecked Properties
Description
TRUE, if the quality code of the specified tag is used in Dynamic dialog for dynamization.
BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2393
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle is given dynamics with the Dynamization uses
the analysis of the quality code of a tag. If the tag fails to return a quality code, a substitute
value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA816
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
DynamicDialog Object (Page 1960)
WinCC: Scripting (VBS, ANSI-C, VBA)
2394 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
QualityCodeStateValues Property
Description
Returns the QualityCodeStateValues listing. Use the QualityCodeStateValues property with
the Item property to assign a value to the quality code status to be used for dynamization.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2395
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA817
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
DynamicDialog Object (Page 1960)
QualityCodeStateValues Object (Listing) (Page 2050)
WinCC: Scripting (VBS, ANSI-C, VBA)
2396 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Radius Property
Description
Defines or returns the radius in the case of the following objects:
● Circle: Radius in pixels (0 to 10000)
● CircularArc: Radius in pixels (0 to 10000)
● PieSegment: Radius in pixels (0 to 10000)
● RoundButton: Radius in pixels (0 to 10000)
Example:
The "PieSegmentConfiguration()" procedure accesses the properties of the Pie Segment. In
this example the radius will be set to "80":
Sub PieSegmentConfiguration()
'VBA693
Dim objPieSegment As HMIPieSegment
Set objPieSegment = ActiveDocument.HMIObjects.AddHMIObject("PieSegment1", "HMIPieSegment")
With objPieSegment
.StartAngle = 40
.EndAngle = 180
.Radius = 80
End With
End Sub
See also
RoundButton Object (Page 2055)
PieSegment Object (Page 2036)
CircularArc Object (Page 1936)
Circle Object (Page 1933)
RadiusHeight Property
Description
Defines or returns the vertical radius in pixels (0 to 5000) in the case of elliptical objects (Ellipse,
EllipseArc, EllipseSegment).
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2397
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "EllipseConfiguration()" procedure accesses the properties of the ellipse object. In this
example the horizontal radius will be set to "60":
Sub EllipseConfiguration()
'VBA694
Dim objEllipse As HMIEllipse
Set objEllipse = ActiveDocument.HMIObjects.AddHMIObject("Ellipse1", "HMIEllipse")
With objEllipse
.RadiusHeight = 60
.RadiusWidth = 40
End With
End Sub
See also
RadiusWidth Property (Page 2398)
EllipseSegment Object (Page 1968)
EllipseArc Object (Page 1965)
Ellipse Object (Page 1962)
RadiusWidth Property
Description
Defines or returns the horizontal radius in pixels (0 to 5000) in the case of elliptical objects
(Ellipse, EllipseArc, EllipseSegment).
Example:
The "EllipseConfiguration()" procedure accesses the properties of the ellipse object. In this
example the horizontal radius will be set to "40":
Sub EllipseConfiguration()
'VBA695
Dim objEllipse As HMIEllipse
Set objEllipse = ActiveDocument.HMIObjects.AddHMIObject("Ellipse1", "HMIEllipse")
With objEllipse
.RadiusHeight = 60
.RadiusWidth = 40
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2398 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
RadiusHeight Property (Page 2397)
EllipseSegment Object (Page 1968)
EllipseArc Object (Page 1965)
Ellipse Object (Page 1962)
RangeTo Property
Description
Defines or returns the analog value range.
Example:
An example showing how to use the RangeTo property can be found in this documentation
under the heading "AnalogResultInfos Object (Listing)".
See also
Value Property (Page 2472)
AnalogResultInfos Object (Listing) (Page 1914)
AnalogResultInfo Object (Page 1913)
ReferenceRotationLeft Property
Description
Defines or returns the X-coordinate of the reference point about which the object should be
rotated in Runtime.
The value of the X-coordinate is relative to the object width. Enter the value in percent starting
from the left edge of the rectangle enclosing the object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2399
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "PolyLineConfiguration()" procedure accesses the properties of the PolyLine object. In
this example, the coordinates of the reference point will be set to 50% of the object width and
50% of the object height:
Sub PolyLineConfiguration()
'VBA696
Dim objPolyLine As HMIPolyLine
Set objPolyLine = ActiveDocument.HMIObjects.AddHMIObject("PolyLine1", "HMIPolyLine")
With objPolyLine
.ReferenceRotationLeft = 50
.ReferenceRotationTop = 50
End With
End Sub
See also
RotationAngle Property (Page 2403)
ReferenceRotationTop Property (Page 2400)
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
Line Object (Page 2008)
ReferenceRotationTop Property
Description
Defines or returns the Y-coordinate of the reference point about which the object should be
rotated in Runtime.
The value of the Y-coordinate is relative to the object width. Enter the value in percent starting
from the top edge of the rectangle enclosing the object.
WinCC: Scripting (VBS, ANSI-C, VBA)
2400 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "PolyLineConfiguration()" procedure accesses the properties of the PolyLine object. In
this example, the coordinates of the reference point will be set to 50% of the object width and
50% of the object height:
Sub PolyLineConfiguration()
'VBA697
Dim objPolyLine As HMIPolyLine
Set objPolyLine = ActiveDocument.HMIObjects.AddHMIObject("PolyLine1", "HMIPolyLine")
With objPolyLine
.ReferenceRotationLeft = 50
.ReferenceRotationTop = 50
End With
End Sub
See also
RotationAngle Property (Page 2403)
ReferenceRotationLeft Property (Page 2399)
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
Line Object (Page 2008)
Relevant Property
Description
TRUE when the "GroupDisplay", "AdvancedAnalogDisplay" or "AdvancedStateDisplay" object
is taken into account when forming the group display. BOOLEAN write-read access.
Example
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example the object for forming the group display will be considered:
Sub GroupDisplayConfiguration()
'VBA698
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.Relevant = True
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2401
VBA for Automated Configuration
3.6 VBA Reference
See also
Group Object (Page 1983)
ResultType Property
Description
Defines or returns the value range evaluation type in the Dynamic dialog.
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog, a tag name will be assigned and the associated property values will be assigned to
both the binary value ranges:
Sub AddDynamicDialogToCircleRadiusTypeBinary()
'VBA699
Dim objDynDialog As HMIDynamicDialog
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_C", "HMICircle")
Set objDynDialog = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'NewDynamic1'")
With objDynDialog
.ResultType = hmiResultTypeBool
.BinaryResultInfo.NegativeValue = 20
.BinaryResultInfo.PositiveValue = 40
End With
End Sub
See also
DynamicDialog Object (Page 1960)
RightComma Property
Description
Defines or returns the number of decimal places (0 to 20) for the BarGraph object.
WinCC: Scripting (VBS, ANSI-C, VBA)
2402 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphConfiguration()" procedure configures In this example the number of decimal
places will be limited to 4.
Sub BarGraphConfiguration()
'VBA700
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.RightComma = 4
End With
End Sub
See also
BarGraph Object (Page 1920)
RotationAngle Property
Description
Line, Polygon and PolyLine
Defines or returns the rotation angle of the following objects in degrees: Line, Polygon,
PolyLine.
The object is displayed in Runtime only rotated clockwise around the reference point by the
specified value (starting from the configured starting position).
T-piece
Defines or returns the orientation of a T-piece in degrees. The attribute can only assume one
of four values:
0 The standard position of the T-piece is the shape of the letter "T"
90 The "leg" of the "T" points towards the left
180 The "leg" of the "T" points upwards
270 The "leg" of the "T" points to the right
Other values are automatically converted to modulus 360 and rounded up or down to the
nearest permissible value.
The T-piece is shown rotated around the center point in the project and in Runtime.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2403
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "PolyLineConfiguration()" procedure accesses the properties of the PolyLine object. In
this example the object will be rotated by 45° in Runtime:
Sub PolyLineConfiguration()
'VBA701
Dim objPolyLine As HMIPolyLine
Set objPolyLine = ActiveDocument.HMIObjects.AddHMIObject("PolyLine1", "HMIPolyLine")
With objPolyLine
.ReferenceRotationLeft = 50
.ReferenceRotationTop = 50
.RotationAngle = 45
End With
End Sub
See also
ReferenceRotationTop Property (Page 2400)
ReferenceRotationLeft Property (Page 2399)
PolyLine Object (Page 2042)
Polygon Object (Page 2039)
Line Object (Page 2008)
RoundCornerHeight Property
Description
Defines or returns the corner radius of the RoundRectangle object.
Enter the value as a percentage of half the height of the object.
Example:
The "RoundRectangleConfiguration()" procedure accesses the properties of the object
RoundRectangle. In this example the corner radius will be set to 25% (height) and 50% (width).
Sub RoundRectangleConfiguration()
'VBA702
Dim objRoundRectangle As HMIRoundRectangle
Set objRoundRectangle = ActiveDocument.HMIObjects.AddHMIObject("RoundRectangle1",
"HMIRoundRectangle")
With objRoundRectangle
.RoundCornerHeight = 25
.RoundCornerWidth = 50
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2404 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
RoundCornerWidth Property (Page 2405)
RoundRectangle Object (Page 2059)
RoundCornerWidth Property
Description
Defines or returns the corner radius of the RoundRectangle object.
Enter the value as a percentage of half the width of the object.
Example:
The "RoundRectangleConfiguration()" procedure accesses the properties of the object
RoundRectangle. In this example the corner radius will be set to 25% (height) and 50% (width):
Sub RoundRectangleConfiguration()
'VBA703
Dim objRoundRectangle As HMIRoundRectangle
Set objRoundRectangle = ActiveDocument.HMIObjects.AddHMIObject("RoundRectangle1",
"HMIRoundRectangle")
With objRoundRectangle
.RoundCornerHeight = 25
.RoundCornerWidth = 50
End With
End Sub
See also
RoundCornerHeight Property (Page 2404)
RoundRectangle Object (Page 2059)
SameSize Property
Description
TRUE, when all four buttons of a Group Display object have the same size. BOOLEAN write-
read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2405
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example all four buttons will have the same size.
Sub GroupDisplayConfiguration()
'VBA704
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.SameSize = True
End With
End Sub
See also
GroupDisplay Object (Page 1985)
ScaleColor Property
Description
Defines or returns the color of the scale. LONG write-read access.
The "Scaling" property must be set to TRUE for the color to be displayed.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "BarGraphConfiguration()" procedure configures In this example the scale will be
displayed and the scale color will be set to "Red":
Sub BarGraphConfiguration()
'VBA705
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.Scaling = True
.ScaleColor = RGB(255, 0, 0)
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2406 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
Scaling Property (Page 2407)
BarGraph Object (Page 1920)
ScaleTicks Property
Description
Defines or returns the number of scale sections for the BarGraph object.
A scale section is a part of the scale bounded by two long scale strokes or division ticks. If you
assign a value of "0" to the property, the appropriate scale marks will be calculated
automatically.
Example:
The "BarGraphConfiguration()" procedure configures In this example the number of scale
sections will be set to "10".
Sub BarGraphConfiguration()
'VBA706
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.Scaling = True
.ScaleTicks = 10
End With
End Sub
See also
BarGraph Object (Page 1920)
Scaling Property
Description
TRUE if a scale is also used to display the values in the case of the BarGraph object. BOOLEAN
write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2407
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphConfiguration()" procedure configures the properties of the BarGraph object.
In this example the scale will be displayed and the scale color will be set to "Red":
Sub BarGraphConfiguration()
'VBA707
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.Scaling = True
.ScaleColor = RGB(255, 0, 0)
End With
End Sub
See also
BarGraph Object (Page 1920)
ScalingMode property
Description
Defines the size to display the objects of the faceplate instance.
Default Like scaling mode "proportional"
1:1 The faceplate type is displayed in the original size in the faceplate instance. If
the faceplate instance is too small, the size of the faceplate instance is adapted
to the size of the faceplate type.
Proportional The faceplate type is scaled in proportion with the size of the faceplate instance.
Example
ScalingType Property
Description
Defines or returns the type of bar scaling. Value range from 0 to 2.
WinCC: Scripting (VBS, ANSI-C, VBA)
2408 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
The "Scaling" property must be set to TRUE for the color to be displayed.
Bar Scaling Assigned Value
Linear 0
Logarithmic 1
Automatic 2
Example:
The "BarGraphConfiguration()" procedure configures In this example the bar scaling will be
set to "Linear":
Sub BarGraphConfiguration()
'VBA708
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.ScalingType = 0
.Scaling = True
End With
End Sub
See also
Scaling Property (Page 2407)
BarGraph Object (Page 1920)
ScriptType Property
Description
Returns the script type (C or VBS) which was used to make a property or event dynamic. Read
only access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2409
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example a button and a circle will be inserted in the active picture. In Runtime
the radius of the circle will enlarge every time you click the button. In this case the script type
will be output:
Sub ExampleForPrototype()
'VBA709
Dim objButton As HMIButton
Dim objCircleA As HMICircle
Dim objEvent As HMIEvent
Dim objVBScript As HMIScriptInfo
Dim strScriptType As String
Set objCircleA = ActiveDocument.HMIObjects.AddHMIObject("CircleA", "HMICircle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objCircleA
.Top = 100
.Left = 100
End With
With objButton
.Top = 10
.Left = 10
.Width = 200
.Text = "Increase Radius"
End With
'On every mouseclick the radius have to increase:
Set objEvent = objButton.Events(1)
Set objVBScript = objButton.Events(1).Actions.AddAction(hmiActionCreationTypeVBScript)
Select Case objVBScript.ScriptType
Case 0
strScriptType = "VB script is used"
Case 1
strScriptType = "C-Skript is used"
End Select
MsgBox strScriptType
End Sub
See also
ScriptInfo Object (Page 2062)
ScrollBars Property
Description
TRUE if the picture window has scroll bars in Runtime. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2410 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "PictureWindowConfig" procedure accesses the properties of the picture window. In this
example the picture window will be configured:
Sub PictureWindowConfig()
'VBA710
Dim objPicWindow As HMIPictureWindow
Set objPicWindow = ActiveDocument.HMIObjects.AddHMIObject("PicWindow1", "HMIPictureWindow")
With objPicWindow
.AdaptPicture = False
.AdaptSize = False
.Caption = True
.CaptionText = "Picturewindow in runtime"
.OffsetLeft = 5
.OffsetTop = 10
'Replace the picturename "Test.PDL" with the name of
'an existing document from your "GraCS"-Folder of your active project
.PictureName = "Test.PDL"
.ScrollBars = True
.ServerPrefix = ""
.TagPrefix = "Struct."
.UpdateCycle = 5
.Zoom = 100
End With
End Sub
See also
PictureWindow Object (Page 2033)
ScrollPositionX Property
Description
Specifies the horizontal positioning of the scroll bar in a picture window with slider, or returns
its value.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2411
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "PictureWindowConfig" procedure accesses the properties of the picture window. In this
example the picture window will be configured:
Sub PictureWindowConfig()
'VBA808
Dim objPicWindow As HMIPictureWindow
Set objPicWindow = ActiveDocument.HMIObjects.AddHMIObject("PicWindow1", "HMIPictureWindow")
With objPicWindow
.AdaptPicture = False
.AdaptSize = False
.Caption = True
.CaptionText = "Picturewindow in runtime"
.OffsetLeft = 5
.OffsetTop = 10
'Replace the picturename "Test.PDL" with the name of
'an existing document from your "GraCS"-Folder of your active project
.PictureName = "Test.PDL"
.ScrollBars = True
.ScrollPositionX = 50
.ScrollPositionY = 50
.ServerPrefix = ""
.TagPrefix = "Struct."
.UpdateCycle = 5
.Zoom = 100
End With
End Sub
See also
PictureWindow Object (Page 2033)
ScrollPositionY Property
Description
Specifies the vertical positioning of the scroll bar in a picture window with slider, or returns its
value.
WinCC: Scripting (VBS, ANSI-C, VBA)
2412 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "PictureWindowConfig" procedure accesses the properties of the picture window. In this
example the picture window will be configured:
Sub PictureWindowConfig()
'VBA809
Dim objPicWindow As HMIPictureWindow
Set objPicWindow = ActiveDocument.HMIObjects.AddHMIObject("PicWindow1", "HMIPictureWindow")
With objPicWindow
.AdaptPicture = False
.AdaptSize = False
.Caption = True
.CaptionText = "Picturewindow in runtime"
.OffsetLeft = 5
.OffsetTop = 10
'Replace the picturename "Test.PDL" with the name of
'an existing document from your "GraCS"-Folder of your active project
.PictureName = "Test.PDL"
.ScrollBars = True
.ScrollPositionX = 50
.ScrollPositionY = 50
.ServerPrefix = ""
.TagPrefix = "Struct."
.UpdateCycle = 5
.Zoom = 100
End With
End Sub
See also
PictureWindow Object (Page 2033)
ScrollPosX Property
Description
Defines or returns the X position of the scroll bars for the View object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2413
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example a copy of the active picture is created and then activated. The position
of the scroll bars will be set to 40 (X) and 10 (Y):
Sub CreateViewAndActivateView()
Dim objView As HMIView
Set objView = ActiveDocument.Views.Add
objView.Activate
objView.ScrollPosX = 40
objView.ScrollPosY = 10
End Sub
See also
ScrollPosY Property (Page 2414)
View Object (Page 2111)
ScrollPosY Property
Description
Defines or returns the Y position of the scroll bars for the View object.
Example:
In the following example a copy of the active picture is created and then activated. The position
of the scroll bars will be set to 40 (X) and 10 (Y):
Sub CreateViewAndActivateView()
Dim objView As HMIView
Set objView = ActiveDocument.Views.Add
objView.Activate
objView.ScrollPosX = 40
objView.ScrollPosY = 10
End Sub
See also
ScrollPosX Property (Page 2413)
View Object (Page 2111)
WinCC: Scripting (VBS, ANSI-C, VBA)
2414 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
SelBGColor Property
Description
Defines or returns the background color for the selected entry in the case of the TextList object.
LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the background color for the selected entry will be set to "Red":
Sub TextListConfiguration()
Dim objTextList As HMITextList
'
'Neue TextListe ins aktuelle Bild einfügen:
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.SelBGColor = RGB (255, 0, 0)
End With
End Sub
See also
TextList Object (Page 2085)
Selected Property
Description
TRUE if an object is selected in the picture. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2415
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example two new objects will be inserted in the active picture and then selected:
Sub SelectObjects()
'VBA714
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
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!"
End Sub
See also
HMIObject Object (Page 1992)
Selection Property
Description
Returns a listing containing all the objects selected in the specified picture.
To return an element from the Selection listing you can use either the index number or the
object name.
You can use the Selection property, for example, to select all the objects in the picture.
Example:
In the following example all the objects in the active picture are selected:
Sub SelectAllObjectsInActiveDocument()
'VBA715
ActiveDocument.Selection.SelectAll
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2416 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
SelectedObjects object (Listing) (Page 2063)
Document Object (Page 1954)
SelIndex property
Description
Defines or returns the index of which the associated text is highlighted in the combobox or list
box.
SelText property
Description
Shows the text defined with the "SelIndex" property which is highlighted in the ComboBox or
ListBox object. You cannot directly change the "Selected text" attribute. You change the
"Selected text" attribute by changing the "Selected box" attribute or the text itself in the "Font"
properties group.
SelTextColor Property
Description
Defines or returns the text color for the selected entry in the TextList object. LONG write-read
access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2417
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the text color for the selected entry will be set to "Yellow":
Sub TextListConfiguration()
'VBA716
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.SelTextColor = RGB(255, 255, 0)
End With
End Sub
See also
TextList Object (Page 2085)
ServerName Property
Description
Returns the name of the specified ActiveX Control or of the embedded object. Read only
access.
Example
In the following example the ActiveX Control "WinCC Gauge Control" will be inserted in the
active picture and the name of the ActiveX Control will be output:
Sub AddActiveXControl()
'VBA717
Dim objActiveXControl As HMIActiveXControl
Set objActiveXControl = ActiveDocument.HMIObjects.AddActiveXControl("WinCC_Gauge",
"XGAUGE.XGaugeCtrl.1")
With objActiveXControl
.Top = 40
.Left = 60
MsgBox .Properties("ServerName").value
End With
End Sub
See also
ActiveXControl Object (Page 1906)
WinCC: Scripting (VBS, ANSI-C, VBA)
2418 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
ServerPrefix Property
Description
Defines the server which will hold the picture that is displayed in the picture window in Runtime,
or returns the name of the server.
Enter the server name followed by two colons: "<Servername>::". No check is made as to
whether the server actually exists.
Example:
The "PictureWindowConfig" procedure accesses the properties of the picture window. In this
example the picture window will be configured:
Sub PictureWindowConfig()
'VBA718
Dim objPicWindow As HMIPictureWindow
Set objPicWindow = ActiveDocument.HMIObjects.AddHMIObject("PicWindow1", "HMIPictureWindow")
With objPicWindow
.AdaptPicture = False
.AdaptSize = False
.Caption = True
.CaptionText = "Picturewindow in runtime"
.OffsetLeft = 5
.OffsetTop = 10
'Replace the picturename "Test.PDL" with the name of
'an existing document from your "GraCS"-Folder of your active project
.PictureName = "Test.PDL"
.ScrollBars = True
.ServerPrefix = "my_Server::"
.TagPrefix = "Struct."
.UpdateCycle = 5
.Zoom = 100
End With
End Sub
See also
PictureWindow Object (Page 2033)
ShortCut Property
Description
Defines or returns a shortcut key sequence for a user-defined menu entry or user-defined icon.
The following keys are permitted in combination with <CTRL>, <ALT> and <SHIFT>:
● Function keys <F1> to <F12>
● The letter keys <A> to <Z> and the number keys <0> to <9>.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2419
VBA for Automated Configuration
3.6 VBA Reference
The following are not supported: the keys on the alphanumeric keypad, the cursor keys (e.g.
<Page Up>) and the remaining function keys such as <RETURN> and <ESC>. No distinction
is made upper and lower case. Key combinations with two or more letters or numbers are not
permitted, such as "CTRL+A+B", but the combination with two additional keys such as <CTRL
+ALT+A" is allowed.
Notes on using the ShortCut property
The key sequences used must be unique within the user-defined menus and toolbars in a
picture. Key sequences that you configure with VBA have priority over any key sequences that
may be present in the Graphics Designer. Within the user-defined menus and toolbars, picture-
specific key sequences have priority over application-specific key sequences.
Note
Shortcut key sequences are only executed if the menu entry or the icon is visible and active.
Example:
In the following example, a user-defined menu with two menus entries and a submenu with
two entries will be created in the active picture. The submenu will be visually distinguished by
a dividing line. The first menu entry receives the shortcut key sequence <CTRL+SHIFT+M>
for retrieval:
Sub CreateDocumentMenus()
'VBA719
Dim objDocMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Dim objSubMenu As HMIMenuItem
'
'Add menu to menubar:
Set objDocMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DocMenu1", "Doc_Menu_1")
'
'Add menuitems to the new menu:
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(1, "dmItem1_1", "&My first Menuitem")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(2, "dmItem1_2", "My second Menuitem")
'
'Add seperator to menu:
Set objMenuItem = objDocMenu.MenuItems.InsertSeparator(3, "dSeparator1_3")
'
'Add submenu to the menu:
Set objSubMenu = objDocMenu.MenuItems.InsertSubMenu(4, "dSubMenu1_4", "My first submenu")
'
'Add menuitems to the submenu:
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(5, "dmItem1_5", "My first submenuitem")
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(6, "dmItem1_6", "My second
submenuitem")
'
ActiveDocument.CustomMenus("DocMenu1").MenuItems(1).ShortCut = "CTRL+SHIFT+M"
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2420 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
Configuring Menus and Toolbars (Page 1630)
ToolbarItem Object (Page 2092)
MenuItem Object (Page 2017)
ShowBadTagState property
Description
Determines if the object is grayed out when a bad quality code or tag status is detected. At
both objects, "HMIAdvancedAnalogDisplay" and "HMIAdvancedStateAnalogDisplay", the
property is used to specify whether the settings for the "PaintColor_QualityCodeBad" and
"PaintColor_QualityCodeUnCertain" properties are used.
SignificantMask Property
Description
Needed in Runtime for displaying the active message class with the highest priority in the
GroupDisplay object.
The value of the SignificantMask property represents an internal system output value does not
require any specific configuration by the user. Updating takes place in Runtime by clicking on
the object.
Example:
--
See also
GroupDisplay Object (Page 1985)
Simulation property
Description
Specifies the interconnection with any tag that is used for simulation.
SimulationBit property
Description
Shows the bit position of the linked simulation tags that is used for evaluation.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2421
VBA for Automated Configuration
3.6 VBA Reference
The value of the simulation tag is only evaluated with the alarm status "OK".
Size Property
Description
Defines or returns the font size in points for a language-dependent font.
Example:
The following example sets the font attributes of a button for French and English:
Sub ExampleForLanguageFonts()
'VBA721
Dim colLangFonts As HMILanguageFonts
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
objButton.Text = "DefText"
Set colLangFonts = objButton.LDFonts
'
'Set font-properties for french:
With colLangFonts.ItemByLCID(1036)
.Family = "Courier New"
.Bold = True
.Italic = False
.Underlined = True
.Size = 12
End With
'
'Set font-properties for english:
With colLangFonts.ItemByLCID(1033)
.Family = "Times New Roman"
.Bold = False
.Italic = True
.Underlined = False
.Size = 14
End With
End Sub
See also
Underlined Property (Page 2463)
Parent Property (Page 2364)
LanguageID Property (Page 2296)
Italic Property (Page 2288)
Family Property (Page 2236)
Bold Property (Page 2158)
WinCC: Scripting (VBS, ANSI-C, VBA)
2422 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Application Property (Page 2129)
LanguageFont Object (Page 2000)
Sizeable Property
Description
TRUE if the size of the ApplicationWindow and PictureWindow objects can be changed in
Runtime. BOOLEAN write-read access.
Example:
The "ApplicationWindowConfig" procedure accesses the properties of the application window.
In this example it is intended that the application window can be resized in Runtime:
Sub ApplicationWindowConfig()
'VBA722
Dim objAppWindow As HMIApplicationWindow
Set objAppWindow = ActiveDocument.HMIObjects.AddHMIObject("AppWindow1",
"HMIApplicationWindow")
With objAppWindow
.Sizeable = True
End With
End Sub
See also
PictureWindow Object (Page 2033)
ApplicationWindow Object (Page 1917)
SmallChange Property
Description
Defines how many steps the controller can be moved with one mouse click or returns the value.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2423
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "SliderConfiguration()" procedure accesses the properties of the slider. In this example
the number of steps will be set to "4":
Sub SliderConfiguration()
'VBA723
Dim objSlider As HMISlider
Set objSlider = ActiveDocument.HMIObjects.AddHMIObject("SliderObject1", "HMISlider")
With objSlider
.SmallChange = 4
End With
End Sub
See also
Slider object (Page 2066)
SnapToGrid Property
Description
TRUE if objects in the picture are aligned on the grid (which is invisible). BOOLEAN write-read
access.
Example:
In the following example, the alignment of objects in the active picture on the grid is activated:
Sub ActivateSnapToGrid()
'VBA724
ActiveDocument.SnapToGrid = True
End Sub
See also
Document Object (Page 1954)
SourceLink Property
Description
Returns the Source object. Use the SourceLink property to configure the source object in the
case of a direct connection.
WinCC: Scripting (VBS, ANSI-C, VBA)
2424 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the X position of "Rectangle_A" is copied to the Y position of
"Rectangle_B" in Runtime by clicking on the button:
Sub DirectConnection()
'VBA725
Dim objButton As HMIButton
Dim objRectangleA As HMIRectangle
Dim objRectangleB As HMIRectangle
Dim objEvent As HMIEvent
Dim objDirConnection As HMIDirectConnection
Set objRectangleA = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_A", "HMIRectangle")
Set objRectangleB = ActiveDocument.HMIObjects.AddHMIObject("Rectangle_B", "HMIRectangle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objRectangleA
.Top = 100
.Left = 100
End With
With objRectangleB
.Top = 250
.Left = 400
.BackColor = RGB(255, 0, 0)
End With
With objButton
.Top = 10
.Left = 10
.Width = 100
.Text = "SetPosition"
End With
'
'Directconnection is initiated by mouseclick:
Set objDirConnection =
objButton.Events(1).Actions.AddAction(hmiActionCreationTypeDirectConnection)
With objDirConnection
'Sourceobject: Property "Top" of Rectangle_A
.SourceLink.Type = hmiSourceTypeProperty
.SourceLink.ObjectName = "Rectangle_A"
.SourceLink.AutomationName = "Top"
'
'Targetobject: Property "Left" of Rectangle_B
.DestinationLink.Type = hmiDestTypeProperty
.DestinationLink.ObjectName = "Rectangle_B"
.DestinationLink.AutomationName = "Left"
End With
End Sub
See also
Type Property (Page 2453)
ObjectName Property (Page 2353)
AutomationName Property (Page 2133)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2425
VBA for Automated Configuration
3.6 VBA Reference
SourceLink Object (Page 2069)
DirectConnection Object (Page 1952)
SourceCode Property
Description
Defines or returns the source code of a C script or VB script.
If you assign a C script to the SourceCode property, you must enter only the program code
located between the braces ("{}").
If you assign a VB script to the SourceCode property, you must enter only the program code
located between the Sub and EndSub keywords.
Note
If you use single quote marks (') or double quote marks (") in the program code, you must enter
an additional quote mark in front of every single or double quote mark so that the program
code can be correctly interpreted in the VBA editor.
The Compiled property returns TRUE if the source code was successfully compiled.
WinCC: Scripting (VBS, ANSI-C, VBA)
2426 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example a button and a circle will be inserted in the active picture. In Runtime
the radius of the circle will enlarge every time you click the button. A VB script will be used for
this purpose:
Sub IncreaseCircleRadiusWithVBScript()
'VBA726
Dim objButton As HMIButton
Dim objCircleA As HMICircle
Dim objEvent As HMIEvent
Dim objVBScript As HMIScriptInfo
Dim strCode As String
strCode = "Dim objCircle" & vbCrLf & "Set objCircle = "
strCode = strCode & "hmiRuntime.ActiveScreen.ScreenItems(""CircleVB"")"
strCode = strCode & vbCrLf & "objCircle.Radius = objCircle.Radius + 5"
Set objCircleA = ActiveDocument.HMIObjects.AddHMIObject("CircleVB", "HMICircle")
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
With objCircleA
.Top = 100
.Left = 100
End With
With objButton
.Top = 10
.Left = 10
.Width = 200
.Text = "Increase Radius"
End With
'
'On every mouseclick the radius have to increase:
Set objEvent = objButton.Events(1)
Set objVBScript = objButton.Events(1).Actions.AddAction(hmiActionCreationTypeVBScript)
objVBScript.SourceCode = strCode
Select Case objVBScript.Compiled
Case True
MsgBox "Compilation ok!"
Case False
MsgBox "Error on compilation!"
End Select
End Sub
See also
Compiled Property (Page 2204)
ScriptInfo Object (Page 2062)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2427
VBA for Automated Configuration
3.6 VBA Reference
StartAngle Property
Description
Defines or returns the start of the object for the CircularArc, EllipseArc, EllipseSegment and
PieSegment objects. The information is in counterclockwise direction in degrees, beginning at
the 12:00 clock position.
Example:
The "PieSegmentConfiguration()" procedure accesses the properties of the Pie Segment. In
this example the pie segment begins at 40° and ends at 180°:
Sub PieSegmentConfiguration()
'VBA727
Dim PieSegment As HMIPieSegment
Set PieSegment = ActiveDocument.HMIObjects.AddHMIObject("PieSegment1", "HMIPieSegment")
With PieSegment
.StartAngle = 40
.EndAngle = 180
End With
End Sub
See also
EndAngle Property (Page 2229)
PieSegment Object (Page 2036)
EllipseSegment Object (Page 1968)
EllipseArc Object (Page 1965)
CircularArc Object (Page 1936)
StatusText Property
Description
Defines or returns the text that will be displayed in the status bar when you point with the mouse
to a user-defined menu entry or user-defined icon.
WinCC: Scripting (VBS, ANSI-C, VBA)
2428 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example, a user-defined menu with two menus entries and a submenu with
two entries will be created in the active picture. The submenu will be visually distinguished by
a dividing line. A status bar entry will be defined for each menu entry:
Sub CreateDocumentMenus()
'VBA728
Dim objDocMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Dim objSubMenu As HMIMenuItem
'
'Add menu:
Set objDocMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DocMenu1", "Doc_Menu_1")
'
'Add menuitems to custom-menu:
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(1, "dmItem1_1", "My first menuitem")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(2, "dmItem1_2", "My second menuitem")
'
'Add seperator to custom-menu:
Set objMenuItem = objDocMenu.MenuItems.InsertSeparator(3, "dSeparator1_3")
'
'Add submenu to custom-menu:
Set objSubMenu = objDocMenu.MenuItems.InsertSubMenu(4, "dSubMenu1_4", "My first submenu")
'
'Add menuitems to submenu:
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(5, "dmItem1_5", "My first submenuitem")
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(6, "dmItem1_6", "My second
submenuitem")
'
'Assign statustexts to every menuitem
With objDocMenu
.MenuItems(1).StatusText = "My first menuitem"
.MenuItems(2).StatusText = "My second menuitem"
.MenuItems(4).SubMenu.Item(1).StatusText = "My first submenuitem"
.MenuItems(4).SubMenu.Item(2).StatusText = "My second submenuitem"
End With
End Sub
See also
ToolbarItem Object (Page 2092)
MenuItem Object (Page 2017)
SubMenu Property
Description
Returns a MenuItems listing if the specified object is the "SubMenu" type.
Use the SubMenu listing if you wish to create a submenu in a user-defined menu.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2429
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example, a user-defined menu with two menus entries and a submenu with
two entries will be created in the active picture. The submenu will be visually distinguished by
a dividing line:
Sub CreateDocumentMenus()
'VBA730
Dim objDocMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Dim objSubMenu As HMIMenuItem
'
'Add menu:
Set objDocMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DocMenu1", "Doc_Menu_1")
'
'Add menuitems to custom-menu:
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(1, "dmItem1_1", "My first menuitem")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(2, "dmItem1_2", "My second menuitem")
'
'Add seperator to custom-menu:
Set objMenuItem = objDocMenu.MenuItems.InsertSeparator(3, "dSeparator1_3")
'
'Add submenu to custom-menu:
Set objSubMenu = objDocMenu.MenuItems.InsertSubMenu(4, "dSubMenu1_4", "My first submenu")
'
'Add menuitems to submenu:
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(5, "dmItem1_5", "My first submenuitem")
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(6, "dmItem1_6", "My second
submenuitem")
End Sub
See also
MenuItem Object (Page 2017)
SymbolLibraries Property
Description
Returns a SymbolLibraries listing containing objects of the "SymbolLibrary" type.
Use SymbolLibraries(1) to return the "Global Library". Use SymbolLibraries(2) to return the
"Project Library".
WinCC: Scripting (VBS, ANSI-C, VBA)
2430 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the names of the libraries will be output:
Sub ShowSymbolLibraries()
'VBA731
Dim colSymbolLibraries As HMISymbolLibraries
Dim objSymbolLibrary As HMISymbolLibrary
Set colSymbolLibraries = Application.SymbolLibraries
For Each objSymbolLibrary In colSymbolLibraries
MsgBox objSymbolLibrary.Name
Next objSymbolLibrary
End Sub
See also
Application Object (Page 1915)
TabOrderAlpha Property
Description
Defines or returns the position of the object in the TAB sequence for the alpha / tab order
cursor.
Example:
In this example two I/O fields will be inserted in the active picture and the TAB sequence will
then be defined:
Sub IOFieldConfig()
'VBA734
Dim objIOField1 As HMIIOField
Dim objIOField2 As HMIIOField
Set objIOField1 = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
Set objIOField2 = ActiveDocument.HMIObjects.AddHMIObject("IOField2", "HMIIOField")
With objIOField1
.Top = 10
.Left = 10
.TabOrderAlpha = 1
End With
With objIOField2
.Top = 100
.Left = 10
.TabOrderAlpha = 2
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2431
VBA for Automated Configuration
3.6 VBA Reference
See also
Document Object (Page 1954)
TabOrderAllHMIObjects Property
Description
TRUE if all the objects in a picture are to be included in the configured TAB sequence.
BOOLEAN write-read access.
Example:
The "ConfigureTabOrder()" procedure defines which objects in the active picture are to be
included in the configured TAB sequence. In this example all the objects will be included in
the TAB sequence:
Sub ConfigureTabOrder()
'VBA733
With ActiveDocument
.TABOrderAllHMIObjects = True
.TABOrderKeyboard = False
.TABOrderMouse = False
.TABOrderOtherAction = False
End With
End Sub
See also
TabOrderOtherAction Property (Page 2434)
TabOrderMouse Property (Page 2433)
TabOrderKeyboard Property (Page 2432)
Document Object (Page 1954)
TabOrderKeyboard Property
Description
TRUE if objects with a keyboard operation event configured to them are to be included in the
configured TAB sequence. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2432 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "ConfigureTabOrder()" procedure defines which objects in the active picture are to be
included in the configured TAB sequence. In this example objects with a keyboard operation
will be included in the TAB sequence:
Sub ConfigureTabOrder()
'VBA735
With ActiveDocument
.TABOrderAllHMIObjects = True
.TABOrderKeyboard = False
.TABOrderMouse = False
.TABOrderOtherAction = False
End With
End Sub
See also
TabOrderOtherAction Property (Page 2434)
TabOrderMouse Property (Page 2433)
TabOrderAllHMIObjects Property (Page 2432)
Document Object (Page 1954)
TabOrderMouse Property
Description
TRUE if objects with a mouse operation event configured to them are to be included in the
configured TAB sequence. BOOLEAN write-read access.
Example:
The "ConfigureTabOrder()" procedure defines which objects in the active picture are to be
included in the configured TAB sequence. In this example objects with a mouse operation
event will be included in the TAB sequence:
Sub ConfigureTabOrder()
'VBA736
With ActiveDocument
.TABOrderAllHMIObjects = True
.TABOrderKeyboard = False
.TABOrderMouse = False
.TABOrderOtherAction = False
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2433
VBA for Automated Configuration
3.6 VBA Reference
See also
TabOrderOtherAction Property (Page 2434)
TabOrderKeyboard Property (Page 2432)
TabOrderAllHMIObjects Property (Page 2432)
Document Object (Page 1954)
TabOrderOtherAction Property
Description
TRUE if objects with an event other than a mouse or keyboard operation event configured to
them are to be included in the configured TAB sequence. BOOLEAN write-read access.
Example:
The "ConfigureTabOrder()" procedure defines which objects in the active picture are to be
included in the configured TAB sequence. In this example objects with events other than a
mouse or keyboard operation will be included in the TAB sequence:
Sub ConfigureTabOrder()
'VBA737
With ActiveDocument
.TABOrderAllHMIObjects = True
.TABOrderKeyboard = False
.TABOrderMouse = False
.TABOrderOtherAction = False
End With
End Sub
See also
TabOrderMouse Property (Page 2433)
TabOrderKeyboard Property (Page 2432)
TabOrderAllHMIObjects Property (Page 2432)
Document Object (Page 1954)
TabOrderSwitch Property
Description
Defines or returns the position of the object in the TAB sequence.
WinCC: Scripting (VBS, ANSI-C, VBA)
2434 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In this example two I/O fields will be inserted in the active picture and the TAB sequence will
then be defined:
Sub IOFieldConfig()
'VBA732
Dim objIOField1 As HMIIOField
Dim objIOField2 As HMIIOField
Set objIOField1 = ActiveDocument.HMIObjects.AddHMIObject("IOField1", "HMIIOField")
Set objIOField2 = ActiveDocument.HMIObjects.AddHMIObject("IOField2", "HMIIOField")
With objIOField1
.Top = 10
.Left = 10
.TabOrderSwitch = 1
End With
With objIOField2
.Top = 100
.Left = 10
.TabOrderSwitch = 2
End With
End Sub
See also
HMIObject Object (Page 1992)
Tag Property
Description
Defines or returns information text for a user-defined menu entry or user-defined icon. You
can use the Tag property for example to briefly describe what the menu entry does.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2435
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example, a user-defined menu with two menus entries and a submenu with
two entries will be created in the active picture. The submenu will be visually distinguished by
a dividing line:
Sub CreateDocumentMenus()
'VBA738
Dim objDocMenu As HMIMenu
Dim objMenuItem As HMIMenuItem
Dim objSubMenu As HMIMenuItem
'
'Add menu:
Set objDocMenu = ActiveDocument.CustomMenus.InsertMenu(1, "DocMenu1", "Doc_Menu_1")
'
'Add menuitems to custom-menu:
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(1, "dmItem1_1", "My first menuitem")
Set objMenuItem = objDocMenu.MenuItems.InsertMenuItem(2, "dmItem1_2", "My second menuitem")
'
'Add seperator to custom-menu:
Set objMenuItem = objDocMenu.MenuItems.InsertSeparator(3, "dSeparator1_3")
'
'Add submenu to custom-menu:
Set objSubMenu = objDocMenu.MenuItems.InsertSubMenu(4, "dSubMenu1_4", "My first submenu")
'
'Add menuitems to submenu:
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(5, "dmItem1_5", "My first submenuitem")
Set objMenuItem = objSubMenu.SubMenu.InsertMenuItem(6, "dmItem1_6", "My second
submenuitem")
'
'To place an additional information:
With objDocMenu
.MenuItems(1).Tag = "This is the first menuitem"
End With
End Sub
See also
ToolbarItem Object (Page 2092)
MenuItem Object (Page 2017)
Tag property (Graphic Object Update Wizard)
Description
Is used for the "Graphic Object Update Wizard" tool and is not evaluated for the
"HMIAdvancedAnalogDisplay" and "HMIAdvancedStateAnalogDisplay" objects.
WinCC: Scripting (VBS, ANSI-C, VBA)
2436 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
tagname property
Description
Is used for the "Graphic Object Update Wizard" tool and is not evaluated for the
"HMIAdvancedAnalogDisplay" and "HMIAdvancedStateAnalogDisplay" objects.
TagPrefix Property
Description
Defines or returns the tag prefix for all the tags contained in the Picture Window object.
Example:
The picture "InputOutput" is to be displayed in the picture window. The picture "InputOutput"
contains three I/O fields which are linked to a structure tag. The structure tag consists of the
elements EA1, EA2, EA3; one element each for each I/O field.
Three such structure tags have been define in the project, with structure names Struct1, Struct2
and Struct3.
The tag prefix is in this case the structure name followed by a period. Specify the tag prefix
as, say, Struct2. (the period is necessary in order to address the elements of the structure tag
as structure elements in a syntactically correct way). The I/O fields in the picture "InputOutput"
are then linked to the elements in structure tag Struct2:
Tag Prefix: "Struct2."
● Output value (first I/O field): EA1
● Output value (second I/O field): EA2
● Output value (third I/O field): EA3
The current tag connection in the picture window is then
● Output value (first I/O field): Struct2.EA1
● Output value (second I/O field): Struct2.EA2
● Output value (third I/O field): Struct2.EA3
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2437
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "PictureWindowConfig" procedure accesses the properties of the picture window. In this
example the picture window will be configured:
Sub PictureWindowConfig()
'VBA739
Dim objPicWindow As HMIPictureWindow
Set objPicWindow = ActiveDocument.HMIObjects.AddHMIObject("PicWindow1", "HMIPictureWindow")
With objPicWindow
.AdaptPicture = False
.AdaptSize = False
.Caption = True
.CaptionText = "Picturewindow in runtime"
.OffsetLeft = 5
.OffsetTop = 10
'Replace the picturename "Test.PDL" with the name of
'an existing document from your "GraCS"-Folder of your active project
.PictureName = "Test.PDL"
.ScrollBars = True
.ServerPrefix = "my_Server::"
.TagPrefix = "Struct."
.UpdateCycle = 5
.Zoom = 100
End With
End Sub
See also
PictureWindow Object (Page 2033)
TagScaleParam1 property
Description
Sets the value1 for the value range process.
TagScaleParam2 property
Description
Sets the value2 for the value range process.
TagScaleParam3 property
Description
Sets the value3 for the value range process.
WinCC: Scripting (VBS, ANSI-C, VBA)
2438 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
TagScaleParam4 property
Description
Sets the value4 for the value range process.
TagStartvaluePersistence property
Description
Defines whether an internal tag is set as persistent. You can only set internal tags as persistent.
tagtype property
Description
Is used for the "Graphic Object Update Wizard" tool and is not evaluated for the
"HMIAdvancedAnalogDisplay" and "HMIAdvancedStateAnalogDisplay" objects.
Template property
Description
Returns the template for displaying the window content of the "ApplicationWindow" object.
Read only access.
The "ApplicationWindow" object can be supplied from applications of the Global Script and the
report system:
GSC Diagnostics The application window is supplied by applications of the Global Script. The results of the diag‐
nostics system are displayed.
GSC Runtime The application window is supplied by applications of the Global Script. The analysis results
regarding characteristics in Runtime are displayed.
All Jobs The application window is supplied by the report system. The available reports are displayed as
a list.
All Jobs – Shortcut Menu The application window is supplied by the report system. The available reports are displayed as
a list. The shortcut menu enables the selection of print options, display of a print preview as well
as a printout of the report.
Job Detail View The application window is supplied by the report system. The available reports are displayed in
a selection menu. Detailed information is displayed for the selected report.
Selected Jobs - Shortcut The application window is supplied by the report system. The available reports are displayed as
Menu a list. This list only contains reports which you have activated the option "Mark for print job list"
in the "Print Job Properties" dialog. The shortcut menu enables the selection of print options,
display of a print preview as well as a printout of the report.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2439
VBA for Automated Configuration
3.6 VBA Reference
See also
ApplicationWindow Object (Page 1917)
Text Property
Description
Defines or returns the labeling for an object.
Example:
The "ButtonConfiguration()" procedure accesses the properties of the button. In this example
the label will be defined:
Sub ButtonConfiguration()
'VBA740
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("Button1", "HMIButton")
With objButton
.Text = "Button1"
End With
End Sub
See also
Button Object (Page 1926)
StaticText Object (Page 2071)
OptionGroup Object (Page 2029)
CheckBox Object (Page 1930)
TextBiblIDs property
Description
Only used internally.
See also
TextList Object (Page 2085)
WinCC: Scripting (VBS, ANSI-C, VBA)
2440 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Textlist property
Text list (Textlist)
You use the text list for the assignment of texts to specific tag values when configuring the
following objects:
● Smart objects: Combo box, list box, text list
● Windows objects: Check box, radio box
Enter the name of a text list that you have created in the "Text and Graphics Lists" editor in
the WinCC Configuration Studio.
The “Text list” attribute can be made dynamic with the name "Textlist".
Example
In the example the text list "ListTexts1" is assigned to the text list object "TextsObj1":
Sub TextList_Example()
'VBA911
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("TextsObj1",
"HMITextList")
objTextList.Properties("TextList") = "ListTexts1"
End Sub
See also
TextList Object (Page 2085)
OptionGroup Object (Page 2029)
ListBox object (Page 2010)
CheckBox Object (Page 1930)
ComboBox object (Page 1939)
TextListSort property
Sorting of the text list (TextListSort)
When you use a text list from the "Text and Graphic List" editor, you can specify the sorting of
texts for the WinCC object.
The attribute is only available for the "Text list" smart object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2441
VBA for Automated Configuration
3.6 VBA Reference
You can only use the property when a configured text list is linked in the object.
Value Sort Description
0 None Original sorting of the text list in the "Text and Graphic List" editor
1 Value Increasing in number according to configured value/range
2 Text Alphabetically from A to Z according to configured text
Example
The text list "ListTexts1" for the text list object "TextsObj1" is sorted by "Value":
Sub TextListConfiguration()
'VBA912
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("TextList1",
"HMITextList")
objTextList.Properties("TextListSort") = 1
End Sub
See also
TextList Object (Page 2085)
TitleBackColorActiveEnd property
Description
Only used internally.
See also
PictureWindow Object (Page 2033)
TitleBackColorActiveStart property
Description
Only used internally.
See also
PictureWindow Object (Page 2033)
WinCC: Scripting (VBS, ANSI-C, VBA)
2442 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
TitleBackColorInactiveEnd property
Description
Only used internally.
See also
PictureWindow Object (Page 2033)
TitleBackColorInactiveStart property
Description
Only used internally.
See also
PictureWindow Object (Page 2033)
TitleForeColorActive property
Description
Only used internally.
See also
PictureWindow Object (Page 2033)
TitleForeColorInactive property
Description
Only used internally.
See also
PictureWindow Object (Page 2033)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2443
VBA for Automated Configuration
3.6 VBA Reference
Toggle Property
Description
TRUE, if the button or round button should lock after being operated in Runtime. BOOLEAN
write-read access.
Example:
The "RoundButtonConfiguration()" procedure accesses the properties of the RoundButton. In
this example the round button is intended to latch down when pressed in Runtime:
Sub RoundButtonConfiguration()
'VBA741
Dim objRoundButton As HMIRoundButton
Set objRoundButton = ActiveDocument.HMIObjects.AddHMIObject("RButton1", "HMIRoundButton")
With objRoundButton
.Toggle = True
End With
End Sub
See also
RoundButton Object (Page 2055)
ToleranceHigh Property
Description
Defines or returns the limit value for "Tolerance high".
The type of the evaluation (in percent or absolute) is defined in the TypeToleranceHigh
property.
Monitoring of the limit value only takes effect when the CheckToleranceHigh property is set to
"True".
WinCC: Scripting (VBS, ANSI-C, VBA)
2444 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the limit values. In
this example the limit value for "Tolerance High" will be configured:
Sub BarGraphLimitConfiguration()
'VBA742
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeToleranceHigh = False
'Activate monitoring
.CheckToleranceHigh = True
'Set barcolor = "yellow"
.ColorToleranceHigh = RGB(255, 255, 0)
'Set upper limit to "40"
.ToleranceHigh = 40
End With
End Sub
See also
TypeToleranceHigh Property (Page 2459)
CheckToleranceHigh Property (Page 2183)
BarGraph Object (Page 1920)
ToleranceLow Property
Description
Defines or returns the limit value for "Tolerance low".
The type of the evaluation (in percent or absolute) is defined in the TypeToleranceLow property.
Monitoring of the limit value only takes effect when the CheckToleranceLow property is set to
"True".
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2445
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the limit values. In
this example the limit value for "Tolerance Low" will be configured.
Sub BarGraphLimitConfiguration()
'VBA743
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeToleranceLow = False
'Activate monitoring
.CheckToleranceLow = True
'Set barcolor = "red"
.ColorToleranceLow = RGB(255, 0, 0)
'Set lower limit to "40"
.ToleranceLow = 40
End With
End Sub
See also
TypeToleranceLow Property (Page 2460)
CheckToleranceLow Property (Page 2184)
BarGraph Object (Page 1920)
ToolbarItems Property
Description
Returns a listing containing all the elements (icons and separation lines) of a user-defined
toolbar.
WinCC: Scripting (VBS, ANSI-C, VBA)
2446 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
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()
'VBA744
Dim objToolbar As HMIToolbar
Dim objToolbarItem As HMIToolbarItem
Set objToolbar = ActiveDocument.CustomToolbars.Add("DocToolbar")
'
'Add symbol-icon to 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")
Set objToolbarItem = objToolbar.ToolbarItems.InsertSeparator(2, "tSeparator1_2")
End Sub
See also
ToolbarItem Object (Page 2092)
Toolbar Object (Page 2089)
ToolbarItemType property
Description
Returns the type of the "HMIToolbarItem" object of a user-defined toolbar as a "string".
Returned Value Type in the toolbar
0 Separator
1 Icon
Example
In the following example the type of the first object in the first user-defined toolbar in the active
picture is output:
Sub ShowFirstObjectOfCollection()
'VBA353
Dim strType As String
strType = ActiveDocument.CustomToolbars(1).ToolbarItems(1).ToolbarItemType
MsgBox strType
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2447
VBA for Automated Configuration
3.6 VBA Reference
ToolTipText Property
Description
Defines or returns the text that will be displayed as a Tooltip when you run the mouse over an
object (HMIObject, icon).
Example:
The "RectangleConfiguration()" procedure accesses the properties of the Rectangle object. In
this example a tool tip text will be assigned to the rectangle:
Sub RectangleConfiguration()
'VBA745
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.ToolTipText = "This is a rectangle"
End With
End Sub
The following example shows how you have to initialize the property prior to dynamization:
Sub Dyn()
'VBA823
Dim objCircle As HMICircle
Dim doc As Document
Dim objDynDialog As HMIDynamicDialog
Set doc = ActiveDocument
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle","HMICircle")
objCircle.ObjectName = "Circle1"
objCircle.BorderColor = RGB(255, 0, 0)
objCircle.BackColor = RGB(0, 255, 0)
objCircle.ToolTipText = "Text"
Set objDynDialog =
objCircle.ToolTipText.CreateDynamic(hmiDynamicCreationTypeDynamicDialog, "'Var'")
End Sub
See also
ToolbarItem Object (Page 2092)
HMIObject Object (Page 1992)
How to dynamize a property with the Dynamic dialog (Page 1699)
WinCC: Scripting (VBS, ANSI-C, VBA)
2448 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Top Property
Description
Defines or returns the Y-coordinate of an object (measured from the top left edge of the picture)
in pixels. The Y-coordinate relates to the top left corner of the rectangle enclosing the object.
Example:
The "RectangleConfiguration()" procedure accesses the properties of the Rectangle object. In
this example the rectangle will be set to position 10/40:
Sub RectangleConfiguration()
'VBA746
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
.Left = 10
.Top = 40
End With
End Sub
See also
View Object (Page 2111)
HMIObject Object (Page 1992)
TopConnectedObjectName Property
Description
Returns the name of the end object to which the connector is connected. Read only access.
Example:
An example showing how to use the BottomConnectedObjectName property can be found in
this documentation under the heading "ObjConnection Object".
See also
ObjConnection object (Page 2023)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2449
VBA for Automated Configuration
3.6 VBA Reference
TopConnectedConnectionPointIndex Property
Description
Returns the connection point on the object to which the connector is connected.
Connection Point Assigned Value
Up 0
Right 1
Down 2
Left 3
Example:
An example showing how to use the BottomConnectedObjectName property can be found in
this documentation under the heading "ObjConnection Object".
See also
ObjConnection object (Page 2023)
Transparency property
Description
Defines the degree of transparency of the object display. Values between 0 and 100 indicate
the transparency as a percentage. In the case of a semi-transparent objects other objects
shine through. A 100% transparent object is invisible. An invisible object can also be controlled
in Runtime.
WinCC: Scripting (VBS, ANSI-C, VBA)
2450 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example
Sub addTransparentObject()
'VBA849
Dim objHMICircle As HMICircle
Set objHMICircle = ActiveDocument.HMIObjects.AddHMIObject("Circle", "HMICircle")
objHMICircle.Transparency = 40
End Sub
Trend Property
Description
TRUE if the trend or tendency of the measured value being monitored (rising or falling) is to
be indicated by a little arrow. BOOLEAN write-read access.
Example:
The "BarGraphConfiguration()" procedure configures In this example the trend of the
measured value will be indicated:
Sub BarGraphConfiguration()
'VBA747
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.trend = True
End With
End Sub
See also
BarGraph Object (Page 1920)
trend property
Description
Is used for the "Graphic Object Update Wizard" tool and is not evaluated for the
"HMIAdvancedAnalogDisplay" and "HMIAdvancedStateAnalogDisplay" objects.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2451
VBA for Automated Configuration
3.6 VBA Reference
TrendColor Property
Description
Defines or returns the color of the trend display.
The trend display indicates the tendency (rising or falling) of the measuring value being
monitored by a small arrow. In order to activate the trend display, the Trend property must be
set to "True". LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "BarGraphConfiguration()" procedure configures In this example the trend in the measured
value will be indicated. The trend display will be set to "Red":
Sub BarGraphConfiguration()
'VBA748
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.trend = True
.TrendColor = RGB(255, 0, 0)
End With
End Sub
See also
Trend Property (Page 2451)
BarGraph Object (Page 1920)
Trigger Property
Description
Returns a Trigger object. Use the Trigger property when making a property dynamic with the
aid of a script.
WinCC: Scripting (VBS, ANSI-C, VBA)
2452 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In this example the "Radius" property of a circle will be made dynamic with the aid of a C script
(the output value sets the radius):
Sub AddDynamicAsCSkriptToProperty()
'VBA749
Dim objVBScript As HMIScriptInfo
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("myCircle", "HMICircle")
Set objVBScript = objCircle.Radius.CreateDynamic(hmiDynamicCreationTypeVBScript)
With objVBScript
.Trigger.Type = hmiTriggerTypeStandardCycle
.Trigger.CycleType = hmiCycleType_2s
.Trigger.Name = "Trigger1"
End With
End Sub
See also
Trigger Object (Page 2096)
ScriptInfo Object (Page 2062)
Type Property
Description
Returns or defines the type of an object.
The object type is returned as either a string or and integer.
Example:
The "RectangleConfiguration()" procedure accesses the properties of the Rectangle object. In
this example the object type will be output:
Sub RectangleConfiguration()
'VBA750
Dim objRectangle As HMIRectangle
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("Rectangle1", "HMIRectangle")
With objRectangle
MsgBox "Objecttype: " & .Type
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2453
VBA for Automated Configuration
3.6 VBA Reference
See also
Trigger Object (Page 2096)
ToolbarItem Object (Page 2092)
SourceLink Object (Page 2069)
Property Object (Page 2046)
HMIObject Object (Page 1992)
FolderItem Object (Page 1977)
DestLink Object (Page 1950)
TypeAlarmHigh Property
Description
TRUE, when the upper limit value, at which an alarm is triggered, should be evaluated as a
percentage. FALSE, when the evaluation should be as an absolute value. BOOLEAN write-
read access.
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "50".
Sub BarGraphLimitConfiguration()
'VBA751
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeAlarmHigh = False
'Activate monitoring
.CheckAlarmHigh = True
'Set barcolor = "yellow"
.ColorAlarmHigh = RGB(255, 255, 0)
'Set upper limit = "50"
.AlarmHigh = 50
End With
End Sub
See also
ColorAlarmHigh Property (Page 2189)
CheckAlarmHigh Property (Page 2177)
AlarmHigh Property (Page 2123)
BarGraph Object (Page 1920)
WinCC: Scripting (VBS, ANSI-C, VBA)
2454 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
TypeAlarmLow Property
Description
TRUE, when the lower limit value, at which an alarm is triggered, should be evaluated as a
percentage. FALSE, when the evaluation should be as an absolute value. BOOLEAN write-
read access.
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "10".
Sub BarGraphLimitConfiguration()
'VBA752
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeAlarmLow = False
'Activate monitoring
.CheckAlarmLow = True
'Set barcolor = "yellow"
.ColorAlarmLow = RGB(255, 255, 0)
'Set lower limit = "10"
.AlarmLow = 10
End With
End Sub
See also
ColorAlarmLow Property (Page 2190)
CheckAlarmLow Property (Page 2178)
AlarmLow Property (Page 2124)
BarGraph Object (Page 1920)
TypeLimitHigh4 Property
Description
TRUE, when the "Reserve 4" upper limit value should be evaluated as a percentage. FALSE,
when the evaluation should be as an absolute value. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2455
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "70".
Sub BarGraphLimitConfiguration()
'VBA753
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeLimitHigh4 = False
'Activate monitoring
.CheckLimitHigh4 = True
'Set barcolor = "red"
.ColorLimitHigh4 = RGB(255, 0, 0)
'Set upper limit = "70"
.LimitHigh4 = 70
End With
End Sub
See also
LimitHigh4 Property (Page 2312)
CheckLimitHigh4 Property (Page 2179)
BarGraph Object (Page 1920)
TypeLimitHigh5 Property
Description
TRUE, when the "Reserve 5" upper limit value should be evaluated as a percentage. FALSE,
when the evaluation should be as an absolute value. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2456 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "80".
Sub BarGraphLimitConfiguration()
'VBA754
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeLimitHigh5 = False
'Activate monitoring
.CheckLimitHigh5 = True
'Set barcolor = "black"
.ColorLimitHigh5 = RGB(0, 0, 0)
'Set upper limit = "70"
.LimitHigh5 = 70
End With
End Sub
See also
LimitHigh5 Property (Page 2313)
CheckLimitHigh5 Property (Page 2180)
BarGraph Object (Page 1920)
TypeLimitLow4 Property
Description
TRUE, when the "Reserve 4" lower limit value should be evaluated as a percentage. FALSE,
when the evaluation should be as an absolute value. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2457
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "5".
Sub BarGraphLimitConfiguration()
'VBA755
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeLimitLow4 = False
'Activate monitoring
.CheckLimitLow4 = True
'Set barcolor = "green"
.ColorLimitLow4 = RGB(0, 255, 0)
'Set lower limit = "5"
.LimitLow4 = 5
End With
End Sub
See also
LimitLow4 Property (Page 2314)
ColorLimitLow4 Property (Page 2194)
CheckLimitLow4 Property (Page 2181)
BarGraph Object (Page 1920)
TypeLimitLow5 Property
Description
TRUE, when the "Reserve 5" lower limit value should be evaluated as a percentage. FALSE,
when the evaluation should be as an absolute value. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2458 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "0".
Sub BarGraphLimitConfiguration()
'VBA756
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeLimitLow5 = False
'Activate monitoring
.CheckLimitLow5 = True
'Set barcolor = "white"
.ColorLimitLow5 = RGB(255, 255, 255)
'Set lower limit = "0"
.LimitLow5 = 0
End With
End Sub
See also
LimitLow5 Property (Page 2315)
ColorLimitLow5 Property (Page 2195)
CheckLimitLow5 Property (Page 2182)
BarGraph Object (Page 1920)
TypeToleranceHigh Property
Description
TRUE, when the "Tolerance high" lower limit value should be evaluated as a percentage.
FALSE, when the evaluation should be as an absolute value. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2459
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the limit values. In
this example the limit value for "Tolerance High" will be configured:
Sub BarGraphLimitConfiguration()
'VBA757
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeToleranceHigh = False
'Activate monitoring
.CheckToleranceHigh = True
'Set barcolor = "yellow"
.ColorToleranceHigh = RGB(255, 255, 0)
'Set upper limit = "40"
.ToleranceHigh = 40
End With
End Sub
See also
ColorToleranceHigh Property (Page 2196)
CheckToleranceHigh Property (Page 2183)
BarGraph Object (Page 1920)
TypeToleranceLow Property
Description
TRUE, when the "Tolerance low" lower limit value should be evaluated as a percentage.
FALSE, when the evaluation should be as an absolute value. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2460 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the limit values. In
this example the limit value for "Tolerance Low" will be configured:
Sub BarGraphLimitConfiguration()
'VBA758
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeToleranceLow = False
'Activate monitoring
.CheckToleranceLow = True
'Set barcolor = "red"
.ColorToleranceLow = RGB(255, 0, 0)
'Set lower limit = "10"
.ToleranceLow = 10
End With
End Sub
See also
ToleranceLow Property (Page 2445)
ColorToleranceLow Property (Page 2197)
CheckToleranceLow Property (Page 2184)
BarGraph Object (Page 1920)
TypeWarningHigh Property
Description
TRUE, when the "Warning high" lower limit value should be evaluated as a percentage. FALSE,
when the evaluation should be as an absolute value. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2461
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "75".
Sub BarGraphLimitConfiguration()
'VBA759
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeWarningHigh = False
'Activate monitoring
.CheckWarningHigh = True
'Set barcolor = "red"
.ColorWarningHigh = RGB(255, 0, 0)
'Set upper limit = "75"
.WarningHigh = 75
End With
End Sub
See also
WarningHigh Property (Page 2554)
ColorWarningHigh Property (Page 2199)
CheckWarningHigh Property (Page 2185)
BarGraph Object (Page 1920)
TypeWarningLow Property
Description
TRUE, when the "Warning low" lower limit value should be evaluated as a percentage. FALSE,
when the evaluation should be as an absolute value. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2462 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "12".
Sub BarGraphLimitConfiguration()
'VBA760
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeWarningLow = False
'Activate monitoring
.CheckWarningLow = True
'Set barcolor = "magenta"
.ColorWarningLow = RGB(255, 0, 255)
'Set lower limit = "12"
.WarningLow = 12
End With
End Sub
See also
WarningLow Property (Page 2555)
ColorWarningLow Property (Page 2200)
CheckWarningLow Property (Page 2186)
BarGraph Object (Page 1920)
Underlined Property
Description
TRUE if the font attribute "Underline" is set for the language-dependent text in the object.
BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2463
VBA for Automated Configuration
3.6 VBA Reference
Example:
The following example sets the font attributes of a button for French and English:
Sub ExampleForLanguageFonts()
'VBA761
Dim colLangFonts As HMILanguageFonts
Dim objButton As HMIButton
Set objButton = ActiveDocument.HMIObjects.AddHMIObject("myButton", "HMIButton")
objButton.Text = "DefText"
Set colLangFonts = objButton.LDFonts
'
'Set font-properties for french:
With colLangFonts.ItemByLCID(1036)
.Family = "Courier New"
.Bold = True
.Italic = False
.Underlined = True
.Size = 12
End With
'
'Set font-properties for english:
With colLangFonts.ItemByLCID(1033)
.Family = "Times New Roman"
.Bold = False
.Italic = True
.Underlined = False
.Size = 14
End With
End Sub
See also
Size Property (Page 2422)
Parent Property (Page 2364)
LanguageID Property (Page 2296)
Italic Property (Page 2288)
Family Property (Page 2236)
Bold Property (Page 2158)
Application Property (Page 2129)
LanguageFont Object (Page 2000)
UnselBGColor Property
Description
Defines or returns the background color of entries in the text list object which are not selected.
LONG write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2464 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the colors will be defined for entries that are not selected in the selection list:
Sub TextListConfiguration()
'VBA762
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.UnselBGColor = RGB(255, 0, 0)
.UnselTextColor = RGB(0, 0, 0)
End With
End Sub
See also
TextList Object (Page 2085)
UnselTextColor Property
Description
In the case of the TextList object, defines or returns the color of text in the selection list for
entries that are not selected. LONG write-read access.
Determination of Color Value
The color is displayed in RGB format (Red, Green, Blue). Specify the corresponding decimal
value for each of the three RGB values (value range from 0 to 255).
Use VBA function "RGB" to assign a color to a property. The color "red", for example, is
represented as follows: RGB(255, 0, 0)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2465
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "TextListConfiguration()" procedure accesses the properties of the object TextList. In this
example the colors will be defined for entries that are not selected in the selection list:
Sub TextListConfiguration()
'VBA763
Dim objTextList As HMITextList
Set objTextList = ActiveDocument.HMIObjects.AddHMIObject("myTextList", "HMITextList")
With objTextList
.UnselBGColor = RGB(255, 0, 0)
.UnselTextColor = RGB(0, 0, 0)
End With
End Sub
See also
TextList Object (Page 2085)
UpdateCycle Property
Description
Defines or returns the type and frequency of updates to the picture window in Runtime.
Update Cycle Assigned Value
Upon change 0
250 ms 1
500 ms 2
1s 3
2s 4
5s 5
10 s 6
1 min 7
5 min 8
10 min 9
1h 10
User cycle 1 11
User cycle 2 12
User cycle 3 13
User cycle 4 14
User cycle 5 15
Picture cycle 255
WinCC: Scripting (VBS, ANSI-C, VBA)
2466 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "PictureWindowConfig" procedure accesses the properties of the picture window. In this
example the picture window will be updated every 5 seconds in Runtime:
Sub PictureWindowConfig()
'VBA764
Dim objPicWindow As HMIPictureWindow
Set objPicWindow = ActiveDocument.HMIObjects.AddHMIObject("PicWindow1", "HMIPictureWindow")
With objPicWindow
.UpdateCycle = 5
End With
End Sub
See also
PictureWindow Object (Page 2033)
UseEventState property
Description
Specifies for the "HMIAdvancedStateDisplay" object whether the group value is evaluated for
the representation of the states.
If the group value is used, you can assign pictures for the individual alarm statuses.
UsedLanguage property
Description
Use the UsedLanguage property to set the code page that matches the character set used.
LONG write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2467
VBA for Automated Configuration
3.6 VBA Reference
Example
The "UsedLanguage" property and language ID "1033" are used in the following example to
set the code page to English US.
Sub AddDynamicAsCSkriptToProperty()
'VBA856
Dim objCScript As HMIScriptInfo
Dim objCircle As HMICircle
Dim strCode As String
strCode = "long lHeight;" & vbCrLf & "int check;" & vbCrLf
strCode = strCode & "GetHeight (""events.PDL"", ""myCircle""); & vbcrlf"
strCode = strCode & "lHeight = lHeight+5;" & vbCrLf
strCode = strCode & "check = SetHeight(""events.PDL"", ""myCircle"",lHeight);"
strCode = strCode & vbCrLf & "//Return-Type: BOOL" & vbCrLf
strCode = strCode & "return check;"
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("Circle_C", "HMICircle")
'Create dynamic for Property "Radius":
Set objCScript = objCircle.Height.CreateDynamic(hmiDynamicCreationTypeCScript)
'set Sourcecode and cycletime:
With objCScript
.SourceCode = strCode
.Trigger.Type = hmiTriggerTypeStandardCycle
.Trigger.CycleType = hmiCycleType_2s
.Trigger.Name = "Trigger1"
'Set language English-US
.UsedLanguage = 1033
End With
End Sub
UseGlobalAlarmClasses property
Description
Defines whether to use globally configured alarm classes to visualize message events. The
property is only relevant for PCS7 projects.
Value Description
TRUE Activates the global settings made in PCS7 alarm editor for
visualizing the message events.
FALSE Visualization of the message events is defined locally for each
message class.
WinCC: Scripting (VBS, ANSI-C, VBA)
2468 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
UseGlobalSettings property
Description
Specify whether to use global settings to assign message events to the buttons visualized in
the group view. The display of the message events is configured using the "MessageClass"
properties. The property is only relevant for PCS7 projects.
Value Description
TRUE Activates the settings made in the PCS7 alarm editor for the
assignment of message events to the buttons in the group
display. The bit numbers in the group value are assigned to
the respective buttons.
FALSE The message types are assigned locally to the buttons in the
group display.
UserValue1 Property
Description
Defines or returns any value in the case of the GroupDisplay object.
The value can be evaluated by a script, for example. This value is neither evaluated nor
displayed in Runtime.
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example four different user values will be assigned:
Sub GroupDisplayConfiguration()
'VBA765
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.UserValue1 = 0
.UserValue2 = 25
.UserValue3 = 50
.UserValue4 = 75
End With
End Sub
See also
UserValue4 Property (Page 2471)
UserValue3 Property (Page 2470)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2469
VBA for Automated Configuration
3.6 VBA Reference
UserValue2-Eigenschaft (Page 2470)
GroupDisplay Object (Page 1985)
UserValue2-Eigenschaft
Description
Defines or returns any value in the case of the GroupDisplay object.
The value can be evaluated by a script, for example. This value is neither evaluated nor
displayed in Runtime.
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example four different user values will be assigned:
Sub GroupDisplayConfiguration()
'VBA766
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.UserValue1 = 0
.UserValue2 = 25
.UserValue3 = 50
.UserValue4 = 75
End With
End Sub
See also
UserValue4 Property (Page 2471)
UserValue3 Property (Page 2470)
UserValue1 Property (Page 2469)
GroupDisplay Object (Page 1985)
UserValue3 Property
Description
Defines or returns any value in the case of the GroupDisplay object.
The value can be evaluated by a script, for example. This value is neither evaluated nor
displayed in Runtime.
WinCC: Scripting (VBS, ANSI-C, VBA)
2470 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example four different user values will be assigned:
Sub GroupDisplayConfiguration()
'VBA767
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.UserValue1 = 0
.UserValue2 = 25
.UserValue3 = 50
.UserValue4 = 75
End With
End Sub
See also
UserValue4 Property (Page 2471)
UserValue2-Eigenschaft (Page 2470)
UserValue1 Property (Page 2469)
GroupDisplay Object (Page 1985)
UserValue4 Property
Description
Defines or returns any value in the case of the GroupDisplay object.
The value can be evaluated by a script, for example. This value is neither evaluated nor
displayed in Runtime.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2471
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "GroupDisplayConfiguration()" procedure accesses the properties of the Group Display.
In this example four different user values will be assigned:
Sub GroupDisplayConfiguration()
'VBA768
Dim objGroupDisplay As HMIGroupDisplay
Set objGroupDisplay = ActiveDocument.HMIObjects.AddHMIObject("GroupDisplay1",
"HMIGroupDisplay")
With objGroupDisplay
.UserValue1 = 0
.UserValue2 = 25
.UserValue3 = 50
.UserValue4 = 75
End With
End Sub
See also
UserValue3 Property (Page 2470)
UserValue2-Eigenschaft (Page 2470)
UserValue1 Property (Page 2469)
GroupDisplay Object (Page 1985)
UseValueText property
Description
Specifies whether a text tag is used instead of a formatted analog value.
Value
Value Property
Description
Returns or defines the value of an object property.
WinCC: Scripting (VBS, ANSI-C, VBA)
2472 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
Use the Value property if you wish to return or define a value with the aid of the Properties
listing. In this example the property of an ActiveX Control will be accessed via the Value
property:
Sub AddActiveXControl()
'VBA769
Dim objActiveXControl As HMIActiveXControl
Set objActiveXControl = ActiveDocument.HMIObjects.AddActiveXControl("WinCC_Gauge2",
"XGAUGE.XGaugeCtrl.1")
'
'Move ActiveX-Control:
objActiveXControl.Top = 40
objActiveXControl.Left = 60
'
'Modify individual properties:
objActiveXControl.Properties("BackColor").value = RGB(255, 0, 0)
End Sub
See also
Property Object (Page 2046)
VALUE_ACCESS_FAULT Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status "Access
to tag not permitted" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2473
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle is given dynamics with the The dynamization
takes place be evaluating the status of a tag. If the tag does not return a status, a substitute
value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VALUE_MAX_LIMIT Property (Page 2509)
VariableStateChecked Property (Page 2548)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_SERVERDOWN Property (Page 2519)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MIN_LIMIT Property (Page 2513)
WinCC: Scripting (VBS, ANSI-C, VBA)
2474 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_MAX_RANGE Property (Page 2511)
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VariableStateValue Object (Page 2105)
VALUE_ADDRESS_ERROR Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status
"Addressing error" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2475
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If the tag does not
return a status, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA771
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VariableStateChecked Property (Page 2548)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_SERVERDOWN Property (Page 2519)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MIN_LIMIT Property (Page 2513)
VALUE_MAX_RANGE Property (Page 2511)
WinCC: Scripting (VBS, ANSI-C, VBA)
2476 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_MAX_LIMIT Property (Page 2509)
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ACCESS_FAULT Property (Page 2473)
VariableStateValue Object (Page 2105)
VALUE_BAD_COMMLUV Property
Description
Specifies the value assigned to a dynamized property if quality code "bad, no communication
(last usable value)" occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2477
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA818
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_BAD_DEVICE Property (Page 2483)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2478 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
QualityCodeStateValue Object (Page 2048)
VALUE_BAD_COMMNUV Property
Description
Specifies the value assigned to a dynamized property if quality code "bad, no communication
(last usable value)" occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2479
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
VALUE_UNCERT_SIMVAL Property (Page 2543)
WinCC: Scripting (VBS, ANSI-C, VBA)
2480 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_BAD_CONFERROR Property
Description
Specifies the value assigned to a dynamized property if quality code "bad, no communication,
value not accepted" occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2481
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2482 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
VALUE_UNCERT_MISCSTATES Property (Page 2537)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_BAD_DEVICE Property
Description
Specifies a value assigned to a dynamized property if quality code "bad, device failure" occurs,
or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2483
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2484 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_BAD_MISCSTATES Property
Description
Specifies the value assigned to a dynamized property if quality code "bad miscellaneous
states" occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2485
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2486 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_BAD_NONSPECIFIC Property
Description
Specifies the value assigned to a dynamized property if quality code "bad, non-specific" occurs,
or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2487
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2488 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_BAD_NOTCONNECTED Property
Description
Specifies a value assigned to a dynamized property if quality code "bad, not connected" occurs,
or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2489
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_HIGHLIMITED Property (Page 2503)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2490 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_BAD_OUTOFSERV Property
Description
Specifies a value assigned to a dynamized property if quality code "bad, out of service" occurs,
or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2491
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_BAD_CONFERROR Property (Page 2481)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2492 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_BAD_PROCRELNOM Property
Description
Specifies the value assigned to a dynamized property if quality code "bad, process related, no
maintenance" occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2493
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_UNCERT_LUV Property (Page 2533)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2494 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_BAD_PROCRELSUB Property
Description
Specifies the value assigned to a dynamized property if quality code "bad, process related,
substitute value" occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2495
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2496 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_CONVERSION_ERROR Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status
"Conversion error" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2497
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If the tag does not
return a status, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA772
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VariableStateChecked Property (Page 2548)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_SERVERDOWN Property (Page 2519)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MIN_LIMIT Property (Page 2513)
VALUE_MAX_RANGE Property (Page 2511)
WinCC: Scripting (VBS, ANSI-C, VBA)
2498 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_MAX_LIMIT Property (Page 2509)
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
VariableStateValue Object (Page 2105)
VALUE_HANDSHAKE_ERROR Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status
"Handshake error" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2499
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If the tag does not
return a status, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA773
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VariableStateChecked Property (Page 2548)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_SERVERDOWN Property (Page 2519)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MIN_LIMIT Property (Page 2513)
VALUE_MAX_RANGE Property (Page 2511)
WinCC: Scripting (VBS, ANSI-C, VBA)
2500 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_MAX_LIMIT Property (Page 2509)
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
VariableStateValue Object (Page 2105)
VALUE_HARDWARE_ERROR Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status "No
network module" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2501
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If the tag does not
return a status, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA774
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VALUE_MAX_RANGE Property (Page 2511)
VariableStateChecked Property (Page 2548)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_SERVERDOWN Property (Page 2519)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MIN_LIMIT Property (Page 2513)
WinCC: Scripting (VBS, ANSI-C, VBA)
2502 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_MAX_LIMIT Property (Page 2509)
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
VariableStateValue Object (Page 2105)
VALUE_HIGHLIMITED Property
Description
Specifies the value assigned to a dynamized property if quality code "high limited" occurs, or
returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2503
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
VALUE_UNCERT_SIMVAL Property (Page 2543)
WinCC: Scripting (VBS, ANSI-C, VBA)
2504 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_INVALID_KEY Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status "Tag
not found" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2505
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If the tag does not
return a status, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA775
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VariableStateChecked Property (Page 2548)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_SERVERDOWN Property (Page 2519)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MIN_LIMIT Property (Page 2513)
VALUE_MAX_RANGE Property (Page 2511)
WinCC: Scripting (VBS, ANSI-C, VBA)
2506 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_MAX_LIMIT Property (Page 2509)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
VariableStateValue Object (Page 2105)
VALUE_LOWLIMITED Property
Description
Specifies the value assigned to a dynamized property if quality code "low limited" occurs, or
returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2507
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_BAD_PROCRELSUB Property (Page 2495)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2508 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_MAX_LIMIT Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status "Upper
limit exceeded" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2509
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If the tag does not
return a status, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA776
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VALUE_MIN_LIMIT Property (Page 2513)
VariableStateChecked Property (Page 2548)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_SERVERDOWN Property (Page 2519)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MAX_RANGE Property (Page 2511)
WinCC: Scripting (VBS, ANSI-C, VBA)
2510 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
VariableStateValue Object (Page 2105)
VALUE_MAX_RANGE Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status "Format
upper limit exceeded" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2511
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If the tag does not
return a status, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA777
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VariableStateChecked Property (Page 2548)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_SERVERDOWN Property (Page 2519)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MIN_LIMIT Property (Page 2513)
VALUE_MAX_LIMIT Property (Page 2509)
WinCC: Scripting (VBS, ANSI-C, VBA)
2512 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
VariableStateValue Object (Page 2105)
VALUE_MIN_LIMIT Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status "Lower
limit exceeded" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2513
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If the tag does not
return a status, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA778
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VariableStateChecked Property (Page 2548)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_SERVERDOWN Property (Page 2519)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MAX_RANGE Property (Page 2511)
VALUE_MAX_LIMIT Property (Page 2509)
WinCC: Scripting (VBS, ANSI-C, VBA)
2514 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
VariableStateValue Object (Page 2105)
VALUE_MIN_RANGE Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status "Format
lower limit exceeded" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2515
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If the tag does not
return a status, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA779
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VariableStateChecked Property (Page 2548)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_SERVERDOWN Property (Page 2519)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_LIMIT Property (Page 2513)
VALUE_MAX_RANGE Property (Page 2511)
VALUE_MAX_LIMIT Property (Page 2509)
WinCC: Scripting (VBS, ANSI-C, VBA)
2516 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
VariableStateValue Object (Page 2105)
VALUE_NOT_ESTABLISHED Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status "No
check-back message from the channel" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2517
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If the tag does not
return a status, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA780
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VariableStateChecked Property (Page 2548)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_SERVERDOWN Property (Page 2519)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MIN_LIMIT Property (Page 2513)
VALUE_MAX_RANGE Property (Page 2511)
VALUE_MAX_LIMIT Property (Page 2509)
WinCC: Scripting (VBS, ANSI-C, VBA)
2518 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
VariableStateValue Object (Page 2105)
VALUE_SERVERDOWN Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status "Server
not available" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2519
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If the tag does not
return a status, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA781
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VariableStateChecked Property (Page 2548)
VALUE_TIMEOUT Property (Page 2523)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MIN_LIMIT Property (Page 2513)
VALUE_MAX_RANGE Property (Page 2511)
VALUE_MAX_LIMIT Property (Page 2509)
WinCC: Scripting (VBS, ANSI-C, VBA)
2520 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
VariableStateValue Object (Page 2105)
VALUE_STARTUP_VALUE Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status "Start
value" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2521
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If the tag does not
return a status, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA782
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VariableStateChecked Property (Page 2548)
VALUE_TIMEOUT Property (Page 2523)
VALUE_SERVERDOWN Property (Page 2519)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MIN_LIMIT Property (Page 2513)
VALUE_MAX_RANGE Property (Page 2511)
VALUE_MAX_LIMIT Property (Page 2509)
WinCC: Scripting (VBS, ANSI-C, VBA)
2522 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
VariableStateValue Object (Page 2105)
VALUE_TIMEOUT Property
Description
Defines or returns the value that will be assigned to the dynamic property if tag status "No
connection" occurs.
The value of the VariableStateChecked property must be TRUE in order for the status to be
evaluated.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2523
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If the tag does not
return a status, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA783
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VariableStateChecked Property (Page 2548)
VALUE_STARTUP_VALUE Property (Page 2521)
VALUE_SERVERDOWN Property (Page 2519)
VALUE_NOT_ESTABLISHED Property (Page 2517)
VALUE_MIN_RANGE Property (Page 2515)
VALUE_MIN_LIMIT Property (Page 2513)
VALUE_MAX_RANGE Property (Page 2511)
VALUE_MAX_LIMIT Property (Page 2509)
WinCC: Scripting (VBS, ANSI-C, VBA)
2524 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_INVALID_KEY Property (Page 2505)
VALUE_HARDWARE_ERROR Property (Page 2501)
VALUE_HANDSHAKE_ERROR Property (Page 2499)
VALUE_CONVERSION_ERROR Property (Page 2497)
VALUE_ADDRESS_ERROR Property (Page 2475)
VALUE_ACCESS_FAULT Property (Page 2473)
VariableStateValue Object (Page 2105)
VALUE_UNCERT_ENGVHIGHLIM Property
Description
Specifies the value assigned to a dynamized property if quality code "uncertain, engineering
unit range violation, high limit set" occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2525
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_BAD_PROCRELSUB Property (Page 2495)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2526 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_UNCERT_ENGVLOWLIM Property
Description
Specifies the value assigned to a dynamized property if quality code "uncertain, engineering
unit range violation, low limit set" occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2527
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2528 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_UNCERT_ENGVONLIM Property
Description
Specifies the value assigned to a dynamized property if quality code "uncertain, engineering
unit range violation, on limits set" occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2529
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_UNCERT_SIMVAL Property (Page 2543)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2530 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_UNCERT_INITVAL Property
Description
Specifies a value assigned to a dynamized property if quality code "uncertain, initial value"
occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2531
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_UNCERT_LUV Property (Page 2533)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2532 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_UNCERT_LUV Property
Description
Specifies a value assigned to a dynamized property if quality code "uncertain, last usable
value" occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2533
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_HIGHLIMITED Property (Page 2503)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2534 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_UNCERT_MAINTDEM Property
Description
Specifies a value assigned to a dynamized property if quality code "uncertain, maintenance
demanded" occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2535
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2536 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_UNCERT_MISCSTATES Property
Description
Specifies the value assigned to a dynamized property if quality code "uncertain miscellaneous
states" occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2537
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_LOWLIMITED Property (Page 2507)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2538 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_UNCERT_NONSPECIFIC Property
Description
Specifies the value assigned to a dynamized property if quality code "uncertain, non-specific"
occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2539
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_UNCERT_MAINTDEM Property (Page 2535)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2540 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_UNCERT_PROCRELNOM Property
Description
Specifies the value assigned to a dynamized property if quality code "uncertain, process
related, no maintenance" occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2541
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_BAD_COMMNUV Property (Page 2479)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2542 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_SIMVAL Property (Page 2543)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_UNCERT_SIMVAL Property
Description
Specifies a value assigned to a dynamized property if quality code "uncertain, simulated value"
occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2543
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_BAD_PROCRELNOM Property (Page 2493)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SUBSTSET Property (Page 2545)
WinCC: Scripting (VBS, ANSI-C, VBA)
2544 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MISCSTATES Property (Page 2537)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VALUE_UNCERT_SUBSTSET Property
Description
Specifies a value assigned to a dynamized property if quality code "uncertain, substitute set"
occurs, or returns its value.
In order for the quality code to be analyzed, the QualityCodeStateChecked property must be
TRUE.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2545
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. Dynamization uses the analysis of the quality code of a tag. If the tag fails to return a
quality code, a substitute value (ElseCase property) is defined:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA770
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of qualitycodestate
.QualityCodeStateChecked = True
End With
With objDynDialog.QualityCodeStateValues(1)
'
'define a value for every state:
.VALUE_BAD_COMMLUV = 20
.VALUE_BAD_COMMNUV = 30
.VALUE_BAD_CONFERROR = 40
.VALUE_BAD_DEVICE = 60
.VALUE_BAD_MISCSTATES = 70
.VALUE_BAD_NONSPECIFIC = 80
.VALUE_BAD_NOTCONNECTED = 90
.VALUE_BAD_OUTOFSERV = 100
.VALUE_BAD_PROCRELNOM = 110
.VALUE_BAD_PROCRELSUB = 120
.VALUE_HIGHLIMITED = 130
.VALUE_LOWLIMITED = 140
.VALUE_UNCERT_ENGVHIGHLIM = 150
.VALUE_UNCERT_ENGVLOWLIM = 160
.VALUE_UNCERT_INITVAL = 170
.VALUE_UNCERT_LUV = 180
.VALUE_UNCERT_MAINTDEM = 190
.VALUE_UNCERT_MISCSTATES = 200
.VALUE_UNCERT_NONSPECIFIC = 210
.VALUE_UNCERT_PROCRELNOM = 220
.VALUE_UNCERT_SIMVAL = 230
.VALUE_UNCERT_SUBSTSET = 240
End With
End Sub
See also
VALUE_UNCERT_MISCSTATES Property (Page 2537)
QualityCodeStateChecked Properties (Page 2393)
VALUE_UNCERT_SIMVAL Property (Page 2543)
WinCC: Scripting (VBS, ANSI-C, VBA)
2546 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VALUE_UNCERT_PROCRELNOM Property (Page 2541)
VALUE_UNCERT_NONSPECIFIC Property (Page 2539)
VALUE_UNCERT_MAINTDEM Property (Page 2535)
VALUE_UNCERT_LUV Property (Page 2533)
VALUE_UNCERT_INITVAL Property (Page 2531)
VALUE_UNCERT_ENGVONLIM Property (Page 2529)
VALUE_UNCERT_ENGVLOWLIM Property (Page 2527)
VALUE_UNCERT_ENGVHIGHLIM Property (Page 2525)
VALUE_LOWLIMITED Property (Page 2507)
VALUE_HIGHLIMITED Property (Page 2503)
VALUE_BAD_PROCRELSUB Property (Page 2495)
VALUE_BAD_PROCRELNOM Property (Page 2493)
VALUE_BAD_OUTOFSERV Property (Page 2491)
VALUE_BAD_NOTCONNECTED Property (Page 2489)
VALUE_BAD_NONSPECIFIC Property (Page 2487)
VALUE_BAD_MISCSTATES Property (Page 2485)
VALUE_BAD_DEVICE Property (Page 2483)
VALUE_BAD_CONFERROR Property (Page 2481)
VALUE_BAD_COMMNUV Property (Page 2479)
VALUE_BAD_COMMLUV Property (Page 2477)
QualityCodeStateValue Object (Page 2048)
VariablesExist Property
Description
TRUE when all the tags used in the source code of a DynamicDialog object are defined. Read
only access.
You can use this property to check whether all the tags that you have defined in the source
code of the Dynamic dialog are created in WinCC.
Example:
--
See also
DynamicDialog Object (Page 1960)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2547
VBA for Automated Configuration
3.6 VBA Reference
VariableStateChecked Property
Description
TRUE if the status of the specified tag is used in the dynamic dialog for dynamization.
BOOLEAN write-read access.
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If a tag does not return
a status, a substitute value (ElseCase property) is defined, a tag name is issued and three
analog value ranges are created:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA785
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
DynamicDialog Object (Page 1960)
WinCC: Scripting (VBS, ANSI-C, VBA)
2548 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
VariableStateType Property
Description
Returns the type of tag monitoring used to dynamize a property or an event: No monitoring,
quality code, or tag status. Read only access.
Index VariableStateType
0 hmiNoVariableState
1 hmiVariableQCState
2 hmiVariableState
Example:
The procedure "GetVariableStateType()" reads the type of monitoring from the current
document. In this example, the type of monitoring is output in a message:
Sub GetVariableStateType()
'VBA819
Dim objDyn As HMIDynamicDialog
Set objDyn =
ActiveDocument.Properties("Width").CreateDynamic(hmiDynamicCreationTypeDynamicDialog,
"'TestVal'")
MsgBox objDyn.VariableStateType
objDyn.Delete
End Sub
See also
DynamicDialog Object (Page 1960)
VariableStateValues Property
Description
Returns the VariableStateValues listing. Use the VariableStateValues property with the Item
property to assign a value to the tag status to be used for dynamization.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2549
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle will be dynamically configured using the Dynamic
dialog. The dynamization takes place be evaluating the status of a tag. If a tag does not return
a status, a substitute value (ElseCase property) is defined, a tag name is issued and three
analog value ranges are created:
Sub AddDynamicDialogToCircleRadiusTypeAnalog()
'VBA786
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
.ResultType = hmiResultTypeAnalog
.AnalogResultInfos.ElseCase = 200
'
'Activate analysis of variablestate
.VariableStateChecked = True
End With
With objDynDialog.VariableStateValues(1)
'
'define a value for every state:
.VALUE_ACCESS_FAULT = 20
.VALUE_ADDRESS_ERROR = 30
.VALUE_CONVERSION_ERROR = 40
.VALUE_HANDSHAKE_ERROR = 60
.VALUE_HARDWARE_ERROR = 70
.VALUE_INVALID_KEY = 80
.VALUE_MAX_LIMIT = 90
.VALUE_MAX_RANGE = 100
.VALUE_MIN_LIMIT = 110
.VALUE_MIN_RANGE = 120
.VALUE_NOT_ESTABLISHED = 130
.VALUE_SERVERDOWN = 140
.VALUE_STARTUP_VALUE = 150
.VALUE_TIMEOUT = 160
End With
End Sub
See also
VariableStateValues Object (Listing) (Page 2106)
DynamicDialog Object (Page 1960)
VariableTriggers Property
Description
Returns the VariableTriggers listing. Use the VariableTriggers property in order to add a tag
trigger to a VB action or C action.
WinCC: Scripting (VBS, ANSI-C, VBA)
2550 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the radius of a circle is made dynamic with the aid of a VB script. A
tag trigger is used as the trigger:
Sub DynamicWithVariableTrigger()
'VBA787
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
'Triggername and cycletime are defined by add-methode
Set objVarTrigger = .Trigger.VariableTriggers.Add("VarTrigger", hmiVariableCycleType_10s)
.SourceCode = ""
End With
End Sub
See also
VariableTriggers Object (Listing) (Page 2110)
VarName Property
Description
Defines the tag whose status is to be used in the Dynamic dialog for the purpose of dynamics,
or returns the name.
Example:
In this example the name of the trigger tag used for creating dynamics in the radius of a circle
will be output:
Sub GetVarName()
'VBA788
Dim objVBScript As HMIScriptInfo
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.Item("Circle_VariableTrigger")
Set objVBScript = objCircle.Radius.Dynamic
With objVBScript
'Reading out of variablename
MsgBox "The radius is dynamicabled with: " & .Trigger.VariableTriggers.Item(1).VarName
End With
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2551
VBA for Automated Configuration
3.6 VBA Reference
See also
VariableStateValue Object (Page 2105)
VBAVersion Property
Description
Returns the VBA version number. Read only access.
Example:
In the following example the current VBA version number is output:
Sub ShowVBAVersion()
'VBA789
MsgBox Application.VBAVersion
End Sub
See also
Application Object (Page 1915)
VBE Property
Description
Returns the VB Extensibility object. Read access.
Example:
--
See also
Application Object (Page 1915)
Version Property
Description
Returns the version number of the specified application. Read only access.
WinCC: Scripting (VBS, ANSI-C, VBA)
2552 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example the version number of the Graphics Designer is output:
Sub ShowVersionOfGraphicsDesigner()
'VBA791
MsgBox Application.Version
End Sub
See also
Application Object (Page 1915)
Views Property
Description
Returns the Views listing. Use the Views listing to create a new copy of a picture, for instance.
Example:
In the following example a copy of the active picture is created and then activated:
Sub AddView()
'VBA792
Dim objView As HMIView
Set objView = ActiveDocument.Views.Add
objView.Activate
End Sub
See also
Views Object (Listing) (Page 2112)
Visible Property
Description
TRUE if the specified object is intended to be visible. BOOLEAN write-read access.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2553
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example a circle will be inserted into the active picture. This circle is not
intended to be visible in Runtime:
Sub HideCircleInRuntime()
'VBA793
Dim objCircle As HMICircle
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("myCircle", "HMICircle")
objCircle.Visible = False
End Sub
See also
ToolbarItem Object (Page 2092)
MenuItem Object (Page 2017)
HMIObject Object (Page 1992)
Document Object (Page 1954)
Toolbar Object (Page 2089)
Menu Object (Page 2013)
Application Object (Page 1915)
W-Z
WarningHigh Property
Description
Defines or returns the high limit value "Warning High" in the case of the BarGraph object.
The "CheckWarningHigh" property must be set to "True" in order for the limit value to be
monitored.
The display on reaching the limit value and the type of evaluation are defined via the properties
ColorWarningHigh and TypeWarningHigh.
WinCC: Scripting (VBS, ANSI-C, VBA)
2554 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the high limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "75".
Sub BarGraphLimitConfiguration()
'VBA794
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeWarningHigh = False
'Activate monitoring
.CheckWarningHigh = True
'Set barcolor = "red"
.ColorWarningHigh = RGB(255, 0, 0)
'Set upper limit = "75"
.WarningHigh = 75
End With
End Sub
See also
TypeWarningHigh Property (Page 2461)
ColorWarningHigh Property (Page 2199)
CheckWarningHigh Property (Page 2185)
BarGraph Object (Page 1920)
WarningLow Property
Description
Defines or returns the low limit value "Warning Low" in the case of the BarGraph object.
The "CheckWarningLow" property must be set to "True" in order for the limit value to be
monitored.
The display on reaching the limit value and the type of evaluation are defined via the properties
ColorWarningLow and TypeWarningLow.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2555
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphLimitConfiguration()" procedure configures the properties of the low limit value
for an alarm. In this example the type of evaluation will be set to "Absolute". The alarm will be
triggered at a value of "12".
Sub BarGraphLimitConfiguration()
'VBA795
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
'Set analysis = absolute
.TypeWarningLow = False
'Activate monitoring
.CheckWarningLow = True
'Set barcolor = "magenta"
.ColorWarningLow = RGB(255, 0, 255)
'Set lower limit = "12"
.WarningLow = 75
End With
End Sub
See also
TypeWarningLow Property (Page 2462)
ColorWarningLow Property (Page 2200)
CheckWarningLow Property (Page 2186)
BarGraph Object (Page 1920)
Width Property
Description
Defines or returns the width of an object in pixels.
WinCC: Scripting (VBS, ANSI-C, VBA)
2556 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example three objects of different sizes will be inserted in the active picture.
Then all objects will be selected and set to the same width:
Sub ApplySameWidthToSelectedObjects()
'VBA796
Dim objCircle As HMICircle
Dim objRectangle As HMIRectangle
Dim objEllipse As HMIEllipse
Set objCircle = ActiveDocument.HMIObjects.AddHMIObject("sCircle", "HMICircle")
Set objRectangle = ActiveDocument.HMIObjects.AddHMIObject("sRectangle", "HMIRectangle")
Set objEllipse = ActiveDocument.HMIObjects.AddHMIObject("sEllipse", "HMIEllipse")
With objCircle
.Top = 30
.Left = 0
.Width = 15
.Selected = True
End With
With objRectangle
.Top = 80
.Left = 42
.Width = 40
.Selected = True
End With
With objEllipse
.Top = 48
.Left = 162
.Width = 120
.BackColor = RGB(255, 0, 0)
.Selected = True
End With
MsgBox "Objects selected!"
ActiveDocument.Selection.SameWidth
End Sub
See also
HMIObject Object (Page 1992)
WinCCStyle property
Description
Defines the style in which the object is displayed.
User-defined Shows the object according to the respective settings.
global Shows the object in a globally defined design.
Windows Style Shows the object in Windows style.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2557
VBA for Automated Configuration
3.6 VBA Reference
Example
WindowBorder Property
Description
TRUE if it is intended that the application window or picture window shall be displayed with a
border in Runtime. BOOLEAN write-read access.
Example:
The "ApplicationWindowConfig" procedure accesses the properties of the application window.
In this example the application window will
Sub ApplicationWindowConfig()
'VBA797
Dim objAppWindow As HMIApplicationWindow
Set objAppWindow = ActiveDocument.HMIObjects.AddHMIObject("AppWindow",
"HMIApplicationWindow")
With objAppWindow
.Caption = True
.CloseButton = False
.Height = 200
.Left = 10
.MaximizeButton = True
.Moveable = False
.OnTop = True
.Sizeable = True
.Top = 20
.Visible = True
.Width = 250
.WindowBorder = True
End With
End Sub
See also
PictureWindow Object (Page 2033)
ApplicationWindow Object (Page 1917)
WinCC: Scripting (VBS, ANSI-C, VBA)
2558 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
WindowMonitorNumber property
Description
Defines the monitor on which the picture window is displayed. This requires that the system
supports more than one monitor. The attribute is only effective if the "Independent window"
attribute is set to "Yes".
1-n The number of the monitor in the operating system on which the picture window is
displayed.
Example
WindowPositionMode property
Description
Defines the position and scaling of the picture window on the screen. The property is only
effective if the "Independent window" attribute is set to "Yes".
Standard The picture window is positioned in its original size in the configured position
on the screen.
Center The picture window is positioned in its original size, centered on the screen.
Maximize The picture window is scaled to the size of the screen.
Example
WindowsStyle property
Description
Defines whether the object is displayed in the Windows style of WinCC version 6.2. It can only
be selected if "WinCC Classic" is chosen as the current design.
yes Shows the object using the Windows style from WinCC version 6.2.
no Shows the object not using the Windows style from WinCC version 6.2.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2559
VBA for Automated Configuration
3.6 VBA Reference
The WinCC V6.2 standard design "WinCC Classic" which, for compatibility reasons, is
available for migrated projects. The design supports only a portion of the functions that were
introduced as of WinCC V7.0: For example, you cannot use any SVG graphics.
Example
WindowState Property
Description
Returns the status of the window containing the specified application. READ access.
WindowState Assigned Value
Maximized 0
Minimized 1
Custom sized 2
Example:
In the following example the window status of the Graphics Designer is output:
Sub ShowWindowState()
'VBA798
Dim strState As String
Select Case Application.WindowState
Case 0
strState = "The application-window is maximized"
Case 1
strState = "The applicationwindow is minimized"
Case 2
strState = "The application-window has a userdefined size"
End Select
MsgBox strState
End Sub
See also
Application Object (Page 1915)
WinCC: Scripting (VBS, ANSI-C, VBA)
2560 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
ZeroPoint Property
Description
Defines or returns the position of the zero point on the bar in the case of the BarGraph object.
Specify the value as a %age of the total bar height. The zero point can also be outside of the
range represented.
The "ScalingType" property must be set to "2" and "Scaling" must be set to "True".
Example:
The "BarGraphConfiguration()" procedure configures In this example the zero point is located
halfway up the bar height:
Sub BarGraphConfiguration()
'VBA799
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.Scaling = True
.ScalingType = 2
.ZeroPoint = 50
.ZeroPointValue = 0
End With
End Sub
See also
ZeroPointValue Property (Page 2561)
ScalingType Property (Page 2408)
Scaling Property (Page 2407)
BarGraph Object (Page 1920)
ZeroPointValue Property
Description
Defines or returns the absolute value for the zero point.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2561
VBA for Automated Configuration
3.6 VBA Reference
Example:
The "BarGraphConfiguration()" procedure configures In this example the absolute value of the
zero point will be set to "0".
Sub BarGraphConfiguration()
'VBA800
Dim objBarGraph As HMIBarGraph
Set objBarGraph = ActiveDocument.HMIObjects.AddHMIObject("Bar1", "HMIBarGraph")
With objBarGraph
.Scaling = True
.ScalingType = 2
.ZeroPointValue = 0
End With
End Sub
See also
ZeroPoint Property (Page 2561)
ScalingType Property (Page 2408)
Scaling Property (Page 2407)
BarGraph Object (Page 1920)
3DBarGraph Object (Page 1900)
Zoom Property
Description
Defines or returns the zoom factor.
Example:
In this example a copy of the active picture is created and the zoom factor is set to 50%:
Sub CreateViewFromActiveDocument()
'VBA801
Dim objView As HMIView
Set objView = ActiveDocument.Views.Add
objView.Zoom = 50
End Sub
See also
View Object (Page 2111)
PictureWindow Object (Page 2033)
WinCC: Scripting (VBS, ANSI-C, VBA)
2562 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
3.6.2 VBA in Other WinCC Editors
3.6.2.1 VBA in Other WinCC Editors
Introduction
In addition to Graphics Designer, you can automate the following WinCC editors with VBA:
● Tag Management
● Tag Logging
● Text library
● Alarm Logging
The functions for accessing the editors are contained in the "HMIGO" class.
Requirement
● The "HMIGenObjects.dll" file is referenced. This happens automatically during WinCC
installation.
Principle
For access to the "HMIGO" class with VBA, you must reference the "HMI GeneralObjects 1.0
Type Library" in the VBA editor via the "Tools > References" menu. You must create a new
instance of this class in the program code, e.g.:
'Dim HMIGOObject As New HMIGO
Create several different objects of this class if access several objects at the same time. Two
instances of the "HMIGO" class are required, for example, in Tag Logging: The first instance
is required for access to the archive tags, the second instance for access to the process value
archive.
Application
To enable you to use the functions and properties of the editors in VBA, you must have opened
a project in WinCC.
You can then, for example, do the following directly from the program code:
● Create several tags and change the values
● Edit text entries in the TextLibrary
● Adapt messages.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2563
VBA for Automated Configuration
3.6 VBA Reference
Querying Object State
The "HMIGO" class has the enumeration "HMIGO_OBJECT_STATE" which returns the state
of the specified object. The enumeration can return the following values:
● OBJECT_EMPTY (2): Connection to the object is not available.
● OBJECT_OPENED (3): Connection to objects exists. You can change and read its
parameters.
● OBJECT_MODIFIED (4): An object's parameters have been changed. If the corresponding
Commit function is not called, the changes are not saved.
● WINCC_CONNECTED (1): The object is connected to the WinCC project. By default this
connection is established when a function is called the first time. To release the connection,
use the instruction "HMIGO = nothing", for example.
Error Handling
Errors can occur when you use the "HMIGO" class. Use the "OnError" statement to respond
to these error messages. The "OnError" statement must come before the call of a function
from the HMIGeneralObjects class:
Sub CreateTag()
'HMIGO_000
Dim hmiGOTag as New HMIGO
On Error GoTo ErrorHandlerHMIGO
hmiGOTag.CreateTag "NewTag", TAG_BINARY_TAG, "ExistingConnection", "DB1,DD0,QC",
"NewOrExistingGroupName"
'...
Exit Sub
ErrorHandlerHMIGO:
MsgBox ("Error: " & Err.Number & " " & Err.Description & " " & Err.Source)
Resume Next
End Sub
As a result, an error text returned by the interface is output.
See also
VBA in Alarm Logging (Page 2624)
VBA in the Text Library (Page 2610)
VBA in Tag Logging (Page 2576)
VBA in Tag Management (Page 2565)
WinCC: Scripting (VBS, ANSI-C, VBA)
2564 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
3.6.2.2 VBA in Tag Management
VBA in Tag Management
Introduction
VBA can be used to:
● Create tags directly from the program code
● Modify and delete tags
● Read out and change the properties of the tags
● Read out and change the types of the tags
● Read out and change the values of the tags
Note
The tags may not be open or opened in tag management when editing with VBA.
If you wish to change the data type of a tag, you must first delete the tag and then regenerate
it. You must save the parameters first in order to be able to transfer them following the
generation of tags.
Principle
When you have created the instance of the "HMIGO" class, the following functions are available
to you to access the tag management facility:
● CloseTag
● CommitTag
● CreateTag
● DeleteTag
● GetTag
● ListTag
The following enumerations are available for the parameter supply of these functions:
● HMIGO_TAG_TYPE
● HMIGO_TAG_LIST_TYPE
Note
If you set the start value to a binary tag, use the values "0" or "1". Do not use the values "False"
or "True". These values are no longer valid for VBA programming in WinCC and will result in
an error message.
Replace the values "False" and "True" with "0" and "1" in your existing VBA code.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2565
VBA for Automated Configuration
3.6 VBA Reference
Access to the Object Properties
You can also access the parameters of the above-mentioned functions directly in VBA by
means of the following object properties:
Object property Description Read/Write
ObjectStateTag Returns the object state via the enumeration HMIGO_OB‐ Yes/no
JECT_STATE. Further information on this enumeration can
be found in this documentation under "VBA in other WinCC
Editors".
TagName Name of the tag Yes/no
TagGroupName Name of a group in which the tag is inserted. If the group does Yes/no
not yet exist, it is created. If no group name is specified, the
tag is created outside all groups.
TagConnection Name of a connection in which the tag and/or group is to be Yes/no
created. The connection must already exist, otherwise a tag
cannot be created. If the name is omitted, an internal tag is
created.
TagMaximum Sets the new value of the upper limit Yes/yes
TagMinimum Sets the new value of the lower limit Yes/yes
TagStart Sets the new start value Yes/yes
TagS5S7Address Address of the S7 or S5 PLC to which the tag is connected. Yes/yes
If no address is specified, a blank entry is passed.
TagType Data type of the tag. The possible types are: Yes/no
(HMI‐ ● TAG_BINARY_TAG (1)
GO_TAG_TYPE)
● TAG_SIGNED_8BIT_VALUE (2)
● TAG_UNSIGNED_8BIT_VALUE (3)
● TAG_SIGNED_16BIT_VALUE (4)
● TAG_UNSIGNED_16BIT_VALUE (5)
● TAG_SIGNED_32BIT_VALUE (6)
● TAG_UNSIGNED_32BIT_VALUE (7)
● TAG_FLOATINGPOINT_NUMBER_32BIT_IEEE_754 (8)
● TAG_FLOATINGPOINT_NUMBER_64BIT_IEEE_754 (9)
● TAG_TEXT_TAG_8BIT_CHARACTER_SET (10)
● TAG_TEXT_TAG_16BIT_CHARACTER_SET (11)
● TAG_RAW_DATA_TYPE (12)
● TAG_STRUCT (14)
● TAG_TEXT_REFERENCE (18)
● TAG_DATE_TIME (19)
TagUpdate Defines whether the tag is updated on the local computer or Yes/yes
(HMIGO_TAG_UP‐ for the entire project. (for internal tag only)
DATE) ● TAG_COMPUTER_LOCAL (1)
● TAG_PROJECT_WIDE (2)
WinCC: Scripting (VBS, ANSI-C, VBA)
2566 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Object property Description Read/Write
LengthText Length of a text tag (0...255) yes/yes
"LengthText" can also be used for the length of the raw data (only for exter‐
tag. A testing of the correctness of the length will not be con‐ nal tag of type
ducted. Observe the instructions of the communication chan‐ text)
nels.
TagScaleValid Defines a linear scaling. Yes/yes
TagScaleParam1 Sets the value1 for the value range process. Yes/yes
TagScaleParam2 Sets the value2 for the value range process. Yes/yes
TagScaleParam3 Sets the value1 for the value range tag. Yes/yes
TagScaleParam4 Sets the value2 for the value range tag. Yes/yes
TagStartvaluePersis‐ Defines whether an internal tag is set as persistent. Yes/yes
tence
TagSubst Replacement value (only for external variables) Yes/yes
UseSubstValueOn‐ Set the replacement value for connection errors. Yes/yes
CommonError
UseSubstValueOn‐ Set the replacement value for upper limit. Yes/yes
MaxLimit
UseSubstValueOn‐ Set the replacement value for lower limit. Yes/yes
MinLimit
UseSubstValueOn‐ Set the replacement value for the start value. Yes/yes
StartValue
You will find a description of the properties under the parameter descriptions for the
corresponding functions.
Note
The "Tag synchronization" point in the property dialog of tags is not addressable with VBA.
Tag synchronization is only available for internal tags.
For external tags, the "Type Conversion" point is not addressable with VBA.
See also
ListTag function (Page 2574)
GetTag Function (Page 2573)
DeleteTag Function (Page 2572)
CreateTag Function (Page 2570)
CommitTag Function (Page 2569)
CloseTag Function (Page 2568)
VBA in Other WinCC Editors (Page 2563)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2567
VBA for Automated Configuration
3.6 VBA Reference
CloseTag Function
Description
Closes the open tag.
Note
Modified parameters are not saved.
Syntax
Expression.CloseTag()
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
--
Example:
Sub CloseTag()
' HMIGO_001
' procedure to close a variable
' tag need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim strVariableName As String
Set objHMIGO = New HMIGO
strVariableName = "NewVariable"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTag, vbOKOnly, "Status Variable"
'open a tag
objHMIGO.GetTag strVariableName
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTag, vbOKOnly, "Status Variable"
'open a tag
objHMIGO.CloseTag
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTag, vbOKOnly, "Status Variable"
Set objHMIGO = Nothing
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2568 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
ListTag function (Page 2574)
GetTag Function (Page 2573)
DeleteTag Function (Page 2572)
CreateTag Function (Page 2570)
CommitTag Function (Page 2569)
VBA in Tag Management (Page 2565)
CommitTag Function
Description
Writes the changed parameters of the open tag to WinCC.
Note
If further parameters are changed after a CommitTag call, write the changes to WinCC by
calling this function again.
syntax
Expression.CommitTag()
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2569
VBA for Automated Configuration
3.6 VBA Reference
Example:
Sub CommitTag()
' HMIGO_002
' procedure to change a property of a variable
' tag need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim strVariableName As String
Set objHMIGO = New HMIGO
strVariableName = "NewVariable"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTag, vbOKOnly, "Status Variable"
'open a tag
objHMIGO.GetTag strVariableName
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTag, vbOKOnly, "Status Variable"
'change a property
objHMIGO.TagStart = 10
'current status is "MODIFIED"
MsgBox objHMIGO.ObjectStateTag, vbOKOnly, "Status Variable"
'commit a tag
objHMIGO.CommitTag
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTag, vbOKOnly, "Status Variable"
Set objHMIGO = Nothing
End Sub
See also
ListTag function (Page 2574)
GetTag Function (Page 2573)
DeleteTag Function (Page 2572)
CreateTag Function (Page 2570)
CloseTag Function (Page 2568)
VBA in Tag Management (Page 2565)
CreateTag Function
Description
Creates a new tag.
Syntax
Expression.CreateTag(TagName,TagType,[Connection],[S7S5Address],
[GroupName])
WinCC: Scripting (VBS, ANSI-C, VBA)
2570 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Expression
Required. An expression which returns a "HMIGO" type object.
Parameter
Parameter (Data Type) Description
TagName (string) Name of the tag to be created.
TagType (HMIGO_TAG_TYPE) Data type of the tags. Possible types are:
TAG_BINARY_TAG
TAG_SIGNED_8BIT_VALUE
TAG_UNSIGNED_8BIT_VALUE
TAG_SIGNED_16BIT_VALUE
TAG_UNSIGNED_16BIT_VALUE
TAG_SIGNED_32BIT_VALUE
TAG_UNSIGNED_32BIT_VALUE
TAG_FLOATINGPOINT_NUM‐
BER_32BIT_IEEE_754
TAG_FLOATINGPOINT_NUM‐
BER_64BIT_IEEE_754
TAG_TEXT_TAG_8BIT_CHARACTER_SET
TAG_TEXT_TAG_16BIT_CHARACTER_SET
TAG_RAW_DATA_TYPE
TAG_TEXT_REFERENCE
TAG_DATE_TIME
Connection (String, optional) Name of a connection in which the tag and/or
group is to be created. The connection must al‐
ready exist, otherwise a tag cannot be created.
If the name is omitted, an internal tag and/or group
is recreated.
S7S5Address (String, optional) Address of the S7 or S5 PLC to which the tag is
connected. Without an address indication, an emp‐
ty entry is passed.
The "S7S5Address" parameter must be supple‐
mented with the string ",QC" for the configuration
of the Quality Code, for example: "DB1,DD0,QC".
If the Quality Code of the tag is no longer to be
monitored, the ",QC" string must be deleted.
GroupName (String, optional) Name of a group in which the tag is inserted. If the
group does not yet exist, it is created new.
If the group name is not indicated, the tag is cre‐
ated outside all groups.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2571
VBA for Automated Configuration
3.6 VBA Reference
Example
Sub CreateTag()
' HMIGO_003
' procedure to create a variable
' tag must not be created before
' declarations
Dim objHMIGO As HMIGO
Dim strVariableName As String
Set objHMIGO = New HMIGO
strVariableName = "NewVariable"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTag, vbOKOnly, "Status Variable"
'create a tag
objHMIGO.CreateTag strVariableName, TAG_SIGNED_32BIT_VALUE
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTag, vbOKOnly, "Status Variable"
Set objHMIGO = Nothing
End Sub
See also
ListTag function (Page 2574)
GetTag Function (Page 2573)
DeleteTag Function (Page 2572)
CommitTag Function (Page 2569)
CloseTag Function (Page 2568)
VBA in Tag Management (Page 2565)
DeleteTag Function
Description
Deletes the specified tag.
syntax
Expression.DeleteTag(TagName)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
TagName (string) Name of the tag to be deleted.
WinCC: Scripting (VBS, ANSI-C, VBA)
2572 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
Sub DeleteTag()
' HMIGO_004
' procedure to delete a variable
' tag need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim strVariableName As String
Set objHMIGO = New HMIGO
strVariableName = "NewVariable"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTag, vbOKOnly, "Status Variable"
'delete a tag
objHMIGO.DeleteTag strVariableName
Set objHMIGO = Nothing
End Sub
See also
ListTag function (Page 2574)
GetTag Function (Page 2573)
CreateTag Function (Page 2570)
CommitTag Function (Page 2569)
CloseTag Function (Page 2568)
VBA in Tag Management (Page 2565)
GetTag Function
Description
Reads in the parameters of the specified tag.
You can change or read the parameters by means of the object properties. You will find a list
of the available object properties in this documentation under "VBA in Tag Management".
syntax
Expression.GetTag(TagName)
Expression
Necessary. An expression which returns a "HMIGO" type object.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2573
VBA for Automated Configuration
3.6 VBA Reference
Parameters
Parameter (Data Type) Description
TagName (string) Name of the tag whose values are to be read in.
Example:
Sub GetTag()
' HMIGO_005
' procedure to open a variable
' tag need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim strVariableName As String
Set objHMIGO = New HMIGO
strVariableName = "NewVariable"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTag, vbOKOnly, "Status Variable"
'open/ get a tag
objHMIGO.GetTag strVariableName
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTag, vbOKOnly, "Status Variable"
Set objHMIGO = Nothing
End Sub
See also
ListTag function (Page 2574)
DeleteTag Function (Page 2572)
CreateTag Function (Page 2570)
CommitTag Function (Page 2569)
CloseTag Function (Page 2568)
VBA in Tag Management (Page 2565)
ListTag function
Description
Alternatively, the ListTag function returns the following contents of the Tag Management as a
list:
● All the channel units created
● All the channels created
● All the connections created
WinCC: Scripting (VBS, ANSI-C, VBA)
2574 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
● All the tag groups created
● All the tags created
syntax
Expression.ListTag(ListType,pListArray,[Filter])
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
ListType (HMIGO_TAG_LIST_TYPE) Defines which content should be returned as a list.
Possibilities are:
● TAG_CHANNEL_UNITS (0) all channel units
created
● TAG_CHANNELS (2) all channels created
● TAG_CONNECTIONS (3) all connections
created
● TAG_GROUPS (4) all tag groups created
● TAG_NAMES (5) all tags created
pListArray (Variant) List with the requested content.
Filter (String) Filters can be set optionally. Wildcards "*" and "?"
are also possible.
Example:
In the following example, a check is made whether the list with the connections created is
empty because no connections have been set up:
Sub ReadTagByConnection()
'HMIGO_027
'read content in data manager by connections
'no conections are implemented
Dim objHMIGO As New HMIGO
Dim varRange As Variant
'read all connections
objHMIGO.ListTag TAG_CONNECTIONS, arrContent
'check result
If (UBound(arrContent) - LBound(arrContent) + 1) <= 0 Then
MsgBox "no entries because no connections are implemented"
End If
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2575
VBA for Automated Configuration
3.6 VBA Reference
See also
GetTag Function (Page 2573)
DeleteTag Function (Page 2572)
CreateTag Function (Page 2570)
CommitTag Function (Page 2569)
CloseTag Function (Page 2568)
VBA in Tag Management (Page 2565)
3.6.2.3 VBA im Tag Logging
VBA in Tag Logging
Introduction
VBA allows you to create process value archives, archive tags and triggers directly from the
program code, modify them, and delete them.
Note
You should not have or should not open the "Tag Logging" editor when editing with VBA.
Principle
When you have created the instance of the "HMIGO" class, the following functions are available
to you to access Tag Logging:
● CloseTlgArchive
● CloseTlgTag
● CloseTlgTrigger
● CommitTlgArchive
● CommitTlgTag
● CommitTlgTrigger
● CreateTlgArchive
● CreateTlgTag
● CreateTlgTrigger
● DeleteTlgArchive
● DeleteTlgTag
● DeleteTlgTrigger
● GetTlgArchive
WinCC: Scripting (VBS, ANSI-C, VBA)
2576 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
● GetTlgTag
● GetTlgTrigger
● ListTlgArchive
● ListTlgTag
● ListTlgTrigger
The following enumerations are available for the parameter supply of these functions:
● HMIGO_TLG_ARCHIVE_TYPE
● HMIGO_TLG_ARCHIVE_LIST_TYPE
● HMIGO_TLG_TAG_TYPE
● HMIGO_TLG_TAG_LIST_TYPE
● HMIGO_TLG_TRIGGER_BASE
● HMIGO_TLG_TRIGGER_LIST_TYPE
Direct Access to the Object Properties
You can also access the parameters of the above-mentioned functions directly in VBA by
means of the following object properties. The column "is used in" will display whether you will
be able to access the object property in the process value archive (P) and/or in the compressed
archive (V).
Object property Description Read/ is used in
Write
ObjectStateTlgArchive Returns the object state for the archive via the enumera‐ Yes/no P, V
tion "HMIGO_OBJECT_STATE". Further information on
this enumeration can be found in this documentation un‐
der "VBA in other WinCC Editors".
ObjectStateTlgTag Returns the object state for the archive tag via the enu‐ Yes/no P, V
meration "HMIGO_OBJECT_STATE".
TlgArchiveAccessLevelRead The authorization level for reading. Yes/no P, V
TlgArchiveAccessLevelWrite The authorization level for writing. Yes/no P, V
TlgArchiveArchiveState Specifies whether archiving is disabled or enabled at Yes/yes P, V
system startup. Possible values of the enum "HMI‐
GO_TLG_ARCHIVE_STATE":
● TLG_ARCHIVE_STATE_LOCKED (1)
● TLG_ARCHIVE_STATE_ACTIVATED (0)
TlgArchiveBufferSize Specifies the number of records for a short-term archive. Yes/yes P
TlgArchiveBufferType Specifies the tag storage location. The possible types of Yes/yes P
the enum "HMIGO_TLG_ARCHIVE_BUFFER_TYPE":
● TLG_ARCHIVE_BUFFER_TYPE_DISK (2)
● TLG_ARCHIVE_BUFFER_TYPE_RAM (1)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2577
VBA for Automated Configuration
3.6 VBA Reference
Object property Description Read/ is used in
Write
TlgArchiveCompressRange Specifies the compression time period. Name of the tim‐ Yes/yes V
er, greater than or equal to 1, defined under "Times" in
the Tag Logging editor. Since the format is a string, it is
language dependent.
Can be determined via the function "ListTlgArch‐
ive(TLG_ARCHIVE_TRIGGER_NAMES, arrTrigger)"
TlgArchiveCompressType Specifies the algorithm for compressing the values. The Yes/yes V
possible types of the enum "HMIGO_TLG_AR‐
CHIVE_COMPRESS_TYPE":
● TLG_COMPRESS_TYPE_CALC (1)
● TLG_COMPRESS_TYPE_CALC_COPY (2)
● TLG_COMPRESS_TYPE_CALC_DEL (3)
● TLG_COMPRESS_TYPE_CALC_COPY_DEL (4)
TlgArchiveFlags Used internally.
TlgArchiveName Name of the process value archive or compressed ar‐ Yes/no P, V
chive.
TlgArchiveQCRActive Specifies for the compressed archive whether weighted V
quality codes are used during archiving. The possible
types of the enum "HMIGO_TLG_QCR_AC‐
TIVE_FLAGS":
● TLG_QCR_ALL (15)
● TLG_QCR_BAD (1)
● TLG_QCR_GOOD_CASCADED (8)
● TLG_QCR_GOOD_NONCASCADED (4)
● TLG_QCR_OFF (0)
● TLG_QCR_UNCERTAIN (2)
TlgArchiveQCRBad If weighted quality codes are used and the "Bad" option V
is activated, you define for the compression archive the
percentage as of which the "Bad" state of process values
is archived in the compression tag.
TlgArchiveQCRGoodCascade If weighted quality codes are used and the "Good (Cas‐ V
cade)" option is activated, you define for the compression
tag the percentage as of which the "Good (Cascade)"
state of process values is archived in the compression
tag.
TlgArchiveQCRGoodNonCas‐ If weighted quality codes are used and the "Good (Non- V
cade Cascade)" option is activated, you define for the com‐
pression archive the percentage as of which the "Good
(Non-Cascade)" state of process values is archived in
the compression tag.
TlgArchiveQCRUncertain If weighted quality codes are used and the "Uncertain" V
option is activated, you define for the compression ar‐
chive the percentage as of which the "Uncertain" state of
process values is archived in the compression tag.
TlgArchiveType Specifies whether the archive is a process value archive Yes/no P, V
or a compressed archive.
TlgTagAliasName The alternative name by means of which the tag can be Yes/yes P
addressed (alias).
WinCC: Scripting (VBS, ANSI-C, VBA)
2578 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Object property Description Read/ is used in
Write
TlgTagArchiveName Name of the archive. Yes/no P, V
TlgTagArchiving Specifies the acquisition type. Possible values of the Yes/yes P
enum "HMIGO_TLG_TAG_ARCHIVING":
● TLG_TAG_ACYCLIC (8388609)
● TLG_TAG_CYCLIC_CONTINUOUS (8388610)
● TLG_TAG_CYCLIC_SELECTIVE (8388612)
● TLG_TAG_ON_EVERY_CHANGE (8388616)
● TLG_TAG_ON_DEMAND (8388672)
TlgTagArchivingState Specifies whether archiving is enabled or disabled at Yes/yes P, V
system startup. Possible values of the enum "HMI‐
GO_TLG_TAG_ARCHIVING_STATE":
● TLG_TAG_LOCKED (1)
● TLG_TAG_ACTIVATED (0)
TlgTagConvertModule Name of the conversion DLL used for data conversion. Yes/yes P
TlgTagFlags Possible values of the enum "HMI‐
GO_TLG_TAG_FLAGS":
● TLG_TAG_LONGTERM_DISABLED (1)
● TLG_TAG_NOFLAGS (0)
TlgTagHysterese Value for the hysteresis by means of which a check is Yes/yes P
carried out to establish whether a value has changed.
TlgTagLowerLimit Value for the scaling of the tag's lower limit. Yes/yes P
TlgTagMethodType Specifies the method by which the value is edited before Yes/yes P, V
archiving. Possible values of the enum "HMI‐
GO_TLG_TAG_METHOD_TYPE":
● TLG_TAG_ACTUAL (1)
● TLG_TAG_SUM (3)
● TLG_TAG_MaxValue (5)
● TLG_TAG_MinValue (4)
● TLG_TAG_AVERAGE (2)
TlgTagName Name of the archive tag. Yes/no P, V
TlgTagNameCompressArchive In the case of compressed archives, contains the name Yes/yes V
of the source archive.
TlgTagNameCompressTag In the case of compressed archives, contains the name Yes/yes V
of the source tag.
TlgTagNameProcTag Name of the process tag from which the value to be ac‐ Yes/yes P
quired is taken.
TlgTagNameRawValue In the cast of process-controlled archives, contains the Yes/yes P
name of the raw-data tag.
TlgTagOnChange Specifies whether archiving is to be carried out in the Yes/yes P
event of a change. Possible values of the enum "HMI‐
GO_TLG_TAG_ON_CHANGE":
● TLG_TAG_EVERY_VALUE (0)
● TLG_TAG_RELATIVE_HYSTERESE (1)
● TLG_TAG_ABSOLUTE_HYSTERESE (2)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2579
VBA for Automated Configuration
3.6 VBA Reference
Object property Description Read/ is used in
Write
TlgTagOnError Specifies whether, in the event of a problem, the most Yes/yes P
recently acquired value or the substitute value is saved.
Possible values of the enum "HMI‐
GO_TLG_TAG_ON_ERROR":
● TLG_TAG_LAST_VALUE (1)
● TLG_TAG_SUBSTITUTE (2)
TlgTagPreviousOSGUID Used internally.
TlgTagQCRActive Specifies for the compression tag whether weighted qual‐ V
ity codes are used during archiving. The possible types
of the enum "HMIGO_TLG_QCR_ACTIVE_FLAGS":
● TLG_QCR_ALL (15)
● TLG_QCR_BAD (1)
● TLG_QCR_GOOD_CASCADED (8)
● TLG_QCR_GOOD_NONCASCADED (4)
● TLG_QCR_OFF (0)
● TLG_QCR_UNCERTAIN (2)
TlgTagQCRBad If weighted quality codes are used and the "Bad" option V
is activated, you define for the compression tag the per‐
centage as of which the "Bad" state of process values is
archived in the compression tag.
TlgTagQCRGoodCascade If weighted quality codes are used and the "Good (Cas‐ V
cade)" option is activated, you define for the compression
tag the percentage as of which the "Good (Cascade)"
state of process values is archived in the compression
tag.
TlgTagQCRGoodNonCascade If weighted quality codes are used and the "Good (Non- V
Cascade)" option is activated, you define for the com‐
pression tag the percentage as of which the "Good (Non-
Cascade)" state of process values is archived in the com‐
pression tag.
TlgTagQCRUncertain If weighted quality codes are used and the "Uncertain" V
option is activated, you define for the compression tag
the percentage as of which the "Uncertain" state of proc‐
ess values is archived in the compression tag.
TlgTagSDCompressDeviation Specifies the absolute or relative value of the deviation, P
which is permitted for the calculation of the increase by
the algorithm. Basic value is the process value saved last.
TlgTagSDCompression Specifies whether the swinging door compression is ac‐ P
tivated.
TlgTagSDLowLimit Specifies the low limit of the swinging door compression P
distribution when a relative deviation is activated.
TlgTagSDRelativeDecision Specifies whether the relative value of the deviation is P
taken into consideration at the swinging door algorithm.
TlgTagSDtMax Specifies the maximum duration between two archived P
values as the detection limit for swinging door compres‐
sion.
WinCC: Scripting (VBS, ANSI-C, VBA)
2580 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Object property Description Read/ is used in
Write
TlgTagSDtMin Specifies the minimum duration between two archived P
values as the detection limit for swinging door compres‐
sion.
TlgTagSDUpperLimit Specifies the upper limit of the swinging door compres‐ P
sion distribution when a relative deviation is activated.
TlgTagStartEvent Name of the tag by means of which the start of archiving Yes/yes P
is checked.
TlgTagStartTriggerFunction Specifies the name of a script function by means of which Yes/yes P
a check is carried out for a start event for the start of
archiving.
TlgTagStopEvent Name of the tag by means of which the stopping of ar‐ Yes/yes P
chiving is checked.
TlgTagStopTriggerFunction Specifies the name of a script function by means of which Yes/yes P
a check is carried out for a stop event for the start of
archiving.
TlgTagTriggerArchiving Name of the timer for the archiving cycle. Yes/yes P
TlgTagTriggerFactor Contains the factor for the display cycle as a multiple of Yes/yes P
the archiving cycle.
TlgTagTriggerFunction Specifies the name of a script function for the dynamic Yes/yes P
switching of the acquisition and archiving cycles.
TlgTagTriggerScan Name of the timer for the acquisition cycle Yes/yes P
TlgTagTriggerType Specifies how archiving is carried out at a signal change. Yes/yes P
Possible values of the enum "HMIGO_TLG_TAG_TRIG‐
GER_TYPE":
● TLG_TAG_FROM_0_TO_1 (2)
● TLG_TAG_FROM_1_TO_0 (3)
● TLG_TAG_ALWAYS (4)
● TLG_TAG_EVERY_CHANGE (1)
TlgTagType Specifies the tag type. The possible types of the enum Yes/yes P, V
"HMIGO_TLG_TAG_TYPE":
● TLG_TAG_TYP_ANALOG (65537)
● TLG_TAG_TYP_BINARY (65538)
● TLG_TAG_TYP_PROCESS (65544)
● TLG_TAG_TYP_COMPRESS (65540)
TlgTagUpperLimit Value for the scaling of the tag's upper limit. Yes/yes P
TlgTriggerBase Time base for the trigger. Possible values of the enum P
"HMIGO_TLG_TRIGGER_BASE":
● TLG_TRIGGER_BASE_250MS (250)
● TLG_TRIGGER_BASE_500MS (500)
● TLG_TRIGGER_BASE_DAY (&H5265C00)
● TLG_TRIGGER_BASE_HOUR (&H36EE80)
● TLG_TRIGGER_BASE_MIN (&HEA60)
● TLG_TRIGGER_BASE_SEC (&H3E8)
TlgTriggerCreatorID Used internally. P
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2581
VBA for Automated Configuration
3.6 VBA Reference
Object property Description Read/ is used in
Write
TlgTriggerFactor Integer factor that is taken into consideration for the trig‐ P
ger together with the time base.
TlgTriggerName Name of the trigger. P
TlgTriggerScheduleDayOfMonth Specifies the day for the trigger for the "Monthly" time P
series.
TlgTriggerScheduleDaysOfWeek Specifies the days for the trigger for the "Weekly" time P
series. Possible values of the enum "HMIGO_TLG_TRIG‐
GER_SCHEDULE_DAYSOFWEEK":
● TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_EVE
RY_DAY (127)
● TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_FRI
DAY (32)
● TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_MO
NDAY (2)
● TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_NO_
DAY (0)
● TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_SAT
URDAY (64)
● TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_SUN
DAY (1)
● TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_THU
RSDAY (16)
● TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_TUE
SDAY (4)
● TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_WE
DNESDAY (8)
TlgTriggerScheduleInterval Specifies the interval for the trigger for the calendar times. P
TlgTriggerScheduleMonthOf‐ Specifies the month for the trigger for the "Yearly" time P
Year series.
TlgTriggerScheduleType Defines the type of trigger. Possible time series of the P
enum "HMIGO_TLG_TRIGGER_SCHEDULE_TYPE":
● TLG_TRIGGER_SCHEDULE_TYPE_CYCLIC (0)
● TLG_TRIGGER_SCHEDULE_TYPE_DAILY (1)
● TLG_TRIGGER_SCHEDULE_TYPE_MONTHLY (3)
● TLG_TRIGGER_SCHEDULE_TYPE_WEEKLY (2)
● TLG_TRIGGER_SCHEDULE_TYPE_YEARLY (4)
TlgTriggerStartByShutdown The trigger is initiated additionally when the system is P
shut down regardless of the configured triggers.
TlgTriggerStartByStartup The trigger is initiated additionally when the system is P
started up regardless of the configured triggers.
TlgTriggerStartDay Specifies the day for the starting point of the trigger. P
TlgTriggerStartHour Specifies the hour for the starting point of the trigger. P
TlgTriggerStartMilliSecond Specifies the milliseconds for the starting point of the P
trigger.
TlgTriggerStartMinute Specifies the minute for the starting point of the trigger. P
WinCC: Scripting (VBS, ANSI-C, VBA)
2582 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Object property Description Read/ is used in
Write
TlgTriggerStartMonth Specifies the month for the starting point of the trigger. P
TlgTriggerStartSecond Specifies the seconds for the starting point of the trigger. P
TlgTriggerStartYear Specifies the year for the starting point of the trigger. P
See also
ListTlgTag Function (Page 2608)
ListTlgArchive Function (Page 2606)
GetTlgArchive Function (Page 2603)
DeleteTlgTag Function (Page 2601)
DeleteTlgArchive Function (Page 2600)
CreateTlgTag Function (Page 2594)
CreateTlgArchive Function (Page 2591)
CommitTlgTag Function (Page 2589)
CommitTlgArchive Function (Page 2587)
CloseTlgTag Function (Page 2585)
CloseTlgArchive Function (Page 2583)
VBA in Other WinCC Editors (Page 2563)
CloseTlgTrigger function (Page 2586)
CommitTlgTrigger function (Page 2591)
CreateTlgTrigger function (Page 2598)
DeleteTlgTrigger function (Page 2602)
GetTlgTrigger function (Page 2606)
ListTlgTrigger function (Page 2609)
CloseTlgArchive Function
Description
Closes the process value or compressed archive which is open.
Note
Modified parameters are not saved.
syntax
Expression.CloseTlgArchive()
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2583
VBA for Automated Configuration
3.6 VBA Reference
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
--
Example:
Sub CloseTlgArchive()
' HMIGO_006
' procedure to close an archive
' the archive need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim strArchiveName As String
Set objHMIGO = New HMIGO
strArchiveName = "NewArchive"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTlgArchive, vbOKOnly, "Status Tlg Archive"
'open archive
objHMIGO.GetTlgArchive strArchiveName
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTlgArchive, vbOKOnly, "Status Tlg Archive"
'close archive
objHMIGO.CloseTlgArchive
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTlgArchive, vbOKOnly, "Status Tlg Archive"
Set objHMIGO = Nothing
End Sub
See also
ListTlgTag Function (Page 2608)
ListTlgArchive Function (Page 2606)
GetTlgArchive Function (Page 2603)
DeleteTlgTag Function (Page 2601)
DeleteTlgArchive Function (Page 2600)
CreateTlgTag Function (Page 2594)
CreateTlgArchive Function (Page 2591)
CommitTlgTag Function (Page 2589)
CommitTlgArchive Function (Page 2587)
CloseTlgTag Function (Page 2585)
VBA in Tag Logging (Page 2576)
WinCC: Scripting (VBS, ANSI-C, VBA)
2584 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
CloseTlgTag Function
Description
Closes the archive tag which is open.
Note
Modified parameters are not saved.
syntax
Expression.CloseTlgTag()
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
--
Example:
Sub CloseTlgTag()
' HMIGO_007
' procedure to close a tag logging tag
' the archive need to be created before
' the tag logging tag need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim strArchiveName As String
Dim strTlgTagName As String
Set objHMIGO = New HMIGO
strArchiveName = "NewArchive"
strTlgTagName = "NewTag"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTlgTag, vbOKOnly, "Status Tlg Tag"
'open/ get tag logging tag
objHMIGO.GetTlgTag strArchiveName, strTlgTagName
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTlgTag, vbOKOnly, "Status Tlg Archive"
'close tag logging tag
objHMIGO.CloseTlgTag
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTlgTag, vbOKOnly, "Status Tlg Archive"
Set objHMIGO = Nothing
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2585
VBA for Automated Configuration
3.6 VBA Reference
See also
ListTlgTag Function (Page 2608)
ListTlgArchive Function (Page 2606)
GetTlgArchive Function (Page 2603)
DeleteTlgTag Function (Page 2601)
DeleteTlgArchive Function (Page 2600)
CreateTlgTag Function (Page 2594)
CreateTlgArchive Function (Page 2591)
CommitTlgTag Function (Page 2589)
CommitTlgArchive Function (Page 2587)
CloseTlgArchive Function (Page 2583)
VBA in Tag Logging (Page 2576)
CloseTlgTrigger function
Description
Closes the opened trigger.
Note
Modified parameters are not saved.
Syntax
Expression.CloseTlgTrigger()
Expression
Required. An expression which returns a "HMIGO" type object.
Parameter
--
WinCC: Scripting (VBS, ANSI-C, VBA)
2586 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
CommitTlgArchive Function
Description
Writes the changed parameters of the specified archive to WinCC.
Note
If further parameters are changed after a CommitTlgArchive call, write the changes to WinCC
by calling this function again.
syntax
Expression.CommitTlgArchive()
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2587
VBA for Automated Configuration
3.6 VBA Reference
Example:
Sub CommitTlgArchive()
' HMIGO_008
' procedure to change a property of an archive
' the archive need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim strArchiveName As String
Set objHMIGO = New HMIGO
strArchiveName = "NewArchive"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTlgArchive, vbOKOnly, "Status Tlg Archive"
'open archive
objHMIGO.GetTlgArchive strArchiveName
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTlgArchive, vbOKOnly, "Status Tlg Archive"
'change a property
objHMIGO.TlgArchiveArchiveState = TLG_STATE_LOCKED
'current status is "MODIFIED"
MsgBox objHMIGO.ObjectStateTlgArchive, vbOKOnly, "Status Tlg Archive"
'commit archive
objHMIGO.CommitTlgArchive
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTlgArchive, vbOKOnly, "Status Tlg Archive"
Set objHMIGO = Nothing
End Sub
See also
DeleteTlgArchive Function (Page 2600)
ListTlgTag Function (Page 2608)
ListTlgArchive Function (Page 2606)
GetTlgArchive Function (Page 2603)
DeleteTlgTag Function (Page 2601)
CreateTlgTag Function (Page 2594)
CreateTlgArchive Function (Page 2591)
CommitTlgTag Function (Page 2589)
CloseTlgTag Function (Page 2585)
CloseTlgArchive Function (Page 2583)
VBA in Tag Logging (Page 2576)
WinCC: Scripting (VBS, ANSI-C, VBA)
2588 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
CommitTlgTag Function
Description
Writes the changed parameters of the specified archive tag to WinCC.
Note
If further parameters are changed after a CommitTlgTag call, write the changes to WinCC by
calling this function again.
syntax
Expression.CommitTlgTag()
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2589
VBA for Automated Configuration
3.6 VBA Reference
Example:
Sub CommitTlgTag()
' HMIGO_009
' procedure to change a property of a tag logging tag
' the archive need to be created before
' the tag logging tag need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim strArchiveName As String
Dim strTlgTagName As String
Set objHMIGO = New HMIGO
strArchiveName = "NewArchive"
strTlgTagName = "NewTag"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTlgTag, vbOKOnly, "Status Tlg Tag"
'open/ get tag logging tag
objHMIGO.GetTlgTag strArchiveName, strTlgTagName
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTlgTag, vbOKOnly, "Status Tlg Archive"
'change a property
objHMIGO.TlgTagArchiving = TLG_TAG_ON_EVERY_CHANGE
'current status is "MODIFIED"
MsgBox objHMIGO.ObjectStateTlgTag, vbOKOnly, "Status Tlg Archive"
'commit tag logging tag
objHMIGO.CommitTlgTag
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTlgTag, vbOKOnly, "Status Tlg Archive"
Set objHMIGO = Nothing
End Sub
See also
ListTlgTag Function (Page 2608)
ListTlgArchive Function (Page 2606)
GetTlgArchive Function (Page 2603)
DeleteTlgTag Function (Page 2601)
DeleteTlgArchive Function (Page 2600)
CreateTlgTag Function (Page 2594)
CreateTlgArchive Function (Page 2591)
CommitTlgTag Function (Page 2589)
CommitTlgArchive Function (Page 2587)
CloseTlgTag Function (Page 2585)
CloseTlgArchive Function (Page 2583)
VBA in Tag Logging (Page 2576)
WinCC: Scripting (VBS, ANSI-C, VBA)
2590 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
CommitTlgTrigger function
Description
Writes the changed parameters of the specified trigger to WinCC.
Note
If further parameters are changed after a CommitTlgTrigger call, write the changes to WinCC
by calling this function again.
Syntax
Expression.CommitTlgTrigger()
Expression
Required. An expression which returns a "HMIGO" type object.
Parameter
--
CreateTlgArchive Function
Description
Creates a process value archive or compressed archive.
syntax
Expression.CreateTlgArchive(ArchiveName,ArchiveType)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
ArchiveName (String) Name of the archive to be created
ArchiveType (HMIGO_TLG_ARCHIVE_TYPE) Type of the archive. The possible types are:
● TLG_PROCESSARCHIVE (131073) for a
process value archive
● TLG_COMPRESSARCHIVE (131074) for a
compressed archive
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2591
VBA for Automated Configuration
3.6 VBA Reference
Default Values when Creating a New Tag Archive
The following table indicates the default values that are entered when a new process value
archive or compressed archive is created. These values can be modified later and written using
the CommitTlgArchive function.
Property Default Value (Enum Name => Val‐ Comment
ue)
TlgArchiveAccessLevel‐ 0 Without authorization level
Read
TlgArchiveAccessLevel‐ 0 Without authorization level
Write
TlgArchiveArchiveState TLG_ARCHIVE_STATE_ACTIVA‐ Archiving is started at start of Run‐
TED (0) time.
TlgArchiveBufferSize 1000 Number of data records
TlgArchiveBufferType TLG_ARCHIVE_BUF‐ The values are stored on hard disk
FER_TYPE_DISK (2) in the database.
TlgArchiveCompress‐ "1 Tag". This string must be created Corresponds to exactly one day.
Range individually for each language (e.g. Only relevant in the case of com‐
English: "1 day") pressed tags.
Special Feature: the user is respon‐
sible for values >= 1 minute
TlgArchiveCompressType TLG_COMPRESS_TYPE_CALC (1) Only calculate compression val‐
ues. Only relevant in the case of
compressed tags.
Enum HMIGO_TLG_ARCHIVE_STATE
Parameters Description
TLG_ARCHIVE_STATE_LOCKED (1) Archiving is disabled at system startup.
TLG_ARCHIVE_STATE_ACTIVATED (0) Archiving is started at start of Runtime.
Enum HMIGO_TLG_ARCHIVE_BUFFER_TYPE
Parameters Description
TLG_ARCHIVE_BUFFER_TYPE_DISK (2) The values are archived on hard disk.
TLG_ARCHIVE_BUFFER_TYPE_RAM (1) The values are only archived in working memory.
Enum HMIGO_TLG_ARCHIVE_COMPRESS_TYPE
Parameters Description
TLG_COMPRESS_TYPE_CALC (1) Only the compression values are calculated.
TLG_COMPRESS_TYPE_CALC_COPY (2) The compression values are calculated and the original
values copied.
WinCC: Scripting (VBS, ANSI-C, VBA)
2592 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameters Description
TLG_COMPRESS_TYPE_CALC_DEL (3) The compression values are calculated and the original
values then deleted.
TLG_COM‐ The compression values are calculated and the original
PRESS_TYPE_CALC_COPY_DEL (4) values copied and then deleted.
Example:
Sub CreateTlgArchive()
' HMIGO_010
' procedure to create an archive
' the archive must not be created before
' declarations
Dim objHMIGO As HMIGO
Dim strArchiveName As String
Set objHMIGO = New HMIGO
strArchiveName = "NewArchive"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTlgArchive, vbOKOnly, "Status Tlg Archive"
'create tag logging archive
objHMIGO.CreateTlgArchive strArchiveName, TLG_PROCESSARCHIVE
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTlgArchive, vbOKOnly, "Status Tlg Archive"
Set objHMIGO = Nothing
End Sub
See also
GetTlgArchive Function (Page 2603)
ListTlgTag Function (Page 2608)
ListTlgArchive Function (Page 2606)
DeleteTlgTag Function (Page 2601)
DeleteTlgArchive Function (Page 2600)
CreateTlgTag Function (Page 2594)
CommitTlgTag Function (Page 2589)
CommitTlgArchive Function (Page 2587)
CloseTlgTag Function (Page 2585)
CloseTlgArchive Function (Page 2583)
VBA in Tag Logging (Page 2576)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2593
VBA for Automated Configuration
3.6 VBA Reference
CreateTlgTag Function
Description
Creates a new archive tag.
Syntax
Expression.CreateTlgTag(ArchiveName,TagName,[TagType])
Expression
Required. An expression which returns a "HMIGO" type object.
Parameter
Parameter (Data Type) Description
ArchiveName (String) Name of an existing archive in which the tag is to be entered
TagName (string) Name of the tag to be created
TagType (HMIGO_TLG_TAG_TYPE, Specifies the type of the tag. If no type is specified, the default
optional) value TLG_VAR_TYP_ANALOG is entered. Possible types
are:
● TLG_VAR_TYP_ANALOG (65537) for an analog tag.
● TLG_VAT_TYP_BINARY (65538) for a binary tag.
● TLG_VAR_TYP_PROCESS (65544) for a process tag.
● TLG_VAT_TYP_COMPRESS (65540) for a compression
tag.
● TLG_TAG_TYPE_STRING (65568) for a text tag.
Default Values When a New Archive Tag Is Created
The following table indicates the default values that are entered when a new archive tag is
created. These values can be modified later and written using the CommitTlgTag function.
Property Default Value (Enum Name => Value) Note
TlgTagType TLG_VAR_TYP_ANALOG (65537) Acquired by means of an ana‐
log data manager tag
TlgTagArchiving TLG_TAG_CYCLIC_CONTINUOUS Cyclic, continuous acquisition
(8388610)
TlgTagArchivingState TLG_TAG_ACTIVATED (0) Archiving is started at start of
Runtime.
TlgTagTriggerScan 1 second Please note that "1 second" is
only the name of the trigger.
You must ensure yourself that
the trigger exists and actually
has a cycle of 1 s.
WinCC: Scripting (VBS, ANSI-C, VBA)
2594 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Property Default Value (Enum Name => Value) Note
TlgTagTriggerArchiving 1 second Please note that "1 second" is
only the name of the trigger.
You must ensure yourself that
the trigger exists and actually
has a cycle of 1 s.
TlgTagTriggerFactor 1 The display cycle and archiving
cycle are identical.
TlgTagOnError TLG_TAG_LAST_VALUE (1) The last valid value is taken as
the substitute value.
TlgTagTriggerType TLG_TAG_ALWAYS (4) Every value is archived.
TlgTagMethodType TLG_TAG_ACTUAL (1) No editing. The value is accep‐
ted immediately.
TlgTagStartTriggerFunction No function specified --
TlgTagStopTriggerFunction No function specified --
TlgTagTriggerFunction No function specified --
TlgTagUpperLimit No value specified --
TlgTagLowerLimit No value specified --
TlgTagNameCompres‐ No archive name specified --
sArchive
TlgTagNameCompressTag No tag name specified --
TlgTagNameRawValue No raw data tag specified --
TlgTagNameProcTag Corresponds to "TagName" --
TlgTagOnChange TLG_TAG_EVERY_VALUE (0) Every value is archived.
TlgTagHysterese 0 No check is carried out by
means of hysteresis.
TlgTagAliasName No value specified --
TlgTagStartEvent No tag specified --
TlgTagStopEvent No tag specified --
List of the enumerators for Tag Logging
Enum types Description
TLG_TAG_TYPE The passed parameter specifies the type of the tag. The possible types
are in the table Enum HMIGO_TLG_TAG_TYPE.
TLG_TAG_ARCHIVING The passed parameter specifies the acquisition type. The possible
values are in the table Enum HMIGO_TLG_TAG_ARCHIVING.
TLG_TAG_ARCHIV‐ The passed parameter specifies whether archiving is disabled or ena‐
ING_STATE bled at system startup. The possible values are in the table Enum
HMIGO_TLG_TAG_ARCHIVING_STATE.
TLG_TAG_ON_ERROR The passed parameter specifies which value is stored in the event of
a problem: the most recently acquired value or the substitute value.
The possible values are in the table Enum HMI‐
GO_TLG_TAG_ON_ERROR.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2595
VBA for Automated Configuration
3.6 VBA Reference
Enum types Description
TLG_TAG_TRIGGER_TYPE The passed parameter specifies how archiving is carried out at a signal
change. The possible values are in the table Enum HMI‐
GO_TLG_TAG_TRIGGER_TYPE.
TLG_TAG_METHOD_TYPE The passed parameter specifies the method by which the value is edi‐
ted before archiving. The possible values are in the table Enum HMI‐
GO_TLG_TAG_METHOD_TYPE.
TLG_TAG_ON_CHANGE The passed parameter specifies whether archiving is to be carried out
in the event of a change. The possible values are in the table Enum
HMIGO_TLG_TAG_ON_CHANGE.
Enum HMIGO_TLG_TAG_TYPE
Values Description
TLG_TAG_TYP_ANALOG (65537) Analog tag
TLG_TAG_TYP_BINARY (65538) Binary tag
TLG_TAG_TYP_PROCESS (65544) Process tag
TLG_TAG_TYP_COMPRESS (65540) Compressed archive tag
Enum HMIGO_TLG_TAG_ARCHIVING
Values Description
TLG_TAG_ACYCLIC (8388609) Acyclic acquisition
TLG_TAG_CYCLIC_CONTINUOUS Cyclic-continuous acquisition
(8388610)
TLG_TAG_CYCLIC_SELECTIVE Cyclic-selective acquisition
(8388612)
TLG_TAG_ON_EVERY_CHANGE Acquisition only in the event of a change
(8388616)
TLG_TAG_ON_DEMAND (8388672) Acquisition of the current process value when necessary
For acquisition cycle and archive cycle: >= 1 hour
Archiving function = actual value
The acquisition type is not available for binary tags. Binary
tags always have the acquisition cycle "500 ms".
Enum HMIGO_TLG_TAG_ARCHIVING_STATE
Values Description
TLG_TAG_LOCKED (1) Acquisition disabled at system startup
TLG_TAG_ACTIVATED (0) Acquisition enabled at system startup
WinCC: Scripting (VBS, ANSI-C, VBA)
2596 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Enum HMIGO_TLG_TAG_ON_ERROR
Values Description
TLG_TAG_LAST_VALUE (1) The most recently acquired value is used.
TLG_TAG_SUBSTITUTE (2) A substitute value is entered.
Enum HMIGO_TLG_TAG_TRIGGER_TYPE
Values Description
TLG_TAG_FROM_0_TO_1 (2) Signal change from the value 0 to 1.
TLG_TAG_FROM_1_TO_0 (3) Signal change from the value 1 to 0.
TLG_TAG_ALWAYS (4) Always archive.
TLG_TAG_EVERY_CHANGE (1) Archive at every signal change.
Enum HMIGO_TLG_TAG_METHOD_TYPE
Values Description
TLG_TAG_ACTUAL (1) The current value is accepted.
TLG_TAG_SUM (3) The sum is formed.
TLG_TAG_MaxValue (5) The greatest value is saved.
TLG_TAG_MinValue (4) The smallest value is saved.
TLG_TAG_AVERAGE (2) The average value is saved.
Enum HMIGO_TLG_TAG_ON_CHANGE
Values Description
TLG_TAG_EVERY_VALUE (0) The current value is accepted.
TLG_TAG_RELATIVE_HYSTERESE A hysteresis specified as a percentage is used for the calcu‐
(1) lation as to whether the value is to be archived.
TLG_TAG_ABSOLUTE_HYSTERESE A hysteresis specified as an absolute value is used for the
(2) calculation as to whether the value is to be archived.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2597
VBA for Automated Configuration
3.6 VBA Reference
Example
Sub CreateTlgTag()
' HMIGO_011
' procedure to create a tag logging tag
' the archive need to be created before
' the tag logging tag must not be created before
' declarations
Dim objHMIGO As HMIGO
Dim strArchiveName As String
Dim strTlgTagName As String
Set objHMIGO = New HMIGO
strArchiveName = "NewArchive"
strTlgTagName = "NewTag"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTlgTag, vbOKOnly, "Status Tlg Tag"
'create tag logging tag
objHMIGO.CreateTlgTag strArchiveName, strTlgTagName, TLG_TAG_TYPE_ANALOG
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTlgTag, vbOKOnly, "Status Tlg Archive"
Set objHMIGO = Nothing
End Sub
See also
ListTlgTag Function (Page 2608)
ListTlgArchive Function (Page 2606)
GetTlgArchive Function (Page 2603)
DeleteTlgTag Function (Page 2601)
DeleteTlgArchive Function (Page 2600)
CreateTlgArchive Function (Page 2591)
CommitTlgTag Function (Page 2589)
CloseTlgArchive Function (Page 2583)
CloseTlgTag Function (Page 2585)
VBA in Tag Logging (Page 2576)
CreateTlgTrigger function
Description
Creates a new trigger that is used as a timer for the acquisition and archiving cycle.
Syntax
Expression.CreateTlgTrigger(TriggerName,TriggerBase,TriggerFactor)
WinCC: Scripting (VBS, ANSI-C, VBA)
2598 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Expression
Required. An expression which returns a "HMIGO" type object.
Parameter
Parameter (Data Type) Description
TriggerName (String) Name of the trigger to be created
TriggerBase (HMIGO_TLG_TRIGGER_BASE) Time base of the trigger. Possible values:
● TLG_TRIGGER_BASE_250MS (250)
● TLG_TRIGGER_BASE_500MS (500)
● TLG_TRIGGER_BASE_DAY (&H5265C00)
● TLG_TRIGGER_BASE_HOUR (&H36EE80)
● TLG_TRIGGER_BASE_MIN (&HEA60)
● TLG_TRIGGER_BASE_SEC (&H3E8)
TriggerFactor Integer factor that is taken into consideration for the trigger together
with the time base.
Enum HMIGO_TLG_TRIGGER_BASE
Parameter Description
TLG_TRIGGER_BASE_250MS (250) The time base is "250 ms".
TLG_TRIGGER_BASE_500MS (500) The time base is "500 ms".
TLG_TRIGGER_BASE_DAY (&H5265C00) The time base is "1 day".
TLG_TRIGGER_BASE_HOUR (&H36EE80) The time base is "1 hour".
TLG_TRIGGER_BASE_MIN (&HEA60) The time base is "1 minute".
TLG_TRIGGER_BASE_SEC (&H3E8) The time base is "1 second".
Enum HMIGO_TLG_TRIGGER_SCHEDULE_DAYSOFWEEK
Parameter Description
TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_EVERY_DAY Every day is used for the "Weekly" trigger.
(127)
TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_FRIDAY (32) Friday is used for the "Weekly" trigger.
TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_MONDAY (2) Monday is used for the "Weekly" trigger.
TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_NO_DAY (0) No day is used for the "Weekly" trigger.
TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_SATURDAY (64) Saturday is used for the "Weekly" trigger.
TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_SUNDAY (1) Sunday is used for the "Weekly" trigger.
TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_THURSDAY (16) Thursday is used for the "Weekly" trigger.
TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_TUESDAY (4) Tuesday is used for the "Weekly" trigger.
TLG_TRIGGER_SCHEDULE_DAYSOFWEEK_WEDNESDAY (8) Wednesday is used for the "Weekly" trigger.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2599
VBA for Automated Configuration
3.6 VBA Reference
Enum HMIGO_TLG_TRIGGER_SCHEDULE_TYPE
Parameter Description
TLG_TRIGGER_SCHEDULE_TYPE_CYCLIC (0) The time series "Standard (cyclic)" is used for the trigger.
TLG_TRIGGER_SCHEDULE_TYPE_DAILY (1) The time series "Daily" is used for the trigger.
TLG_TRIGGER_SCHEDULE_TYPE_MONTHLY (3) The time series "Monthly" is used for the trigger.
TLG_TRIGGER_SCHEDULE_TYPE_WEEKLY (2) The time series "Weekly" is used for the trigger.
TLG_TRIGGER_SCHEDULE_TYPE_YEARLY (4) The time series "Yearly" is used for the trigger.
DeleteTlgArchive Function
Description
Deletes the specified archive.
Syntax
Expression.DeleteTlgArchive(ArchiveName)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
ArchiveName (String) Name of the archive to be deleted. Archive tags
contained in the archive are also deleted.
Example:
Sub DeleteTlgArchive()
' HMIGO_012
' procedure to delete an archive
' the archive need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim strArchiveName As String
Set objHMIGO = New HMIGO
strArchiveName = "NewArchive"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTlgArchive, vbOKOnly, "Status Tlg Archive"
'delete tag logging archive
objHMIGO.DeleteTlgArchive strArchiveName
Set objHMIGO = Nothing
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2600 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
ListTlgTag Function (Page 2608)
ListTlgArchive Function (Page 2606)
GetTlgArchive Function (Page 2603)
DeleteTlgTag Function (Page 2601)
CreateTlgTag Function (Page 2594)
CreateTlgArchive Function (Page 2591)
CommitTlgTag Function (Page 2589)
CommitTlgArchive Function (Page 2587)
CloseTlgTag Function (Page 2585)
CloseTlgArchive Function (Page 2583)
VBA in Tag Logging (Page 2576)
DeleteTlgTag Function
Description
Deletes the specified archive tag.
syntax
Expression.DeleteTlgTag(ArchiveName,TagName)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
ArchiveName (String) Name of the archive containing the archive tag to
be deleted
TagName (string) Name of the archive tag to be deleted.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2601
VBA for Automated Configuration
3.6 VBA Reference
Example:
Sub DeleteTlgTag()
' HMIGO_013
' procedure to delete a tag logging tag
' the archive need to be created before
' the tag logging tag need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim strArchiveName As String
Dim strTlgTagName As String
Set objHMIGO = New HMIGO
strArchiveName = "NewArchive"
strTlgTagName = "NewTag"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTlgTag, vbOKOnly, "Status Tlg Tag"
'delete tag logging tag
objHMIGO.DeleteTlgTag strArchiveName, strTlgTagName
Set objHMIGO = Nothing
End Sub
See also
ListTlgTag Function (Page 2608)
ListTlgArchive Function (Page 2606)
GetTlgArchive Function (Page 2603)
DeleteTlgArchive Function (Page 2600)
CreateTlgTag Function (Page 2594)
CreateTlgArchive Function (Page 2591)
CommitTlgTag Function (Page 2589)
CommitTlgArchive Function (Page 2587)
CloseTlgTag Function (Page 2585)
CloseTlgArchive Function (Page 2583)
VBA in Tag Logging (Page 2576)
DeleteTlgTrigger function
Description
Deletes the specified trigger.
Syntax
Expression.DeleteTlgTrigger(TriggerName)
WinCC: Scripting (VBS, ANSI-C, VBA)
2602 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Expression
Required. An expression which returns a "HMIGO" type object.
Parameter
Parameter (Data Type) Description
TriggerName (String) Name of the trigger that is deleted.
GetTlgArchive Function
Description
Reads in the parameters of the specified archive.
You can change or read the parameters by means of the object properties. You will find a list
of the available object properties in this documentation under "VBA in TagLogging".
syntax
Expression.GetTlgArchive(ArchiveName)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
ArchiveName (String) Name of the archive whose values are to be read
in.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2603
VBA for Automated Configuration
3.6 VBA Reference
Example:
Sub GetTlgArchive()
' HMIGO_014
' procedure to open an archive
' the archive need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim strArchiveName As String
Set objHMIGO = New HMIGO
strArchiveName = "NewArchive"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTlgArchive, vbOKOnly, "Status Tlg Archive"
'open/ get tag logging archive
objHMIGO.GetTlgArchive strArchiveName
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTlgArchive, vbOKOnly, "Status Tlg Archive"
Set objHMIGO = Nothing
End Sub
See also
CreateTlgTag Function (Page 2594)
ListTlgTag Function (Page 2608)
ListTlgArchive Function (Page 2606)
GetTlgArchive Function (Page 2603)
DeleteTlgTag Function (Page 2601)
DeleteTlgArchive Function (Page 2600)
CreateTlgArchive Function (Page 2591)
CommitTlgTag Function (Page 2589)
CommitTlgArchive Function (Page 2587)
CloseTlgTag Function (Page 2585)
CloseTlgArchive Function (Page 2583)
VBA in Tag Logging (Page 2576)
GetTlgTag Function
Description
Reads in the parameters of the specified archive tag.
You can change or read the parameters by means of the object properties. You will find a list
of the available object properties in this documentation under "VBA in TagLogging".
WinCC: Scripting (VBS, ANSI-C, VBA)
2604 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
syntax
Expression.GetTlgTag(ArchiveName,TagName)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
ArchiveName (String) Name of the archive containing the archive tag.
TagName Name of the archive tag whose parameters are to
be read in.
Example:
Sub GetTlgTag()
' HMIGO_015
' procedure to close a tag logging tag
' the archive need to be created before
' the tag logging need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim strArchiveName As String
Dim strTlgTagName As String
Set objHMIGO = New HMIGO
strArchiveName = "NewArchive"
strTlgTagName = "NewTag"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateTlgTag, vbOKOnly, "Status Tlg Tag"
'open/ get tag logging tag
objHMIGO.GetTlgTag strArchiveName, strTlgTagName
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateTlgTag, vbOKOnly, "Status Tlg Archive"
Set objHMIGO = Nothing
End Sub
See also
CreateTlgTag Function (Page 2594)
ListTlgTag Function (Page 2608)
ListTlgArchive Function (Page 2606)
GetTlgArchive Function (Page 2603)
DeleteTlgTag Function (Page 2601)
DeleteTlgArchive Function (Page 2600)
CreateTlgArchive Function (Page 2591)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2605
VBA for Automated Configuration
3.6 VBA Reference
CommitTlgTag Function (Page 2589)
CommitTlgArchive Function (Page 2587)
CloseTlgTag Function (Page 2585)
CloseTlgArchive Function (Page 2583)
VBA in Tag Logging (Page 2576)
GetTlgTrigger function
Description
Reads in the parameters of the specified trigger.
You can change or read the parameters by means of the object properties. You will find a list
of the available object properties in this documentation under "VBA in TagLogging".
Syntax
Expression.GetTlgTrigger(TriggerName)
Expression
Required. An expression which returns a "HMIGO" type object.
Parameter
Parameter (Data Type) Description
TriggerName (String) Name of the trigger whose values are read in.
ListTlgArchive Function
Description
Alternatively, the ListTlgArchive function returns the following Tag Logging values in a list:
● All existing Tag Logging archives
● All existing cycles / timers
syntax
Expression.ListTlgArchive(ListType,pListArray,[Filter])
Expression
Necessary. An expression which returns a "HMIGO" type object.
WinCC: Scripting (VBS, ANSI-C, VBA)
2606 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameters
Parameter (Data Type) Description
ListType (HMIGO_TLG_ARCHIVE_LIST_TYPE) Defines which content should be returned in a list.
Possibilities are:
● TLG_ARCHIVE_NAMES (1) All created Tag
Logging archives
● TLG_ARCHIVE_TRIGGER_NAMES (2) All
created cycles / timers
pListArray (Variant) List with the requested content.
Filter (String) Filters can be set optionally. A trigger name can
be used as a filter. Wildcards "*" and "?" are also
possible.
Example:
In the following example, a check is made whether archives are configured:
Sub ReadTlgArchives()
'HMIGO_028
'read content in tag logging
'no archives are implemented
Dim objHMIGO As New HMIGO
Dim varRange As Variant
'read all tlg archives
objHMIGO.ListTlgArchive TLG_ARCHIVE_NAMES, arrContent
'check result
If (UBound(arrContent) - LBound(arrContent) + 1) <= 0 Then
MsgBox "no entries because no tag logging archives are implemented"
End If
End Sub
See also
ListTlgTag Function (Page 2608)
GetTlgArchive Function (Page 2603)
DeleteTlgTag Function (Page 2601)
DeleteTlgArchive Function (Page 2600)
CreateTlgTag Function (Page 2594)
CreateTlgArchive Function (Page 2591)
CommitTlgTag Function (Page 2589)
CommitTlgArchive Function (Page 2587)
CloseTlgTag Function (Page 2585)
CloseTlgArchive Function (Page 2583)
VBA in Tag Logging (Page 2576)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2607
VBA for Automated Configuration
3.6 VBA Reference
ListTlgTag Function
Description
The ListTlgTag function returns all the tags created in a Tag Logging archive in a list.
syntax
Expression.ListTlgTag(ListType,ListArray,[ArchiveName],[Filter])
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
ListType (HMIGO_TLG_TAG_LIST_TYPE) Defines which content should be returned in a list.
Possibilities are:
TLG_TG_NAMES (1) All tags created in a Tag
Logging archive
ListArray (Variant) List with the requested content.
ArchiveName (String) Name of the archive in Tag Logging (optional). If
the name of the archive is not specified, all,archive
tags are returned.
Filter (String) Filters can be set optionally. Wildcards "*" and "?"
are also possible.
Example:
In the following example, a check is made whether the archive tags are configured in the
"Process Archive":
Sub ReadTlgTag()
'HMIGO_029
'read content in tag logging
'no tags within archives are implemented
Dim objHMIGO As New HMIGO
Dim varRange As Variant
Dim strArchive as String
'set tlg archive name
strArchive = "processarchive"
'read all tlg tags in specified archive
objHMIGO.ListTlgTag TLG_TAG_NAMES, arrContent, strArchive
'check result
If (UBound(arrContent) - LBound(arrContent) + 1) <= 0 Then
MsgBox "no entries because no tag logging tags in specified archive are implemented"
End If
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2608 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
ListTlgArchive Function (Page 2606)
GetTlgArchive Function (Page 2603)
DeleteTlgTag Function (Page 2601)
DeleteTlgArchive Function (Page 2600)
CreateTlgTag Function (Page 2594)
CreateTlgArchive Function (Page 2591)
CommitTlgTag Function (Page 2589)
CommitTlgArchive Function (Page 2587)
CloseTlgTag Function (Page 2585)
CloseTlgArchive Function (Page 2583)
VBA in Tag Logging (Page 2576)
ListTlgTrigger function
Description
The function returns all created triggers in a list.
Syntax
Expression.ListTlgTrigger(ListType,ListArray,[Filter])
Expression
Required. An expression which returns a "HMIGO" type object.
Parameter
Parameter (Data Type) Description
ListType (HMIGO_TLG_TRIGGER_LIST_TYPE) Defines the content that is to be returned in a list.
Possibilities are:
● TLG_TRIGGER_NAMES (1) all created
triggers
ListArray (Variant) List with the requested content.
Filter (String) Filters can be set optionally. A trigger name can
be used as a filter. Wildcards "*" and "?" are also
possible.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2609
VBA for Automated Configuration
3.6 VBA Reference
3.6.2.4 VBA in the Text Library
VBA in the Text Library
Introduction
VBA allows you to generate Text Library texts directly from the program code, modify and
delete them, and display text IDs and texts.
Note
You should not have or should not open the "TextLibrary" editor when editing with VBA.
Principle
When you have created the instance of the "HMIGO" class, the following functions are available
to you to access the TextLibrary:
● CreateTextLanguage
● CreateText
● DeleteText
● DeleteTextLanguage
● GetText
● GetTextID
● ListText
● ModifyText
The following enumerations are available for the parameter supply of these functions:
● HMIGO_TEXT_CREATE_MODE
● HMIGO_TEXT_LIST_TYPE
See also
ModifyText Function (Page 2622)
ListText Function (Page 2621)
GetTextID Function (Page 2618)
GetText Function (Page 2617)
DeleteTextLanguage Function (Page 2616)
DeleteText Function (Page 2613)
CreateText Function (Page 2612)
WinCC: Scripting (VBS, ANSI-C, VBA)
2610 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
CreateTextLanguage Function (Page 2611)
VBA in Other WinCC Editors (Page 2563)
CreateTextLanguage Function
Description
Creates a language in the Text Library.
syntax
Expression.CreateTextLanguage(LanguageID)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
LanguageID (Long) ID for the language to be created (e.g. 1031 for
German, 1033 for English, etc.)
For a table of all language codes refer to the
WinCC online help on "Language Identifiers".
Example:
Sub CreateTextLanguage()
' HMIGO_016
' procedure to create a language in text library
' language must not be created before
' LanguageID german = 1031
' LanguageID english(US) = 1033
' LanguageID spanish = 1034
' LanguageID french = 1040
' LanguageID farsi= 1065
' declarations
Dim objHMIGO As HMIGO
Dim lngLangugeNumber As Long
Set objHMIGO = New HMIGO
lngLangugeNumber = 1065 'farsi
'create new language
objHMIGO.CreateTextLanguage lngLangugeNumber
Set objHMIGO = Nothing
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2611
VBA for Automated Configuration
3.6 VBA Reference
See also
ModifyText Function (Page 2622)
ListText Function (Page 2621)
GetTextID Function (Page 2618)
GetText Function (Page 2617)
DeleteTextLanguage Function (Page 2616)
DeleteText Function (Page 2613)
CreateText Function (Page 2612)
VBA in the Text Library (Page 2610)
CreateText Function
Description
Creates a new text for the language specified. Text input for other languages can be added
using ModifyText.
syntax
Expression.CreateText(LanguageID,Text,CreateMode,TextID)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
LanguageID (Long) ID of the language for which the text will be created.
Text (string) Text to be created.
CreateMode (HMIGO_TEXT_CREATE_MODE) Mode of text creation:
● TEXT_ADD_REFCOUNT (0) only increases
the reference counter when an identical text
already exists.
● TEXT_CREATE_ALWAYS (1) always sets up
a new text line and inserts the text in it.
TextID (long) Returns the TextID assigned to the new text or the
TextID whose reference counter is increased. This
ID is required for processing the text in other func‐
tions.
WinCC: Scripting (VBS, ANSI-C, VBA)
2612 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
Sub CreateText()
' HMIGO_017
' procedure to create a new text
' declarations
Dim objHMIGO As HMIGO
Dim lngLanguageID As Long
Dim lngTextCreateMode As Long
Dim lngTextID As Long 'return value of ".CreateText"
Dim strText As String
Set objHMIGO = New HMIGO
strText = "new text"
'LanguageID = english
lngLanguageID = 1033
'"TEXT_ADD_REFCOUNT" check if text exists, if not create new text
lngTextCreateMode = 0
'"TEXT_CREATE_ALWAYS" create always a new text (for messages)
' lngTextCreateMode = 1
'create new text
objHMIGO.CreateText lngLanguageID, strText, lngTextCreateMode, lngTextID
'show TextID of created text
MsgBox "TextID: " & lngTextID, vbOKOnly, "Result CreateText"
Set objHMIGO = Nothing
End Sub
See also
ModifyText Function (Page 2622)
ListText Function (Page 2621)
GetTextID Function (Page 2618)
GetText Function (Page 2617)
DeleteTextLanguage Function (Page 2616)
DeleteText Function (Page 2613)
CreateTextLanguage Function (Page 2611)
VBA in the Text Library (Page 2610)
DeleteText Function
Description
Deletes a line of text. All the languages for the corresponding line of text and the line of text
itself are deleted.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2613
VBA for Automated Configuration
3.6 VBA Reference
syntax
Expression.DeleteText(TextID)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
TextID (long) ID of the line of text to be deleted
WinCC: Scripting (VBS, ANSI-C, VBA)
2614 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
Sub DeleteText()
' HMIGO_018
' procedure to delete a text
' text will be searched and deleted
' declarations
Dim objHMIGO As HMIGO
Dim lngLanguageID As Long
Dim lngTextID As Long 'return value of GetTextID
Dim strText As String
On Error GoTo ErrorHandler
Set objHMIGO = New HMIGO
strText = "new text"
lngLanguageID = 1033
'first: find text in text library and return TextID
objHMIGO.GetTextID 1033, strText, lngTextID
'if searched text exists: delete this text
If Not lngTextID = -1 Then
objHMIGO.DeleteText lngTextID
MsgBox "Text : """ & strText & """ found in TextID: " & lngTextID & vbNewLine & _
"TextID is deleted!", vbOKOnly, "Result DeleteText"
Else
MsgBox "Text : """ & strText & """ not found." & vbNewLine & _
"No Text deleted!", vbOKOnly, "Result DeleteText"
End If
Set objHMIGO = Nothing
Exit Sub
ErrorHandler:
'if lngText = (-1),searched text does not exit
If lngTextID = -1 Then
'reset errorhandler
Err.Clear
Resume Next
End If
MsgBox "ErrNr. : " & Err.Number & vbNewLine & _
"ErrDes.: " & Err.Description, vbOKOnly, "Error ocurred"
'reset errorhandler
Err.Clear
End Sub
See also
VBA in the Text Library (Page 2610)
ModifyText Function (Page 2622)
ListText Function (Page 2621)
GetTextID Function (Page 2618)
GetText Function (Page 2617)
DeleteTextLanguage Function (Page 2616)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2615
VBA for Automated Configuration
3.6 VBA Reference
CreateText Function (Page 2612)
CreateTextLanguage Function (Page 2611)
DeleteTextLanguage Function
Description
Enables a language to be deleted from the TextLibrary. In this case, all the texts in this
language are also deleted.
syntax
Expression.DeleteTextLanguage(LanguageID)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
LanguageID (Long) ID of the language to be deleted
Example:
In the following example, a check is made whether the language '1036' exists. If it does, it will
be deleted.
Sub DeleteLanguage()
'HMIGO_030
' delete an existing languages in TextLibrary
' language '1036'/spanish has to exist
Dim objHMIGO As New HMIGO
Dim varRange As Variant
Dim intLanguage As Long
Dim lngPointer As Long
' get all existing languages
objHMIGO.ListText TEXT_LANGUAGE_IDS, arrContent
' check requested list for language '1036'/ spanish and delete
For lngPointer = LBound(arrContent) To UBound(arrContent)
intLanguage = arrContent(lngPointer) + Val("&H400")
If intLanguage = 1036 Then
'delete language
objHMIGO.DeleteTextLanguage intLanguage
End If
Next lngPointer
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2616 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
GetText Function (Page 2617)
ModifyText Function (Page 2622)
ListText Function (Page 2621)
GetTextID Function (Page 2618)
DeleteText Function (Page 2613)
CreateText Function (Page 2612)
CreateTextLanguage Function (Page 2611)
VBA in the Text Library (Page 2610)
GetText Function
Description
Returns the text for the selected text ID in the selected language.
syntax
Expression.GetText(LanguageID,TextID,Text)
Expression
Necessary. An expression that returns an object of the type "HMIGeneralObjects".
Parameters
Parameter (Data Type) Description
LanguageID (Long) ID of the language of the text to be read
TextID (long) ID of the line of text from which text is to be read
Text (string) Returns the text of the selected line of text and
language.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2617
VBA for Automated Configuration
3.6 VBA Reference
Example:
Sub GetText()
' HMIGO_019
' procedure to get a text
' text with TextID = '69' need to be created
' declarations
Dim objHMIGO As HMIGO
Dim lngLanguageID As Long
Dim lngTextID As Long
Dim strText As String 'return value of GetText
Set objHMIGO = New HMIGO
lngTextID = 69
lngLanguageID = 1033
'find text text library
objHMIGO.GetText lngLanguageID, lngTextID, strText
'show found text
MsgBox "Read Text in TextID : " & lngTextID & " is """ & strText & """ !", _
vbOKOnly, "Result GetText"
Set objHMIGO = Nothing
End Sub
See also
ModifyText Function (Page 2622)
ListText Function (Page 2621)
GetTextID Function (Page 2618)
DeleteTextLanguage Function (Page 2616)
DeleteText Function (Page 2613)
CreateText Function (Page 2612)
CreateTextLanguage Function (Page 2611)
VBA in the Text Library (Page 2610)
GetTextID Function
Description
Returns the ID of the text searched for in the selected language.
If there are several texts with the same contents, only the line of text with the lowest ID is
returned. Whether there are several lines of text with the same contents depends on the
CreateMode of the CreateText function.
WinCC: Scripting (VBS, ANSI-C, VBA)
2618 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
syntax
Expression.GetTextID(LanguageID,Text,TextID)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
LanguageID (Long) ID of the language of the text searched for
Text (string) The text searched for
TextID (long) ID of the line of text in which the text searched for
was found
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2619
VBA for Automated Configuration
3.6 VBA Reference
Example:
Sub GetTextID()
' HMIGO_020
' procedure to search a TextID
' text will be searched and a TextID will be returned
' declarations
Dim objHMIGO As HMIGO
Dim lngLanguageID As Long
Dim lngTextID As Long 'return value of GetTextID
Dim strText As String
On Error GoTo ErrorHandler
Set objHMIGO = New HMIGO
strText = "old text"
lngLanguageID = 1033
'first: find text in text library and return TextID
objHMIGO.GetTextID 1033, strText, lngTextID
'if searched text exists: delete this text
If Not lngTextID = -1 Then
MsgBox "Text : """ & strText & """ found in TextID: " & lngTextID, _
vbOKOnly, "Result GetTextID"
Else
MsgBox "Text : """ & strText & """ not found!", vbOKOnly, "Result GetTextID"
End If
Set objHMIGO = Nothing
Exit Sub
ErrorHandler:
'if lngText = (-1),searched text does not exit
If lngTextID = -1 Then
'reset errorhandler
Err.Clear
Resume Next
End If
MsgBox "ErrNr. : " & Err.Number & vbNewLine & _
"ErrDes.: " & Err.Description, vbOKOnly, "Error ocurred"
'reset errorhandler
Err.Clear
End Sub
See also
ModifyText Function (Page 2622)
ListText Function (Page 2621)
GetText Function (Page 2617)
DeleteTextLanguage Function (Page 2616)
DeleteText Function (Page 2613)
CreateText Function (Page 2612)
WinCC: Scripting (VBS, ANSI-C, VBA)
2620 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
CreateTextLanguage Function (Page 2611)
VBA in the Text Library (Page 2610)
ListText Function
Description
Alternatively, the ListText function returns the following contents of the TextLibrary as a list:
● All languages created
● All text IDs
● All texts in a specific language
syntax
Exoression.ListText(ListType,pListArray,[LanguageID],[Filter])
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
ListType (HMIGO_TEXT_LIST_TYPE) Defines which content should be returned as a list.
Possibilities are:
● TEXT_LANGUAGE_IDS (1) All the created
languages. The result still has to be converted
by adding 400hex.
● TEXT_IDS (2) All text IDs.
● TEXT_TEXTS (3) All texts in a language.
pListArray (Variant) List with the requested content.
LanguageID (Long) The language ID whose text is to be returned.
Filter (String) Filters can be set optionally. Wildcards "*" and "?"
are also possible.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2621
VBA for Automated Configuration
3.6 VBA Reference
Example:
In the following example, a check is made whether the list with the text of a language is empty
because the language does not exist:
Sub ReadTextsByLanguage()
'HMIGO_031
'read content in textLibrary by language
Dim objHMIGO As New HMIGO
Dim varRange As Variant
Dim intLanguage As Integer
'set invalid language ID
intLanguage = 1051 'language does not exist
'read all texts
objHMIGO.ListText TEXT_TEXTS, arrContent, intLanguage
'check result
If (UBound(arrContent) - LBound(arrContent) + 1) <= 0 Then
MsgBox "no entries because wrong language selection"
End If
End Sub
See also
ModifyText Function (Page 2622)
GetTextID Function (Page 2618)
GetText Function (Page 2617)
DeleteTextLanguage Function (Page 2616)
DeleteText Function (Page 2613)
CreateTextLanguage Function (Page 2611)
VBA in the Text Library (Page 2610)
ModifyText Function
Description
Modifies the text for the selected language with the ID specified.
syntax
Expression.ModifyText(LanguageID,TextID,Text)
Expression
Necessary. An expression which returns a "HMIGO" type object.
WinCC: Scripting (VBS, ANSI-C, VBA)
2622 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Parameters
Parameter (Data Type) Description
LanguageID (Long) ID of the language of the text to be changed.
TextID (long) ID of the language of the text to be changed.
Text (string) New text to be inserted.
Example:
Sub ModifyText()
' HMIGO_021
' procedure to modify a text
' text will be searched and replaced
' declarations
Dim objHMIGO As HMIGO
Dim lngLanguageID As Long
Dim lngTextID As Long 'return value of GetTextID
Dim strOldText As String
Dim strNewText As String
On Error GoTo ErrorHandler
Set objHMIGO = New HMIGO
strOldText = "old text"
strNewText = "new text"
lngLanguageID = 1033
'first: find text in text library and return TextID
objHMIGO.GetTextID 1033, strOldText, lngTextID
'if searched text exists: replace this text
If Not lngTextID = -1 Then
objHMIGO.ModifyText lngLanguageID, lngTextID, strNewText
MsgBox "Text : """ & strOldText & """ found in TextID: " & lngTextID & vbNewLine & _
"Text replaced with : """ & strNewText & """ !", vbOKOnly, "Result DeleteText"
Else
MsgBox "Text : """ & strOldText & """ not found." & vbNewLine & _
"No Replacements done!", vbOKOnly, "Result DeleteText"
End If
Set objHMIGO = Nothing
Exit Sub
ErrorHandler:
'if lngText = (-1),searched text does not exit
If lngTextID = -1 Then
'reset errorhandler
Err.Clear
Resume Next
End If
MsgBox "ErrNr. : " & Err.Number & vbNewLine & _
"ErrDes.: " & Err.Description, vbOKOnly, "Error ocurred"
'reset errorhandler
Err.Clear
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2623
VBA for Automated Configuration
3.6 VBA Reference
See also
ListText Function (Page 2621)
GetTextID Function (Page 2618)
GetText Function (Page 2617)
DeleteTextLanguage Function (Page 2616)
DeleteText Function (Page 2613)
CreateText Function (Page 2612)
CreateTextLanguage Function (Page 2611)
VBA in the Text Library (Page 2610)
3.6.2.5 VBA in Alarm Logging
VBA in Alarm Logging
Introduction
VBA allows you to create messages directly from the program code, modify them, and delete
them.
Note
You should not have or should not open the "Alarm Logging" editor when editing with VBA.
Principle
When you have created the instance of the "HMIGO" class, the following functions are available
to you to access Alarm Logging:
● CloseSingleAlarm
● CommitSingleAlarm
● CreateSingleAlarm
● DeleteSingleAlarm
● GetSingleAlarm
● ListSingleAlarm
The following enumerations are available for the parameter supply of these functions:
● HMIGO_SINGLE_ALARM_CLASS_IDS
● HMIGO_SINGLE_ALARM_LIST_TYPE
WinCC: Scripting (VBS, ANSI-C, VBA)
2624 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Access to the Object Properties
You can also access the parameters of the above-mentioned functions directly in VBA by
means of the following object properties:
Object property Description Read/Write
ObjectStateSingleAlarm Returns the object state via the enumeration HMIGO_OB‐ Yes/no
JECT_STATE. Further information on this enumeration can be found
in this documentation under "VBA in other WinCC Editors".
SingleAlarmMessageNumber Number of the message Yes/no
SingleAlarmAGNumber AS Number Yes/yes
SingleAlarmCPUNumber CPU number of the AGs. Yes/yes
SingleAlarmClassID Message class of the message. Possible values of the Enum SIN‐ Yes/yes
GLE_ALARM_CLASS_IDS:
● SINGLE_ALARM_ERROR (1)
● SINGLE_ALARM_CLASS_2 (2)
● SINGLE_ALARM_CLASS_3 (3)
● SINGLE_ALARM_CLASS_4 (4)
● SINGLE_ALARM_CLASS_5 (5)
● SINGLE_ALARM_CLASS_6 (6)
● SINGLE_ALARM_CLASS_7 (7)
● SINGLE_ALARM_CLASS_8 (8)
● SINGLE_ALARM_CLASS_9 (9)
● SINGLE_ALARM_CLASS_10 (10)
● SINGLE_ALARM_CLASS_11 (11)
● SINGLE_ALARM_CLASS_12 (12)
● SINGLE_ALARM_CLASS_13 (13)
● SINGLE_ALARM_CLASS_14 (14)
● SINGLE_ALARM_CLASS_15 (15)
● SINGLE_ALARM_CLASS_16 (16)
● SINGLE_ALARM_CLASS_SYSTEM_REQUIRE_ACKNOWLEDG
EMENT (17)
● SINGLE_ALARM_CLASS_SYSTEM_WITHOUT_ACKNOWLEDG
EMENT (18)
SingleAlarmMessageTypeID Type ID of the message. The permissible values depend on the mes‐ Yes/yes
sage class:
● Class 1: Values from 1 to 16
● Class 2: Values from 17 to 32
● Class 3: Values from 33 to 48
● ...
● Class 18: 273 and 274
SingleAlarmTextXXID The properties SingleAlarmText1ID to SingleAlarmText10ID exist for Yes/yes
XX = 1...10 the user texts 1 to 10.
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2625
VBA for Automated Configuration
3.6 VBA Reference
Object property Description Read/Write
SingleAlarmTagNameProcessVa‐ For the process values there are the properties SingleAlarmTagName‐ Yes/yes
lueXX ProcessValue1 through 10
XX = 1...10 If you want to delete a configured process value, you must describe
this parameter with a tag of the type "Long", which has the value "0".1)
SingleAlarmTagName Tag name for event Yes/yes
SingleAlarmMessageBit Bits for bit reporting procedure Yes/yes
SingleAlarmQuitTag Tag name for acknowledgment status Yes/yes
SingleAlarmQuitBits Bit for bit reporting procedure Yes/yes
SingleAlarmStateTag Tag for status query Yes/yes
SingleAlarmStateBits Bit for status tag Yes/yes
SingleAlarmNormDLL Name of the conversion DLL Yes/yes
SingleAlarmQuitSingle Acknowledgment of the messages, TRUE or FALSE possible Yes/yes
SingleAlarmHornActivate Activation of the horn, TRUE or FALSE possible Yes/yes
SingleAlarmArchiving Archiving of the message, TRUE or FALSE possible Yes/yes
SingleAlarmProtocol Logging of the message, TRUE or FALSE possible Yes/yes
SingleAlarmFlankInvert Triggering of message at falling edge, TRUE or FALSE possible Yes/yes
SingleAlarmLockedOnStart Message is disabled at system startup, TRUE or FALSE possible Yes/yes
SingleAlarmGlobalAPFunction Forward message to global AP function, TRUE or FALSE possible Yes/yes
SingleAlarmActionName Name of the action Yes/yes
SingleAlarmActionParams Parameters of the action Yes/yes
SingleAlarmInfoText Information text for message Yes/yes
SingleAlarmGroup Name of the user-defined group message assigned to a message. Yes/yes
1)
Sub DeleteSingleAlarmTagNameProcessValue1()
'HMIGO_033
Dim objGO as HMIGO
Dim var as Long
var = 0
Set objGO = new HMIGO
'message 1 will be modified
objGO.GetSingleAlarm 1
objGO.SingleAlarmTagNameProcessValue1 = var
objGO.CommitSingleAlarm
Set objGO = nothing
End Sub
See also
ListSingleAlarm Function (Page 2635)
GetSingleAlarm Function (Page 2634)
DeleteSingleAlarm Function (Page 2633)
CreateSingleAlarm Function (Page 2630)
CommitSingleAlarm Function (Page 2628)
WinCC: Scripting (VBS, ANSI-C, VBA)
2626 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
CloseSingleAlarm Function (Page 2627)
VBA in Other WinCC Editors (Page 2563)
CloseSingleAlarm Function
Description
Closes the message which is open.
Note
Modified parameters are not saved. If the current value should be saved, execute the
CommitSingleAlarm() function again.
syntax
Expression.CloseSingleAlarm()
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
--
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2627
VBA for Automated Configuration
3.6 VBA Reference
Example:
Sub CloseSingleAlarm()
' HMIGO_22
' procedure to open a singlealarm
' message #100 need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim lngMsgNumber As Long
Set objHMIGO = New HMIGO
lngMsgNumber = 100
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'open a singlealarm
objHMIGO.GetSingleAlarm lngMsgNumber
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'close a singlealarm
objHMIGO.CloseSingleAlarm
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
Set objHMIGO = Nothing
End Sub
See also
ListSingleAlarm Function (Page 2635)
GetSingleAlarm Function (Page 2634)
DeleteSingleAlarm Function (Page 2633)
CreateSingleAlarm Function (Page 2630)
CommitSingleAlarm Function (Page 2628)
VBA in Alarm Logging (Page 2624)
CommitSingleAlarm Function
Description
Writes the changed parameters of the open message to WinCC.
Note
To change further parameters after a CommitSingleAlarm call, write these changes to WinCC
by calling the function again.
WinCC: Scripting (VBS, ANSI-C, VBA)
2628 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
syntax
Expression.CommitSingleAlarm()
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
--
Example:
Sub CommitSingleAlarm()
' HMIGO_023
' procedure to change a property of a singlealarm
' message #100 need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim lngMsgNumber As Long
Dim lngMsgBitNumber As Long
Set objHMIGO = New HMIGO
lngMsgNumber = 100
lngMsgBitNumber = 10
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'open a singlealarm
objHMIGO.GetSingleAlarm lngMsgNumber
'current status is "OPENED" for changes
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'change a property
objHMIGO.SingleAlarmMessageBit = lngMsgBitNumber
'current status is "MODIFIED" for changes
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'commit a single alarm
objHMIGO.CommitSingleAlarm
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
Set objHMIGO = Nothing
End Sub
See also
ListSingleAlarm Function (Page 2635)
GetSingleAlarm Function (Page 2634)
DeleteSingleAlarm Function (Page 2633)
CreateSingleAlarm Function (Page 2630)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2629
VBA for Automated Configuration
3.6 VBA Reference
CloseSingleAlarm Function (Page 2627)
VBA in Alarm Logging (Page 2624)
CreateSingleAlarm Function
Description
Creates a new message.
syntax
Expression.CreateSingleAlarm(MessageNumber,ClassID,MessageTypeID,Tex
t1ID,MessageTagName,MessageBit)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
MessageNumber (long) Number of the message.
● If an unused message number is specified
here, it is accepted.
● If the value "0" is entered, the message number
is freely assigned by the system. In this case,
the message number is given back here.
ClassID (HMIGO_SINGLE_ALARM_CLASS_IDS) Message class. The possible values are in the ta‐
ble Enum HMIGO_SIN‐
GLE_ALARM_CLASS_IDS.
MessageTypeID (Integer) The permissible values depend on the message
class:
● Class 1: Values from 1 to 16
● Class 2: Values from 17 to 32
● Class 3: Values from 33 to 48
● ...
● Class 18: Values from 263 to 288
Text1ID (Long) ID for the first user text. The ModifySingleAlarm
function can be used to define nine further user
texts (1-10).
MessageTagName (String) Tag name for the event.
MessageBit (integer) Bit in bit reporting process (0...31)
WinCC: Scripting (VBS, ANSI-C, VBA)
2630 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Default Values When a New Message Is Created
The following table indicates the default values that are entered when a new message is
created. These properties can be modified. The modifications are saved using the
ModifySingleAlarm function.
Parameters Default Value (Enum Comment
Name => Value)
SingleAlarmAGNumber 0 --
SingleAlarmCPUNumber 0 --
SingleAlarmTextXXID No text entered --
SingleAlarmTagNameProcessVa‐ No tag entered --
lueXX
SingleAlarmQuitTag No tag entered --
SingleAlarmQuitBits 0 No bits set.
SingleAlarmStateTag No tag entered Corresponds to exactly one day. Only
relevant in the case of compressed
tags.
SingleAlarmStateBits 0 No bits set.
SingleAlarmNormDLL No name entered --
SingleAlarmQuitSingle FALSE Single acknowledgment, no group ac‐
knowledgment
SingleAlarmHornActivate FALSE Horn Not active.
SingleAlarmArchiving TRUE Message will be archived.
SingleAlarmProtocol TRUE Message is logged.
SingleAlarmFlankInvert FALSE Not activated.
SingleAlarmLockedOnStart FALSE Message is not disabled.
SingleAlarmGlobalAPIFunction FALSE Message is not forwarded.
SingleAlarmActionName No name entered --
SingleAlarmActionParams No parameters en‐ --
tered for the action
SingleAlarmInfoText No text entered --
SingleAlarmGroup No text entered --
Enum HMIGO_SINGLE_ALARM_CLASS_IDS
The following message classes are available for selection:
Values Description
SINGLE_ALARM_ERROR (1) --
SINGLE_ALARM_CLASS_2 (2) --
SINGLE_ALARM_CLASS_3 (3) --
SINGLE_ALARM_CLASS_4 (4) --
SINGLE_ALARM_CLASS_5 (5) --
SINGLE_ALARM_CLASS_6 (6) --
SINGLE_ALARM_CLASS_7 (7) --
SINGLE_ALARM_CLASS_8 (8) --
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2631
VBA for Automated Configuration
3.6 VBA Reference
Values Description
SINGLE_ALARM_CLASS_9 (9) --
SINGLE_ALARM_CLASS_10 (10) --
SINGLE_ALARM_CLASS_11 (11) --
SINGLE_ALARM_CLASS_12 (12) --
SINGLE_ALARM_CLASS_13 (13) --
SINGLE_ALARM_CLASS_14 (14) --
SINGLE_ALARM_CLASS_15 (15) --
SINGLE_ALARM_CLASS_16 (16) --
SINGLE_ALARM_CLASS_SYSTEM_REQUIRE_ACKNOWLEDGEMENT (17) --
SINGLE_ALARM_CLASS_SYSTEM_WITHOUT_ACKNOWLEDGEMENT (18) --
Example:
Sub CreateSingleAlarm()
' HMIGO_024
' procedure to create a SingleAlarm
' message must not be created before
' message Text ID need to be created before in text library
' declarations
Dim objHMIGO As HMIGO
Dim strMsgText As String 'message text
Dim strMsgTagName As String 'message variable
Dim lngMsgNumber As Long 'message number
Dim lngMsgBitNumber As Long 'bit number within the message variable
Dim lngMsgTypeID As Long 'message type
Dim lngMsgClassID 'SINGLE_ALARM_ERROR
Dim lngMsgTextID As Long 'message text ID from textlibrary
Set objHMIGO = New HMIGO
strMsgText = "NewText"
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'preset reqiured parameter
lngMsgNumber = 50
lngMsgClassID = 1
lngMsgTypeID = 2
lngMsgTextID = 69
strMsgText = "new text message"
strMsgTagName = "NewVariable"
lngMsgBitNumber = 5
'create a tag
objHMIGO.CreateSingleAlarm lngMsgNumber,SINGLE_ALARM_ERROR, lngMsgTypeID,lngMsgTextID,
strMsgTagName, lngMsgBitNumber
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
Set objHMIGO = Nothing
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2632 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
ListSingleAlarm Function (Page 2635)
GetSingleAlarm Function (Page 2634)
DeleteSingleAlarm Function (Page 2633)
CommitSingleAlarm Function (Page 2628)
CloseSingleAlarm Function (Page 2627)
VBA in Alarm Logging (Page 2624)
DeleteSingleAlarm Function
Description
Deletes the specified message.
syntax
Expression.DeleteSingleAlarm(MessageNumber)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
MessageNumber (long) Number of the message to be deleted.
Example:
Sub DeleteSingleAlarm()
' HMIGO_025
' procedure to delete a singlealarm
' message #100 need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim lngMsgNumber As Long
Set objHMIGO = New HMIGO
lngMsgNumber = 100
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'delete a singlealarm
objHMIGO.DeleteSingleAlarm lngMsgNumber
Set objHMIGO = Nothing
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2633
VBA for Automated Configuration
3.6 VBA Reference
See also
VBA in Alarm Logging (Page 2624)
ListSingleAlarm Function (Page 2635)
GetSingleAlarm Function (Page 2634)
CreateSingleAlarm Function (Page 2630)
CommitSingleAlarm Function (Page 2628)
CloseSingleAlarm Function (Page 2627)
GetSingleAlarm Function
Description
Reads in the parameters of the message entered.
You can change or read the parameters by means of the object properties. You will find a list
of the available object properties in this documentation under "VBA in Alarm Logging".
syntax
Expression.GetSingleAlarm(MessageNumber)
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
MessageNumber (long) The message number of the message to be read
in.
WinCC: Scripting (VBS, ANSI-C, VBA)
2634 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
Example:
Sub GetSingleAlarm()
' HMIGO_026
' procedure to open a singlealarm
' message #100 need to be created before
' declarations
Dim objHMIGO As HMIGO
Dim lngMsgNumber As Long
Set objHMIGO = New HMIGO
lngMsgNumber = 100
'current status is "EMPTY"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
'open/ get a tag
objHMIGO.GetSingleAlarm lngMsgNumber
'current status is "OPENED"
MsgBox objHMIGO.ObjectStateSingleAlarm, vbOKOnly, "Status SingleAlarm"
Set objHMIGO = Nothing
End Sub
See also
ListSingleAlarm Function (Page 2635)
DeleteSingleAlarm Function (Page 2633)
CreateSingleAlarm Function (Page 2630)
CommitSingleAlarm Function (Page 2628)
CloseSingleAlarm Function (Page 2627)
VBA in Alarm Logging (Page 2624)
ListSingleAlarm Function
Description
The ListSingleAlarm function returns the content of Alarm Logging in a list:
● All actions created which are linked to messages
● All message class IDs created
● All info texts created
● All message numbers created
● All message type IDs created
● All message classes created
● All group messages created
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2635
VBA for Automated Configuration
3.6 VBA Reference
syntax
Expression.ListSingleAlarm(ListType,pListArray,[Filter])
Expression
Necessary. An expression which returns a "HMIGO" type object.
Parameters
Parameter (Data Type) Description
ListType (HMIGO_SIN‐ Defines which content should be returned in a list. Pos‐
GLE_ALARM_LIST_TYPE) sibilities are:
● SINGLE_ALARM_ACTION_NAMES (1) All actions
created for Loop In Alarm when the parameter is set
in the configuration as a string
● SINGLE_ALARM_CLASS_IDS (2) All message class
IDs created
● SINGLE_ALARM_INFO_TEXTS (3) All info texts
created
● SINGLE_ALARM_MESSAGE_NUMBERS (4) All
message numbers created
● SINGLE_ALARM_MESSAGE_TYPE_IDS (5) All
message type IDs created
● SINGLE_ALARM_GROUP_MESSAGE_CLASSES
(6) All message classes created
● SINGLE_ALARM_GROUP_MESSAGE_USER_DEF
INED (7) All group messages created
pListArray (Variant) List with the requested content.
Filter (String) Filters can be set optionally. Wildcards "*" and "?" are
also possible.
Example:
In the following example, a check is made whether info texts have been configured:
Sub ReadSingleAlarm()
'HMIGO_032
'read content in alarm logging
'no info texts are implemented
Dim objHMIGO As New HMIGO
Dim varRange As Variant
'read all info texts
objHMIGO.ListSingleAlarm SINGLE_ALARM_INFO_TEXTS, arrContent
'check result
If (UBound(arrContent) - LBound(arrContent) + 1) <= 0 Then
MsgBox "no entries because no info texts are implemented"
End If
End Sub
WinCC: Scripting (VBS, ANSI-C, VBA)
2636 System Manual, 09/2018, A5E45518271-AA
VBA for Automated Configuration
3.6 VBA Reference
See also
CreateSingleAlarm Function (Page 2630)
CommitSingleAlarm Function (Page 2628)
CloseSingleAlarm Function (Page 2627)
VBA in Alarm Logging (Page 2624)
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2637
VBA for Automated Configuration
3.6 VBA Reference
WinCC: Scripting (VBS, ANSI-C, VBA)
2638 System Manual, 09/2018, A5E45518271-AA
Index
Differences between actions and functions, 907
edit, 907
A Editing, 912, 932
Exporting, 923
abort, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Finding, 907
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Importing, 924
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Printing, 892
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Protecting with a Password, 63
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Protection against read and write access, 914
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Renaming, 907, 924
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Runtime behavior, 927
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Saving, 915
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Structuring, 866
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Trigger:Configuring type "Timer", 71
1091, 1092, 1093, 1094, 1095, 1096
Trigger:Configuring type Tag, 72
abs, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Use of DLLs, 878
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Using actions from other sources, 925
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Action configuring, 1707
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
with VBA, 1707
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Action icon
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Features, 907
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Action:Corrective measure, 64
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Action:Delete, 35
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Action:Editing, 58
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Action:new creation, 57
1091, 1092, 1093, 1094, 1095, 1096
Action:Save, 64
AcknowledgeMessage, 937, 938
Action:Trigger, 19
acos, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
ActionType property, 2116
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Activating, 77
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
of global actions in Runtime, 77
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
ActiveX controls, 1679
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Inserting with VBA, 1679
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
AddIn, 1742
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
AddIn Manager, 1742
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
create (example), 1746
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
create with VB (example), 1746
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
load automatically, 1742
1091, 1092, 1093, 1094, 1095, 1096
load manually, 1742
Action, 21, 35, 61, 63, 65, 71, 72, 1707
Loading (instructions), 1744
Adding information, 61
Loading behavior, 1742
Cause for non-execution of an action, 907
unload, 1742
Compiling, 907, 915
Use in Graphics Designer, 1742
Configuring with VBA, 1707
Adding, 919
Create, 53
Adding Timer trigger, 919
Creating functions and actions, 866, 907
adding to picture, 80
Creating new actions, 911
Adding trigger, 920
CrossReference, 53
AddIns property, 2122
Defining, 866
AdvancedAnalogDisplay, 1907
Deleting, 889
AdvancedStateDisplay, 1911
Dialog "Info", 61, 63
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2639
Index
Aktion:Renaming, 75 asin, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Aktion:use multiple times, 21 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Alarm Control, 279 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Alarm logging, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Creating message with VBA, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Deleting message with VBA, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Editing message with VBA, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Loop in Alarm, 946 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Modifying message with VBA, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Removing a message, 941 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Alarm object, 108 1091, 1092, 1093, 1094, 1095, 1096
AlarmControl, 238 AssemblyInfo, 2131
VBS example, 855 atan, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
AlarmGoneVisible, 2123 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
AlarmLogs Object, 110 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Alarms object (list), 108 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Analog Clock, 244 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Animation trigger, 69 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Application-specific menu, 1631 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Add menu entry, 1635 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Assigning help text, 1643 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Assigning status text, 1643 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Assigning VBA macro, 1645 1091, 1092, 1093, 1094, 1095, 1096
Configuring, 1630 atan2, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Creating, 1633 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
creating multiple languages, 1637 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Application-specific toolbar, 1631 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Add icon, 1641 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Assigning help text, 1643 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Assigning status text, 1643 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Assigning VBA macro, 1645 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Configuring, 1630 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Creating, 1639 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Archive backup: Connect via VBS, 840 1091, 1092, 1093, 1094, 1095, 1096
asctime, 1012, 1013, 1014, 1015, 1016, 1017, 1018, atof, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096 1091, 1092, 1093, 1094, 1095, 1096
WinCC: Scripting (VBS, ANSI-C, VBA)
2640 System Manual, 09/2018, A5E45518271-AA
Index
atoi, 1012, 1013, 1014, 1015, 1016, 1017, 1018, AXC_OnBtnTimeBase, 966
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, AXC_OnBtnVisibleAckn, 967
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, AXC_SetFilter, 968
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, B
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
BackColor_Alarm, 2141
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
BackFillColor, 2143
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
BackFillColor_OK, 2143
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
BackFillColor_Simulation, 2144
1091, 1092, 1093, 1094, 1095, 1096
BackFillStyle, 2144
atol, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
BackFillStyle_OK, 2144
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
BackFillStyle_Simulation, 2144
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Backup: Connect via VBS, 840
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
BasePicture, 2152
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
basics, 863
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
from VBS,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
BitPosition0, 2156
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
BitSelect0, 2157
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Bookmark:delete in Debugger, 98
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Bookmark:set in Debugger, 98
1091, 1092, 1093, 1094, 1095, 1096
Bookmark:skip to, 98
AttachDB, 718
Bookmarks, 98
Attribute:GSC Runtime, 84
Breakpoint, 96, 97
Authorization
Breakpoint:Deleting, 97
Assigning, 923
Breakpoint:set in Debugger, 96
Authorizations, 923
bsearch, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
AXC_OnBtnAlarmHidingList, 948
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
AXC_OnBtnArcLong, 949
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
AXC_OnBtnArcShort, 949
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
AXC_OnBtnComment, 950
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
AXC_OnBtnEmergAckn, 951
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
AXC_OnBtnHideDlg, 951
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
AXC_OnBtnHideUnhideMsg, 952
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
AXC_OnBtnHit, 953
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
AXC_OnBtnHornAckn, 954
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
AXC_OnBtnInfo, 954
1091, 1092, 1093, 1094, 1095, 1096
AXC_OnBtnLock, 955
Button1MessageClasses, 2173
AXC_OnBtnLockUnlock, 956
AXC_OnBtnLockWin, 957
AXC_OnBtnLoop, 957
AXC_OnBtnMsgFirst, 958
C
AXC_OnBtnMsgLast, 959 C action, 1711
AXC_OnBtnMsgNext, 960 Configuring on an event with VBA, 1711
AXC_OnBtnMsgPrev, 960 C script, 1702
AXC_OnBtnMsgWin, 961 Dynamize property with VBA, 1702
AXC_OnBtnPrint, 962
AXC_OnBtnProtocol, 963
AXC_OnBtnScroll, 963
AXC_OnBtnSelect, 964
AXC_OnBtnSinglAckn, 965
AXC_OnBtnSortDlg, 966
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2641
Index
c_bib, 1012, 1013, 1014, 1015, 1016, 1017, 1018, clearerr, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096 1091, 1092, 1093, 1094, 1095, 1096
CalculateStatistic, 718 clock, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
calloc, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096
1091, 1092, 1093, 1094, 1095, 1096 CloseTlgTrigger (VBA), 2586
CBackColorOff, 2176 Code, 42, 102
CBackFlash, 2177 Code page, 2467
ceil, 1012, 1013, 1014, 1015, 1016, 1017, 1018, Code Templates, 58
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, Code templates for VBS, 42
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, Code:of a Procedure, 42
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, Code:print, 102
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, Collection, 1938
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, Collections, 1752
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, Overview, 1752
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, CollectValue, 2189
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, Color code, 882
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, Column object, 219
1091, 1092, 1093, 1094, 1095, 1096 ComboBox object, 1939
Change, 73 CommitTlgTrigger (VBA), 2591
Triggers, 73 CommonVBSEventArea properties, 2202
char_io, 1012, 1013, 1014, 1015, 1016, 1017, 1018, CommonVBSPropertyArea property, 2202
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, Component library, 1650
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, Access with VBA, 1650
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, Copying an object with VBA, 1653
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, Creating a folder with VBA, 1653
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, Deleting a folder with VBA, 1653
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, Editing with VBA, 1653
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, Paste Object into a Picture with VBA, 1656
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, Computer properties, 87, 875
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, Runtime Tab, 87
1091, 1092, 1093, 1094, 1095, 1096 Configuring, 1628, 1709, 1711
Character set, 2467 C action with VBA, 1711
Class, 2563 Direct connection, 1709
HMIGO, 2563 for multiple languages with VBA, 1628
WinCC: Scripting (VBS, ANSI-C, VBA)
2642 System Manual, 09/2018, A5E45518271-AA
Index
Trigger with VBA, 1715 Create, 53, 57
VB action with VBA, 1713 Action, 53
ConnectionPoints, 2205 Procedure, 40
ConnectorObjects property, 2206 Create:Action, 57
ConnectorType, 2207 CreateDynamicDialog, 1832
Contents, 11 CreateTagSet, 719
Controls CreateTlgTrigger (VBA), 2598
WinCC Alarm Control, 279 Creating
WinCC MediaControl, 254 Procedures, 37
Controls:HMI Symbol Library, 237 Cross-reference, 65
Controls:WinCC Digital Analog Clock, 244 CTextColorOff, 2211
Controls:WinCC Function Trend Control, 281 CTextFlash, 2211
Controls:WinCC FunctionTrendControl, 246 ctime, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Controls:WinCC Online Table Control, 285 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Controls:WinCC Online Trend Control, 288 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Controls:WinCC OnlineTableControl, 254 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Controls:WinCC OnlineTrendControl, 260 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Controls:WinCC RulerControl, 266 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Controls:WinCC Slider Control,WinCC:WinCC Slider 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Control, 270 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Controls:WinCC UserArchiveControl, 274 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
ControlType, 2208 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
ConvertWM, 1828 1091, 1092, 1093, 1094, 1095, 1096
CopyPasteSettings property, 2208 ctype, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
CopyRows, 718 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
CornerRadius, 2208 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
cos, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1091, 1092, 1093, 1094, 1095, 1096
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, Customized Object, 1690
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, Access with VBA, 1690
1091, 1092, 1093, 1094, 1095, 1096 Deleting, 1691
cosh, 1012, 1013, 1014, 1015, 1016, 1017, 1018, Editing with VBA, 1691
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, Properties, 1690
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, ungroup, 1691
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, CutRows, 720
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, Cyclic, 65
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, D
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
DataItem Object, 111
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
DataLogs-Objekt, 112
1091, 1092, 1093, 1094, 1095, 1096
DataSet Object (List), 113
CQBackColorOff, 2210
DataSetObj, 1948
CQBackFlash, 2210
DeactivateRTProject, 1513
CQTextColorOff, 2210
Debugger, 87, 88, 90, 92, 94, 95, 96, 97, 98, 99, 100
CQTextFlash, 2211
Activating in WinCC, 87
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2643
Index
Opening after error message, 87 difftime, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Opening automatically, 87 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Starting for Global Script, 87 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Starting for Graphics Runtime, 87 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Debugger:Basic Principles, 88, 95 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Debugger:Change Picture During Debug, 88 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Debugger:Delete bookmark, 98 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Debugger:Deleting Breakpoints, 97 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Debugger:Determine property values, 99 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Debugger:Determine tag values, 99 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Debugger:Executing Script Commands, 100 1091, 1092, 1093, 1094, 1095, 1096
Debugger:modify property values, 99 Digital Analog Clock, 244
Debugger:Modify tag values, 99 Digital Clock, 244
Debugger:Name of actions in the script file, 92 Direct connection, 1709
Debugger:Processing Scripts Step-by-Step, 95 Configuring with VBA, 1709
Debugger:select running script, 94 Directio, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Debugger:Set bookmark, 98 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Debugger:Setting Breakpoints, 96 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Debugger:skip to bookmark, 98 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Debugger:Structure of the Script Files, 90 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Declaration area, 58 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Declaration Area:of an Action, 58 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Delete:Actions and Procedures, 35 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
DeleteRows, 721 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
DeleteTextLanguage, 2616 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
DeleteTlgTrigger function (VBA), 2602 1091, 1092, 1093, 1094, 1095, 1096
Deleting DisablePerformanceWarnings, 2220
Triggers, 74 Display property, 2221
Design of Global Script, 28 div, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019,
Design tool, 866 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027,
DetachDB, 721 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035,
Diagnostics, 79, 80, 82, 83, 84, 85 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043,
Diagnostics:Attributes:GSC Diagnostics, 80 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051,
Diagnostics:Debugger, 85 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059,
Diagnostics:GSC Diagnostics, 79 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067,
Diagnostics:GSC Runtime, 82 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075,
Diagnostics:GSC Runtime Attributes, 84 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083,
Diagnostics:Inserting GSC Diagnostics Window into 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091,
a Picture, 80 1092, 1093, 1094, 1095, 1096
Diagnostics:Inserting GSC Runtime into a DotNetControl, 1959
Picture, 83 DrawInsideFrame, 2224
Diagnostics:VBS:Diagnostics, 78 DropDownListStyle, 2225
Dynamic dialog, 1699
Dynamize property with VBA, 1699
DynamicStateType property, 2225
Dynamization, 1695
Dynamic dialog with VBA, 1695
of properties with VBA, 1695
Scripts with VBA, 1695
Tag connection with VBA, 1695
Dynamizing, 1697, 1702
Property with C script with VBA, 1702
WinCC: Scripting (VBS, ANSI-C, VBA)
2644 System Manual, 09/2018, A5E45518271-AA
Index
Property with Dynamic dialog with VBA, 1699 prevent, 1717
Property with Tag Connection, 1697 Shutting down, 1717
Property with VB script with VBA, 1705 Event Handling VBA Events, 1752
Event-driven, 65
EventName, 2232
E EventQuitMask, 2229
Events, 1752
Edit, 53, 722, 1666
Activated, 1759
Action, 53
BeforeClose, 1759
Copy of a Picture with VBA, 1668
BeforeDocumentClose, 1760
Layer with VBA, 1666
BeforeDocumentSave, 1761
Edit window
BeforeHMIObjectDelete, 1762
Working in the edit window, 882
BeforeLibraryFolderDelete, 1763
Edit:Action, 58
BeforeLibraryObjectDelete, 1764
Editing, 58
BeforeQuit, 1766
Procedures, 37
BeforeSave, 1767
Editing function, 884
BeforeVisibleFalse, 1767
Editing functions with the keyboard, 883
ConnectionEvent, 1768
Editing functions with the mouse, 884
DataLanguageChanged, 1769
Editing Objects with VBA, 1670
DesktopLanguageChanged, 1770
Editing Window, 31
DocumentActivated, 1771
Editing window:Color coding, 31
DocumentCreated, 1772
Editing Window:Global Script, 31
DocumentOpened, 1773
Editor, 27, 28, 33
DocumentPropertyChanged, 1775
Editor toolbars, 33
DocumentSaved, 1774
Editor:VBS editor in the Graphics Designer, 27
HMIObjectAdded, 1775
EnableFlashing, 2228
HMIObjectMoved, 1776
Error, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
HMIObjectPropertyChanged, 1777
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
HMIObjectResized, 1778
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
LibraryFolderRenamed, 1779
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
LibraryObjectAdded, 1781
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
LibraryObjectRenamed, 1780
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
MenuItemClicked, 1782
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
NewLibraryFolder, 1783
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
NewLibraryObject, 1784
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Opened, 1785
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Saved, 1786
1091, 1092, 1093, 1094, 1095, 1096
see reference:Events, 1752
Error codes, 459
SelectionChanged, 1787
Error Messages, 411, 822
Started, 1788
Error types, 88
ToolbarItemClicked, 1789
Error types:Logical error, 88
VBA Event Handling, 1752
Error types:Runtime Error, 88
ViewCreated, 1790
Error types:Syntax Error, 88
WindowStateChange, 1791
Error:syntax, 64
Example for VBS, 825
Event, 1717
Example in WinCC:Configuring a diagnostics output
application-specific, 1717
via Trace, 829
Forwarding, 1717
Example in WinCC:Configuring a language
picture-specific, 1717
change, 827
Event Handling, 1623, 1717, 1752
Example in WinCC:Configuring a picture change
Activated event, 1759
globally, 828
Forwarding of events, 1619
Overview, 1752
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2645
Index
Example in WinCC:Configuring a picture change via
Property, 829
Example in WinCC:Defining the color of objects, 827 F
Examples, 825
fabs, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Examples in WinCC, 826, 827, 828, 829, 830, 832,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
835, 838, 840
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
VBS in WinCC, 825
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Writing object properties, 835
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Examples in WinCC: Connect database backup with
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
VBS, 840
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Examples in WinCC:Accessing objects in Graphics
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Designer, 826
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Examples in WinCC:Deactivate Runtime, 828
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Examples in WinCC:Read tag values, 832
1091, 1092, 1093, 1094, 1095, 1096
Examples in WinCC:Start an Action on the Server
FaceplateObject object, 1974
(Logging Object), 838
FaceplateObjects, 1976
Executing, 1623
FaceplateProperty, 1976
VBA Macros, 1623
FaceplateType property, 2235
exit, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
fclose, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096
1091, 1092, 1093, 1094, 1095, 1096
ExitWinCC, 1514
Features, 907
exp, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
LockStatus, 2321
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
LockText, 2322
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
LockTextColor, 2323
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
LongStrokesBold, 2323
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
LongStrokesOnly, 2324
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
LongStrokesSize, 2325
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
LongStrokesTextEach, 2325
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Marker, 2327
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Max, 2327
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
MaximizeButton, 2328
1091, 1092, 1093, 1094, 1095, 1096
MaxZoom, 2329
Export, 722
MCGUBackColorOff, 2330
External application, 1721
MCGUBackColorOn, 2330
Access with VBA, 1721
MCGUBackFlash, 2331
Accessing MS Excel with VBA, 1722
MCGUTextColorOff, 2332
log on, 1721
MCGUTextColorOn, 2332
ExternalShapeInfo, 1973
MCGUTextFlash, 2333
MCKOBackColorOff, 2334
MCKOBackColorOn, 2334
MCKOBackFlash, 2335
MCKOTextColorOff, 2336
MCKOTextColorOn, 2336
WinCC: Scripting (VBS, ANSI-C, VBA)
2646 System Manual, 09/2018, A5E45518271-AA
Index
MCKOTextFlash, 2337 fflush, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
MCKQBackColorOff, 2338 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
MCKQBackColorOn, 2338 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
MCKQBackFlash, 2339 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
MCKQTextColorOff, 2340 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
MCKQTextColorOn, 2340 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
MCKQTextFlash, 2341 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
MCText, 2342 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
MenuItems, 2342 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
MenuItemType, 2343 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Min, 2345 1091, 1092, 1093, 1094, 1095, 1096
MinZoom, 2346 fgetc, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Modified, 2347 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Moveable, 2348 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Name, 2349 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
NegativeValue, 2350 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Number, 2351 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
ObjectName, 2353 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
ObjectSizeDecluttering, 2355 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
OffsetLeft, 2356 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
feof, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1091, 1092, 1093, 1094, 1095, 1096
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, fgetpos, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1091, 1092, 1093, 1094, 1095, 1096 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
ferror, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1091, 1092, 1093, 1094, 1095, 1096
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, fgets, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1091, 1092, 1093, 1094, 1095, 1096 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2647
Index
File, 891, 1012, 1013, 1014, 1015, 1016, 1017, 1018, Font style
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, Setting, 888
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, fopen, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1091, 1092, 1093, 1094, 1095, 1096 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Searching, 891 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
File_pos, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1091, 1092, 1093, 1094, 1095, 1096
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, ForeColor_Alarm, 2267
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, Format, 2269
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, Forwarding, 1717
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, of events, 1717
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, fputc, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1091, 1092, 1093, 1094, 1095, 1096 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
FillBackColor property, 2238 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
FillDiagnoseInTags, 1518 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
FireConnectionEvents, 1849 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
FlashPicture, 2251 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
FlashPictureState property, 2251 1091, 1092, 1093, 1094, 1095, 1096
FlashState property, 2258 fputs, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
floor, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096
1091, 1092, 1093, 1094, 1095, 1096 fread, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
fmod, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096
1091, 1092, 1093, 1094, 1095, 1096
WinCC: Scripting (VBS, ANSI-C, VBA)
2648 System Manual, 09/2018, A5E45518271-AA
Index
free, 1012, 1013, 1014, 1015, 1016, 1017, 1018, fsetpos, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096 1091, 1092, 1093, 1094, 1095, 1096
freopen, 1012, 1013, 1014, 1015, 1016, 1017, 1018, ftell, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096 1091, 1092, 1093, 1094, 1095, 1096
frexp, 1012, 1013, 1014, 1015, 1016, 1017, 1018, Function
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, Application, 894
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, Compiling, 890, 894, 903
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, Creating, 866, 894
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, Creating new function, 897
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, Defining, 866
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, Differences between actions and functions, 907
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, Editing, 894
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, Finding, 894
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, Functions from other sources, 906
1091, 1092, 1093, 1094, 1095, 1096 Printing, 892
fseek, 1012, 1013, 1014, 1015, 1016, 1017, 1018, Protection against read and write access, 902
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, Renaming, 905
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, Saving, 903
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, Structuring, 866
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, Use of DLLs, 878
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, Using internal functions, 899
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, Function code, 898
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, writing, 898
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, Function Trend Control, 281
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, Functions, 2573
1091, 1092, 1093, 1094, 1095, 1096 CloseSingleAlarm (VBA), 2627
CloseTag (VBA), 2568
CloseTlgArchive (VBA), 2583
CloseTlgTag (VBA), 2585
CommitSingleAlarm (VBA), 2628
CommitTag (VBA), 2569
CommitTlgArchive (VBA), 2587
CommitTlgTag (VBA), 2589
CreateSingleAlarm (VBA), 2630
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2649
Index
CreateTag (VBA), 2570 GetAdaptSize, 1192
CreateText (VBA), 2612 GetAlarmHigh, 1161
CreateTextLanguage (VBA), 2611 GetAlarmLow, 1162
CreateTlgArchive (VBA), 2591 GetAlignment, 1097
CreateTlgTag (VBA), 2594 GetAlignmentLeft, 1130
DeleteSingleAlarm (VBA), 2633 GetAlignmentTop, 1131
DeleteTag (VBA), 2572 GetAssignments, 1151
DeleteText (VBA), 2613 GetAssumeOnExit, 1152
DeleteTlgArchive (VBA), 2600 GetAssumeOnFull, 1152
DeleteTlgTag (VBA), 2601 GetAverage, 1192
GetSingleAlarm (VBA), 2634 GetAxisSection, 1098
GetTag (VBA), 2573 GetBackBorderWidth, 1241
GetText (VBA), 2617 GetBackColor, 1105
GetTextID (VBA), 2618 GetBackColor2, 1106
GetTlgArchive (VBA), 2603 GetBackColor3, 1106
GetTlgTag (VBA), 2604 GetBackColorBottom, 1107
ListSingleAlarm (VBA), 2635 GetBackColorTop, 1107
ListTag (VBA), 2574 GetBackFlashColorOff, 1121
ListText (VBA), 2621 GetBackFlashColorOn, 1122
ListTlgArchive (VBA), 2606 GetBasePicReferenced, 1233
ListTlgTag (VBA), 2608 GetBasePicTransColor, 1234
ModifyText (VBA), 2622 GetBasePicture, 1235
FunctionTrendControl, 246 GetBasePicUseTransColor, 1235
fwrite, 1012, 1013, 1014, 1015, 1016, 1017, 1018, GetBitNumber, 1153
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, GetBorderBackColor, 1108
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, GetBorderColor, 1109
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, GetBorderColorBottom, 1109
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, GetBorderColorTop, 1110
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, GetBorderEndStyle, 1241
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, GetBorderFlashColorOff, 1122
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, GetBorderFlashColorOn, 1123
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, GetBorderStyle, 1242
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, GetBorderWidth, 1242
1091, 1092, 1093, 1094, 1095, 1096 GetBoxAlignment, 1243
GetBoxCount, 1138
GetBoxType, 1193
G GetButtonColor, 1110
GetCaption, 1194
Gauge Control, 251
GetCheckAlarmHigh, 1162
GCreateMyOperationMsg, 937
GetCheckAlarmLow, 1163
GCS-Runtime, 82
GetCheckLimitHigh4, 1163
GCS-Runtime:Attribute, 84
GetCheckLimitHigh5, 1164
General Examples, 857, 858, 860, 861
GetCheckLimitLow4, 1165
General examples:Configuring a database
GetCheckLimitLow5, 1166
connection with VBS, 858
GetCheckToleranceHigh, 1166
General examples:Retrieve MS automation
GetCheckToleranceLow, 1167
interfaces, 860
GetCheckWarningHigh, 1168
General examples:Starting external application, 861
GetCheckWarningLow, 1168
Get_Focus, 1129
GetClearOnError, 1154
GetActualPointLeft, 1137
GetClearOnNew, 1154
GetActualPointTop, 1138
GetCloseButton, 1194
GetAdaptBorder, 1190
GetColorAlarmHigh, 1169
GetAdaptPicture, 1191
WinCC: Scripting (VBS, ANSI-C, VBA)
2650 System Manual, 09/2018, A5E45518271-AA
Index
GetColorAlarmLow, 1170 GetFontName, 1133
GetColorBottom, 1111 GetFontSize, 1133
GetColorChangeType, 1195 GetFontUnderline, 1134
GetColorLimitHigh4, 1170 GetForeColor, 1113
GetColorLimitHigh5, 1171 GetForeFlashColorOff, 1127
GetColorLimitLow4, 1171 GetForeFlashColorOn, 1128
GetColorLimitLow5, 1172 GetGrid, 1140
GetColorToleranceHigh, 1173 GetGridColor, 1114
GetColorToleranceLow, 1173 GetGridHeight, 1141
GetColorTop, 1112 GetGridWidth, 1141
GetColorWarningHigh, 1174 GetHeight, 1142
GetColorWarningLow, 1174 GetHiddenInput, 1155
GetColumn, 723, 733, 740, 741, 799, 800, 814, 815 GetHitlistColumn,
GetColumnCollection, 724 GetHitlisteColumnCollection, 726
GetCursorControl, 1196 GetHotkey, 1199
GetCursorMode, 1196 GetHWDiag, 1003
GetDataFormat, 1155 GetHWDiagLevel, 1004
GetDirection, 1139 GetHysteresis, 1199
GetEditAtOnce, 1197 GetHysteresisRange, 1200
GetEndAngle, 1140 GetIndex, 1240
getenv, 1012, 1013, 1014, 1015, 1016, 1017, 1018, GetInputValueChar, 1156
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, GetInputValueDouble, 1157
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, GetItemBorderBackColor, 1114
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, GetItemBorderColor, 1115
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, GetItemBorderStyle, 1245
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, GetItemBorderWidth, 1246
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, GetKopFupAwl, 1006
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, GetKopFupAwlLevel, 1007
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, GetLanguage, 1514
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, GetLanguageSwitch, 1200
1091, 1092, 1093, 1094, 1095, 1096 GetLastChange, 1201
GetExponent, 1098 GetLayer, 1136
GetExtendedOperation, 1198 GetLeft, 1142
GetFillColor, 1112 GetLeftComma, 1099
GetFilling, 1119 GetLimitHigh4, 1175
GetFillingIndex, 1120 GetLimitHigh5, 1176
GetFillStyle, 1244 GetLimitLow4, 1176
GetFillStyle2, 1244 GetLimitLow5, 1177
GetFlashBackColor, 1123 GetLimitMax, 1177
GetFlashBorderColor, 1124 GetLimitMin, 1178
GetFlashFlashPicture, 1236 GetLink, 1189
GetFlashForeColor, 1125 GetLinkedVariable, 942
GetFlashPicReferenced, 1236 GetListType, 1157
GetFlashPicTransColor, 1237 GetLocalPicture, 943
GetFlashPicture, 1238 GetLongStrokesBold, 1099
GetFlashPicUseTransColor, 1238 GetLongStrokesOnly, 1100
GetFlashRateBackColor, 1126 GetLongStrokesSize, 1101
GetFlashRateBorderColor, 1126 GetLongStrokesTextEach, 1101
GetFlashRateFlashPic, 1239 GetMarker, 1179
GetFlashRateForeColor, 1127 GetMax, 1202
GetFontBold, 1131 GetMaximizeButton, 1202
GetFontItalic, 1132 GetMessageBlock,
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2651
Index
GetMessageBlockCollection, GetRightComma, 1102
GetMessageColumn, 729 GetRotationAngle, 1146
GetMessageColumnCollection, GetRoundCornerHeight, 1147
GetMin, 1203 GetRoundCornerWidth, 1148
GetMoveable, 1203 GetRulerBlock,
GetNumberLines, 1158 GetRulerBlockCollection,
GetOffsetLeft, 1204 GetRulerColumn, 737
GetOffsetTop, 1205 GetRulerColumnCollection,
GetOnTop, 1205 GetRulerData, 739
GetOperation, 1206 GetScaleColor, 1115
GetOperationMessage, 1206 GetScaleTicks, 1103
GetOperationReport, 1207 GetScaling, 1103
GetOperatorMessage, GetScalingType, 1104
GetOperatorMessageCollection, GetScrollBars, 1210
GetOrientation, 1135 GetSelBGColor, 1116
GetOutputFormat, 1159 GetSelTextColor, 1117
GetOutputValueChar, 1159 GetServerName, 1211
GetOutputValueDouble, 1160 GetServerTagPrefix, 1518
GetParentPicture, 944 GetSizeable, 1211
GetParentPictureWindow, 945 GetSmallChange, 1212
GetPasswordLevel, 1208 GetStartAngle, 1148
GetPicDeactReferenced, 1220 GetStatisticAreaColumn, 743
GetPicDeactTransparent, 1220 GetStatisticAreaColumnCollection, 744
GetPicDeactUseTransColor, 1221 GetStatisticResultColumn, 745
GetPicDownReferenced, 1222 GetStatisticResultColumnCollection, 746
GetPicDownTransparent, 1222 GetStatusbarElement, 747
GetPicDownUseTransColor, 1223 GetStatusbarElementCollection, 748
GetPicReferenced, 1224 GetTagBit, 1461
GetPicTransColor, 1224 GetTagBitState, 1423
GetPictureDeactivated, 1225 GetTagBitStateQC, 1442
GetPictureDown, 1226 GetTagBitStateQCWait, 1431
GetPictureName, 1209 GetTagBitStateWait, 1414
GetPictureUp, 1227 GetTagBitWait, 1453
GetPicUpReferenced, 1227 GetTagByte, 1462
GetPicUpTransparent, 1228 GetTagByteState, 1424
GetPicUpUseTransColor, 1229 GetTagByteStateQC, 1443
GetPicUseTransColor, 1229 GetTagByteStateQCWait, 1432
GetPointCount, 1143 GetTagByteStateWait, 1415
GetPosition, 1218 GetTagByteWait, 1453
GetPressed, 1246 GetTagChar, 1463
GetProcess, 1209 GetTagCharState, 1425
GetPropBOOL, 1230 GetTagCharStateQC, 1444
GetPropChar, 1231 GetTagCharStateQCWait, 1433
GetPropDouble, 1232 GetTagCharStateWait, 1415
GetPropWord, 1232 GetTagCharWait, 1454
GetRadius, 1144 GetTagDateTime, 1463
GetRadiusHeight, 1144 GetTagDouble, 1464
GetRadiusWidth, 1145 GetTagDoubleState, 1425
GetRangeMax, 1218 GetTagDoubleStateQC, 1445
GetRangeMin, 1219 GetTagDoubleStateQCWait, 1434
GetReferenceRotationLeft, 1145 GetTagDoubleStateWait, 1416
GetReferenceRotationTop, 1146 GetTagDoubleWait, 1455
WinCC: Scripting (VBS, ANSI-C, VBA)
2652 System Manual, 09/2018, A5E45518271-AA
Index
GetTagDWord, 1464 GetTimeAxisCollection, 750
GetTagDWordState, 1426 GetTimeColumn, 752
GetTagDWordStateQC, 1446 GetTimeColumnCollection, 753
GetTagDWordStateQCWait, 1434 GetTlgTrigger (VBA), 2606
GetTagDWordStateWait, 1417 GetToggle, 1247
GetTagDWordWait, 1455 GetToleranceHigh, 1179
GetTagFloat, 1465 GetToleranceLow, 1180
GetTagFloatState, 1427 GetToolbarButton, 754
GetTagFloatStateQC, 1447 GetToolbarButtonCollection, 755
GetTagFloatStateQCWait, 1435 GetTop, 1149
GetTagFloatStateWait, 1418 GetTrend, 756, 1213
GetTagFloatWait, 1456 GetTrendCollection, 757
GetTagMultiStateQCWait, 1436 GetTrendColor, 1117
GetTagMultiStateWait, 1418 GetTrendWindow, 759
GetTagMultiWait, 1456 GetTrendWindowCollection, 760
GetTagPrefix, 1213 GetTypeAlarmHigh, 1181
GetTagRaw, 1465 GetTypeAlarmLow, 1181
GetTagRawState, 1427 GetTypeLimitHigh4, 1182
GetTagRawStateQC, 1448 GetTypeLimitHigh5, 1183
GetTagRawStateQCWait, 1437 GetTypeLimitLow4, 1183
GetTagRawStateWait, 1420 GetTypeLimitLow5, 1184
GetTagRawWait, 1457 GetTypeToleranceHigh, 1185
GetTagSByte, 1466 GetTypeToleranceLow, 1186
GetTagSByteState, 1428 GetTypeWarningHigh, 1186
GetTagSByteStateQC, 1449 GetTypeWarningLow, 1187
GetTagSByteStateQCWait, 1438 GetUnselBGColor, 1118
GetTagSByteStateWait, 1420 GetUnselTextColor, 1118
GetTagSByteWait, 1458 GetUpdateCycle, 1214
GetTagSDWord, 1467 GetValueAxis, 761
GetTagSDWordState, 1429 GetValueAxisCollection, 762
GetTagSDWordStateQC, 1449 GetValueColumn, 763
GetTagSDWordStateQCWait, 1439 GetValueColumnCollection, 764
GetTagSDWordStateWait, 1421 GetVisible, 1215
GetTagSDWordWait, 1459 GetWarningHigh, 1188
GetTagSWord, 1467 GetWarningLow, 1188
GetTagSWordState, 1430 GetWidth, 1149
GetTagSWordStateQC, 1450 GetWindowBorder, 1215
GetTagSWordStateQCWait, 1440 GetWindowsStyle, 1247
GetTagSWordStateWait, 1422 GetXAxis, 766
GetTagSWordWait, 1459 GetXAxisCollection, 767
GetTagValue, 1468 GetYAxis, 768
GetTagValueStateQC, 1451 GetYAxisCollection, 769
GetTagValueStateQCWait, 1441 GetZeroPoint, 1150
GetTagValueWait, 1460 GetZeroPointValue, 1216
GetTagWord, 1469 GetZoom, 1217
GetTagWordState, 1430 Global action, 874
GetTagWordStateQC, 1452 Application, 874
GetTagWordStateQCWait, 1442 Characteristics, 874
GetTagWordStateWait, 1423 Global C tags, 876
GetTagWordWait, 1461 Application, 876
GetText, 1135 Definition, 876
GetTimeAxis, 749
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2653
Index
Global Script, 880 Inserting GSC Diagnose in a process picture, 934
Action icon, 907 New trigger of type Trigger:new trigger of type
Action structure, 866 Global Script:Adding trigger, 919
Adding action-related information, 912 New trigger of type Trigger:New trigger of type
Adding function-related Information, 901 TagGlobalScript:Adding trigger, 920
Assigning authorization, 923 Opening, 924
Authorizations, 923 Opening page view, 893
Cause for non-execution of an action, 907 Password input, 902, 914
Changing trigger, 921 Printing action, 892
Characteristics of global actions, 874 Printing function, 892
Characteristics of internal functions, 872 Printing project documentation, 893
Characteristics of local actions, 873 Properties, 901, 902, 912, 914, 921, 922
Characteristics of project functions, 869 Protecting function against read and write
Characteristics of standard functions, 870 access, 902
Color code, 882 Protection against read and write access, 914
Compiling action, 907, 915 Renaming action, 907, 924
Compiling function, 890, 894, 903 Renaming function, 905
Computer properties, 875 Runtime behavior of actions, 927
Creating action, 866, 907 Saving action, 915
Creating function, 866 Saving file as, 923
Creating internal function, 897 Saving function, 903
Creating new actions, 911 Searching files, 891
Creating new function, 897 Setting different views, 888
Defining action, 866 Setting print parameters, 892
Defining function, 866 Setting the font style, 888
Definition of global C tags, Structure of Global Script editor, 880
Deleting action, 889 System behavior, 907
Deleting project functions, 889 Trigger type, 866
Deleting standard functions, 889 Use of DLLs in actions, 878
Deleting trigger, 922 Use of DLLs in functions, 878
Design tool, 866 Use of global actions, 874
Differences between actions and functions, 907 Use of global C tags,
Editing action, 907, 912, 932 Use of Internal Functions, 872
Editing function, 894 Use of local actions, 873
Editing functions with the keyboard, 884 Use of project functions, 869
Editing functions with the mouse, 884 Use of standard functions, 870
Effect of triggers on actions, 916 Using "Save As...", 888
Exporting action, 923 Using actions from other sources, 925
Features, 907 Using functions, 894
Finding actions, 907 Using Functions from other sources, 906
Finding functions, 894 Using internal functions, 899
Function structure, 866 Using project functions, 900
Generating new header, 890 Using standard functions, 900
GSC Diagnose toolbar, Validity range,
GSC Runtime, 928 WinCC coding rules, 910
GSC Runtime attributes, 932 Working in the edit window, 882
Identification of actions in the navigation Working with toolbars, 885
window, 916 Writing function code, 898
Import action, 924 Global Script editor, 27, 28, 880
Including Global Script Runtime in the startup list Structure, 880
of the project, 875 Global Script Runtime, 875
Including GSC Runtime in a process picture, 931 Adding to startup list of the project, 875
WinCC: Scripting (VBS, ANSI-C, VBA)
2654 System Manual, 09/2018, A5E45518271-AA
Index
Global Script:Deleting Actions and Procedures, 35 Paste Object from the component library into a
Global Script:Toolbars, 33 picture with VBA, 1656
Global Script:Working in the Editing Window, 31 Paste Object from the symbol library into a picture
Global Tag, 25 with VBA, 1656
Global tag:Use in VBS, 25 picture-specific menu, 1631
GMsgFunction, 939 picture-specific toolbar, 1631
gmtime, 1012, 1013, 1014, 1015, 1016, 1017, 1018, Template file, 1619
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, User-defined menu, 1631
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, User-defined toolbar, 1631
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, Group Object
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, Editing existing objects, 1687
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, Editing with VBA, 1684
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, Removing an object with VBA, 1684
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, Group Objects, 1682
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, Access to object properties, 1682
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, Adding an object with VBA, 1684
1091, 1092, 1093, 1094, 1095, 1096 basics, 1682
GNQBackColorOff, 2270 Creating with VBA, 1684
GNQBackFlash, 2271 Deleting with VBA, 1684
GNQTextColorOff, 2271 Editing with VBA, 1682
GNQTextFlash, 2271 Ungrouping with VBA, 1684
Graphic object, 141 Grouping, 1682
Graphic Object:Properties, 141 Access to object properties, 1682
Graphic Object:Types in VBS, 141 Adding an object with VBA, 1684
Graphic object:WinCC Gauge Control, 251 basics, 1682
Graphics Designer, 1627 Creating with VBA, 1684
@GLOBAL.PDT, 1619 Deleting with VBA, 1684
@PROJECT.PDT, 1619 Editing existing objects, 1687
Access to objects, 1670 Editing with VBA, 1682, 1684
Access to the component library with VBA, 1650 Removing an object with VBA, 1684
Access to the symbol library with VBA, 1650 Ungrouping with VBA, 1684
Adapting with VBA, 1625, 1627 GSC Diagnose
Add menu entry to user-defined menu, 1635 Including in process picture, 934
Adding a New Icon to the used-defined Toolbar,
Toolbar, 1641 GSC Diagnostics, 81
Application-specific menu, 1631 GSC Diagnostics Attributes, 80
Application-specific toolbar, 1631 GSC Diagnostics: inserting into a Picture, 83
Assigning VBA macro to user-defined GSC Diagnostics:Attributes, 80
menu, 1645 GSC Diagnostics:Toolbar, 81
Assigning VBA macro to user-defined GSC Runtime
toolbar, 1645 Attributes, 932
Configure user-defined menu, 1630 Including in process picture, 931
Configure user-defined toolbar, 1630 GSC Runtime:Inserting into a Picture, 83
Create an application-specific menu, 1633
Create toolbar, 1639
Creating Menus in Multiple Languages, 1637 H
Editing objects with VBA, 1670
Header, 890
Executing VBA macros, 1623
Regenerating, 890
Exporting VBA code, 1622
HideAlarm, 771
Importing VBA code, 1622
Highlight Syntax, 42, 58
Object model, 1752
HitlistColumn object, 220
Organizing the VBA code, 1619
HitlistRelTimeFactorType, 449
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2655
Index
HMIGO class, 2563 isdigit, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Application, 2563 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Error Handling, 2563 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
HMIObjects, 1752 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
see HMIObjects, 1752 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
see the lists, 1752 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
HMIRuntime Object, 116 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
HMIUdoObjects, 2279 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
I 1091, 1092, 1093, 1094, 1095, 1096
isgraph, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Information, 46, 61
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Adding action-related information, 912
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Adding to action, 61
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Adding to module, 46
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Adding to procedure, 46
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
InquireLanguage, 1515
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Insert:GSC Diagnostics, 80
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Insert:GSC Runtime, 83
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Intellisense, 42, 58
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Internal function, 872
1091, 1092, 1093, 1094, 1095, 1096
Application, 872
islower, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Characteristics, 872
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
introduction, 920
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
isahum, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1091, 1092, 1093, 1094, 1095, 1096
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
isprint, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1091, 1092, 1093, 1094, 1095, 1096
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
isalpha, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1091, 1092, 1093, 1094, 1095, 1096
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
IsPublished property, 2287
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096
WinCC: Scripting (VBS, ANSI-C, VBA)
2656 System Manual, 09/2018, A5E45518271-AA
Index
ispunct, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, L
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
labs, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1091, 1092, 1093, 1094, 1095, 1096
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
isspace, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1091, 1092, 1093, 1094, 1095, 1096
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Language, 459
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Layer, 1666
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Controlling the visibility with VBA, 1666
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
CS, 1666
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Editing with VBA, 1666
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
RT, 1666
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Layer Object, 118
1091, 1092, 1093, 1094, 1095, 1096
Layer00FillColor ..., 2301
isupper, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Layer00FillStyle ..., 2301
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Layers Object (Listing), 119
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
LDAssignments, 2304
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
ldexp, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1091, 1092, 1093, 1094, 1095, 1096
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
isxdigit, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1091, 1092, 1093, 1094, 1095, 1096
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
LDFontsType property, 2305
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
ldiv, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1091, 1092, 1093, 1094, 1095, 1096
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Item Object, 117
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096
ListBox object, 2010
Lists
Actions, 1904
AnalogResultInfo, 1914
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2657
Index
Application, 1915 log, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019,
DataLanguages, 1947 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027,
Documents, 1957 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035,
Events, 1972 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043,
FolderItems, 1978 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051,
GroupedObjects, 1988 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059,
HMIDefaultObjects, 1989 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067,
HMIObjects, 1994 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075,
LanguageFonts, 2001 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083,
LanguageTexts, 2004 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091,
Layers, 2006 1092, 1093, 1094, 1095, 1096
MenuItems, 2019 log10, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Menus, 2015 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Overview, 1752 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Properties, 2045 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
QualityCodeStateValues, 2050 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Selection, 2063 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
SVGLibraries, 2077 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
SymbolLibraries, 2082 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
ToolbarItems, 2094 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Toolbars, 2090 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
VariableStateValues, 2106 1091, 1092, 1093, 1094, 1095, 1096
VariableTriggers, 2110 Logging Object, 120
Views, 2112 Logical errors, 88
Lists in VBS LoopInAlarm, 774
Alarms object (list), 108 lpszPictureName, 936
DataSet Object (List), 113
Layers Object (Listing), 119
ProcessValues Object (Lists), 122 M
ScreenItems object (list), 127
malloc, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Screens Object (Lists), 132
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Tags Object (List), 137
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
TagSet Object (List), 139
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
ListTlgTrigger (VBA), 2609
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Local actions, 873
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Application, 873
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Characteristics, 873
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
localtime, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1091, 1092, 1093, 1094, 1095, 1096
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
math, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1091, 1092, 1093, 1094, 1095, 1096
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
LockAlarm, 773
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096
MaxIndex, 2328
WinCC: Scripting (VBS, ANSI-C, VBA)
2658 System Manual, 09/2018, A5E45518271-AA
Index
MediaControl, 254 memory, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
memchr, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096
1091, 1092, 1093, 1094, 1095, 1096 memset, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
memcmp, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096
1091, 1092, 1093, 1094, 1095, 1096 Menu, 1631, 1663
memcpy, 1012, 1013, 1014, 1015, 1016, 1017, 1018, Add menu entry, 1635
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, application-specific, 1631
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, Assigning help text, 1643
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, Assigning status text, 1643
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, Assigning VBA macro, 1645
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, Configuring, 1630
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, Creating, 1633
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, creating multiple languages, 1637
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, picture-specific, 1631, 1663
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, Placement, 1631
1091, 1092, 1093, 1094, 1095, 1096 Properties, 1631
memmove, 1012, 1013, 1014, 1015, 1016, 1017, User-defined, 1631
1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, Menu bar, 880
1026, 1027, 1028, 1029, 1030, 1031, 1032, 1033, Menus and toolbars
1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, VBScript, 12
1042, 1043, 1044, 1045, 1046, 1047, 1048, 1049, MenuToolBarConfig, 2344
1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, MessageBlock object, 221
1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, MessageColumn object, 221
1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073, Methods, 718, 719, 720, 721, 722, 723, 724, 725,
1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 726, 727, 728, 729, 730, 731, 732, 733, 734, 735, 736,
1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 737, 738, 739, 740, 741, 743, 744, 745, 746, 747, 748,
1090, 1091, 1092, 1093, 1094, 1095, 1096 749, 750, 752, 753, 754, 755, 756, 757, 759, 760, 761,
762, 763, 764, 766, 767, 768, 769, 771, 773, 774, 777,
778, 779, 780, 781, 782, 783, 784, 785, 789, 799, 800,
801, 802, 803, 804, 805, 806, 807, 808, 809, 810, 811,
812, 814, 815, 819, 820, 821, 822, 1752
Activate, 1792
Add, 1793
Add (AnalogResultInfos Listing), 1793
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2659
Index
Add (CustomToolbars Listing), 1795 InsertToolbarItem, 1862
Add (Documents Listing), 1797 IsCSLayerVisible, 1863
Add (GroupedObjects), 1798 IsRTLayerVisible, 1864
Add (TagTriggers Listing), 1799 Item, 772, 1865
Add (Views Listing), 1800 ItemByLcid, 1867
AddAction, 1801 LoadDefaultConfig, 1869
AddActiveXControl, 1802 MoveOneLayerDown, 1869
AddFolder, 1805 MoveOneLayerUp, 1870
AddFromClipboard, 1806 MoveSelection, 1871
AddHMIObject, 1807 Open, 1873
AddItem, 1809 Overview, 1752
AddOLEObject, 1804, 1810, 1812 PasteClipboard, 1874
AlignBottom, 1813 PrintDocument, 1875
AlignLeft, 1814 PrintProjectDocumentation, 1876
AlignRight, 1815 Remove, 1876
AlignTop, 1816 Rotate, 1878
ArrangeMinimizedWindows, 1817 SameHeight, 1880
BackwardOneLevel, 1818 SameWidth, 1882
BringToFront, 1819 SameWidthAndHeight, 1883
CascadeWindows, 1820 Save, 1885
CenterHorizontally, 1821 SaveAll, 1885
CenterVertically, 1822 SaveAs, 1886
CheckSyntax, 1823 SaveDefaultConfig, 1887
Close, 1824 SelectAll, 1888
CloseAll, 1825 SendToBack, 1889
ConvertToScript, 1826 SetCSLayerVisible, 1891
ConvertToVBScript, 1827 SetDeclutterObjectSize, 1892
CopySelection, 1828 SetOpenContext, 1892
CopyToClipboard, 1830 SetRTLayerVisible, 1893
CreateCustomizedObject, 1831 ShowPropertiesDialog, 1894
CreateDynamic, 1833 ShowSymbolLibraryDialog, 1895
CreateGroup, 1835 ShowTagDialog, 1896
Delete, 1837 TileWindowsHorizontally, 1896
DeleteAll, 1838 TileWindowsVertically, 1897
DeleteDynamic, 1839 Ungroup, 1898
Destroy, 1841 Methods in VBS
DuplicateSelection, 1842 ActivateDynamic, 715
EvenlySpaceHorizontally, 1843 Create, 719
EvenlySpaceVertically, 1844 DeactivateDynamic, 720
Export, 1846 Methods:Activate, 714
Find, 1847 Methods:Add, 716
FindByDisplayName, 1848 Methods:Read, 785
FlipHorizontally, 1849 Methods:Refresh, 790
FlipVertically, 1851 Methods:Remove, 790
ForwardOneLevel, 1852 Methods:RemoveAll, 794
GetDeclutterObjectSize, 1836 Methods:Restore, 796
GetItemByPath, 1853 Methods:Stop, 812
InsertFromMenuItem, 1854 Methods:Trace, 813
InsertMenu, 1856 Methods:Write, 815
InsertMenuItem, 1858 Microsoft Script Debugger, 85
InsertSeparator, 1859
InsertSubmenu, 1860
WinCC: Scripting (VBS, ANSI-C, VBA)
2660 System Manual, 09/2018, A5E45518271-AA
Index
mktime, 1012, 1013, 1014, 1015, 1016, 1017, 1018, Navigation window
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, Identification of actions in the navigation
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, window, 916
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, New, 40, 57
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, Procedure, 40
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, New:Action, 57
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, NextColumn, 781
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, NextTrend, 782
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, NibbleSelect property, 2351
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096
modf, 1012, 1013, 1014, 1015, 1016, 1017, 1018, O
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Object model, 1752
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Lists, 105
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Methods, 713
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Objects, 105
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Object model:Properties, 297
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Object names, 92
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Object Types
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Controls, 216
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Customized object, 294
1091, 1092, 1093, 1094, 1095, 1096
Object Types:Group, 296
Module, 37, 40
Objects, 1752
Adding information, 46
3DBarGraph, 1900
Create, 40
ActiveXControl, 1906
Dialog "Info", 46, 48
AnalogResultInfo, 1913
Editing, 37
ApplicationWindow, 1917
Name, 37
BarGraph, 1920
Protecting with a Password, 48
BinaryResultInfo, 1924
Save, 49
BitResultInfo, 1925
Module:Renaming, 51
Button, 1926
MoveAxis, 774
CheckBox, 1930
MoveRuler, 774
Circle, 1933
MoveToFirst, 777
CircularArc, 1936
MoveToFirstLine, 777
ConnectorPoints (Listing), 1941
MoveToFirstPage, 777
CustomizedObject, 1943
MoveToLast, 778
DataLanguage, 1946
MoveToLastLine, 778
DestLink, 1950
MoveToLastPage, 779
DirectConnection, 1952
MoveToNext, 779
Document, 1954
MoveToNextLine, 779
DynamicDialog, 1960
MoveToNextPage, 780
Ellipse, 1962
MoveToPrevious, 780
EllipseArc, 1965
MoveToPreviousLine, 781
EllipseSegment, 1968
MoveToPreviousPage, 781
Event, 1971
MultiLineEdit object, 2020
FolderItem, 1977
GraphicObject, 1980
Group, 1983
N GroupDisplay, 1985
Names, 92 HMIObject, 1992
Names:of actions in VBScript Files, 92 IOField, 1996
LanguageFont, 2000
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2661
Index
LanguageText, 2003 Project Object, 122
Layer, 2005 Screen Object, 129
Line, 2008 ScreenItem Object, 123
Menu, 2013 Smart tags, 134
MenuItem, 2017 Tag Object, 135
objConnection, 2023 Objects VBA Reference
OLEObject, 2027 Objects and Lists, 1752
OptionGroup, 2029 Objektnames:define in Runtime, 92
Overview, 1752 OnDeactivateExecute, 1008
PictureWindow, 2033 OnErrorExecute, 1008
PieSegment, 2036 OneToOneView, 782
Polygon, 2039 Online Trend Control, 288
PolyLine, 2042 OnlineTableControl, 254
Property, 2046 Example of C script, 1585
QualityCodeStateValue, 2048 VBS example, 853
Rectangle, 2053 OnlineTrendControl, 260
RoundButton, 2055 Example of C script, 1586
RoundRectangle, 2059 TimeAxis object, 228
ScriptInfo, 2062 ValueAxis object, 233
Slider, 2066 VBS example, 848
SourceLink, 2069 VBS example to setpoint trend, 851
StaticText, 2071 OnTime, 1010
StatusDisplay, 2074 OpenHomePicture, 1406
SVGLibrary, 2078 Opening, 924
SVGObject, 2080 OpenNextPicture, 1407
SymbolLibrary, 2084 OpenPicture, 946
TextList, 2085 OpenPrevPicture, 1407
Toolbar, 2089 OpenStoredPicture, 1408
ToolbarItem, 2092 OperatorMessage object, 222
Trigger, 2096 OriginalPropertyName property, 2362
VariableStateValue, 2105 Output, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
VariableTrigger, 2108 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
View, 2111 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Objects in VBA 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
ComboBox, 1939 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
FaceplateObject, 1974 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
ListBox, 2010 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
MultiLineEdit, 2020 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
TubeArcObject, 2097 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
TubeDoubleTeeObject, 2099 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
TubePolyline, 2101 1091, 1092, 1093, 1094, 1095, 1096
TubeTeeObject, 2103 Output window, 880
Objects in VBS OutputValue, 2364
Alarm object, 108
AlarmLogs Object, 110
DataItem Object, 111 P
DataLogs Object, 112
Page view
HMIRuntime Object, 116
Opening, 893
Item Object, 117
PaintColor_QualityCodeBad, 2364
Layer Object, 118
PaintColor_QualityCodeUnCertain, 2364
Logging Object, 120
ParentCookie property, 2367
ProcessValue Object, 121
WinCC: Scripting (VBS, ANSI-C, VBA)
2662 System Manual, 09/2018, A5E45518271-AA
Index
Password, 48, 63 Procedure:Change, 42
assign fro action, 63 Procedure:Delete, 35
for a module, 48 Procedure:Project Procedure, 45
for a Procedure, 48 Procedure:Rename, 51
Password input, 902, 914 Procedure:Standard procedure, 45
Paste, 80, 83 Procedure:Storage location in WinCC, 21
PasteRows, Procedure:use multiple times, 21
Picture, 1668 Procedure:Write Code, 42
Editing copy with VBA, 1668 Process, 2388
Picture-specific menu, 1665 Process1, 2388
Assigning help text, 1643 Process2, 2389
Assigning status text, 1643 Process3, 2389
Assigning VBA macro, 1645 ProcessValue Object, 121
Configuring, 1630 ProcessValues Object (List), 122
Creating, 1665 ProgramExecute, 1010
creating multiple languages, 1637 Project documentation
Picture-specific toolbar, 1665 Printing, 893
Assigning status text, 1643 Project function, 869
Assigning VBA macro, 1645 Application, 869
Configuring, 1630 Applying, 900
Creating, 1665 Characteristics, 869
Pinnable property, 2382 Deleting, 889
Pinned property, 2382 Project language, 1628
pow, 1012, 1013, 1014, 1015, 1016, 1017, 1018, Access with VBA, 1628
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, Project Object, 122
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, Project Procedure:Use, 45
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, Properties, 901, 902, 912, 914, 921, 922, 1752
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, Actions, 2115
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, ActiveDocument, 2116
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, ActiveLayer, 2117
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, ActualPointLeft, 2118
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, ActualPointTop, 2119
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, AdaptBorder, 2120
1091, 1092, 1093, 1094, 1095, 1096 AdaptPicture, 2120
PreviousColumn, 783 AdaptSize, 2121
PreviousTrend, 783 AlarmHigh, 2123
Print, 784 AlarmLow, 2124
Print parameters, 892 Alignment, 2125
Setting, 892 AlignmentLeft, 2125
Print:VBScript, 102 AlignmentTop, 2126
PrioAlarm, 2387 AnalogResultInfos, 2127
PrioBit16, 2387 AngleAlpha, 2128
procedure, 1623 AngleBeta, 2129
Adding information, 46 Application, 2129
Create New, ApplicationDataPath, 2130
Creating, 37 Assignments, 2131
Dialog "Info", 46, 48 AssumeOnExit, 2131
Editing, 37 AssumeOnFull, 2132
Name, 37 AutomationName, 2133
Protecting with a Password, 48 AvailableDataLanguages, 2135
Save, 49 Average, 2136
Version, 1623 Axe, 2136
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2663
Index
AxisSection, 2137 CheckToleranceHigh, 2183
BackBorderWidth, 2138 CheckToleranceLow, 2184
BackColor, 2139 CheckWarningHigh, 2185
BackColor2, 2140 CheckWarningLow, 2186
BackColor3, 2141 ClearOnError, 2187
BackColorBottom, 2142 ClearOnNew, 2188
BackColorTop, 2142 CloseButton, 2189
BackFlashColorOff, 2145 ColorAlarmHigh, 2189
BackFlashColorOn, 2146 ColorAlarmLow, 2190
Background, 2147 ColorBottom, 2191
BackPictureAlignment, 2148 ColorChangeType, 2192
BackPictureName, 2148 ColorLimitHigh4, 2193
BarDepth, 2148 ColorLimitHigh5, 2193
BarHeight, 2149 ColorLimitLow4, 2194
BarWidth, 2149 ColorLimitLow5, 2195
BasePicReferenced, 2150 ColorToleranceHigh, 2196
BasePicTransColor, 2151 ColorToleranceLow, 2197
BasePicture, 2151 ColorTop, 2198
BasePicUseTransColor, 2152 ColorWarningHigh, 2199
BaseX, 2153 ColorWarningLow, 2200
BaseY, 2154 CommandLine Property, 2203
BinaryResultInfo, 2154 CommonVBSCode, 2201
BitNotSetValue, 2154 Compiled, 2204
BitNumber, 2155 ConfigurationFileName, 2205
BitResultInfo, 2156 Count, 2208
BitSetValue, 2157 CurrentDataLanguage, 2211
Bold, 2158 CurrentDesktopLanguage, 2212
BorderBackColor, 2159 CursorControl, 2212
BorderColor, 2160 CursorMode, 2213
BorderColorBottom, 2162 CustomMenus, 2214
BorderColorTop, 2162 CustomToolbars, 2214
BorderEndStyle, 2163 CycleName, 2215
BorderFlashColorOff, 2164 CycleTime, 2215
BorderFlashColorOn, 2166 CycleType, 2216
BorderStyle, 2167 DataFormat, 2216
BorderWidth, 2168 DefaultHMIObjects, 2217
BottomConnectedConnectionPointIndex, 2170 DeselectAll Method, 1840
BottomConnectedObjectName, 2169 DestinationLink, 2218
BoxAlignment, 2170 Direction, 2220
BoxCount, 2171 DisableVBAEvents, 2221
BoxType, 2172 DisplayName, 2221
Button1Width, 2173 DisplayOptions, 2222
ButtonColor, 2174 DisplayText, 2223
Caption, 2175 Documents, 2224
CaptionText, 2176 Dynamic, 2225
CheckAlarmHigh, 2177 EditAtOnce, 2226
CheckAlarmLow, 2178 ElseCase, 2226
Checked, 2179 Enabled, 2227
CheckLimitHigh4, 2179 EndAngle, 2229
CheckLimitHigh5, 2180 Events, 2230
CheckLimitLow4, 2181 EventType, 2232
CheckLimitLow5, 2182 Exponent, 2233
WinCC: Scripting (VBS, ANSI-C, VBA)
2664 System Manual, 09/2018, A5E45518271-AA
Index
ExtendedOperation, 2234 IsConnectedToProject, 2286
ExtendedZoomingEnable, 2235 IsDynamicable, 2287
Family, 2236 Italic, 2288
FillColor, 2238 Item, 2289
Filling, 2239 ItemBorderBackColor, 2290
FillingIndex, 2240 ItemBorderColor, 2291
FillStyle, 2242 ItemBorderStyle, 2292
FillStyle2, 2244 ItemBorderWidth, 2292
FillStyleAlignment, 2245 Key, 2293
FlashBackColor, 2246 Label, 2295
FlashBorderColor, 2247 LanguageID, 2296
FlashFlashPicture, 2248 LanguageName, 2296
FlashForeColor, 2248 LanguageSwitch, 2297
FlashPicReferenced, 2249 Layer, 2298, 2299
FlashPicTransColor, 2250 Layer00Checked, 2299
FlashPicture, 2250 Layer00Color, 2300
FlashPicUseTransColor, 2252 Layer00Value, 2302
FlashRate, 2252 LayerDecluttering, 2302
FlashRateBackColor, 2253 Layers, 2303
FlashRateBorderColor, 2255 LDFonts, 2304
FlashRateFlashPic, 2256 LDLabelTexts, 2305
FlashRateForeColor, 2257 LDNames, 2307
FolderItems, 2260 LDStatusTexts, 2307
FontBold, 2262 LDTexts, 2309
FontColor, 2266 LDTooltipTexts, 2309
FontFlashColorOff, 2267 Left, 2311
FontFlashColorOn, 2268 LeftComma, 2311
FontItalic, 2263 LightEffect, 2312
FontName, 2263 LimitHigh4, 2312
FontSize, 2264 LimitHigh5, 2313
FontUnderline, 2265 LimitLow4, 2314
ForeColor, 2266 LimitLow5, 2315
ForeFlashColorOff, 2267 LimitMax, 2316
ForeFlashColorOn, 2268 LimitMin, 2317
GlobalColorScheme, 2270 LineJoinStyle, 2318
GlobalShadow, 2270 ListType, 2318
Grid, 2272 LockBackColor, 2319
GridColor, 2273 LockedByCreatorID, 2319
GridHeight, 2273 Macro, 2326
GridWidth, 2274 MessageClass, 2345
GroupedHMIObjects, 2275 NumberLines, 2352
GroupParent, 2275 OffsetTop, 2356
Height, 2276 OnTop, 2357
HiddenInput, 2278 Operation, 2358
Hide, 2277 OperationMessage, 2359
Hotkeys, 2279 OperationReport, 2360
Hysteresis, 2280 Orientation, 2361
HysteresisRange, 2281 OutputFormat, 2362
Icon, 2281, 2282, 2285 OutputValue, 2363
Index, 2283 Overview, 1752
InputValue, 2285 Parent, 2364
IsActive, 2285 PasswordLevel, 2367
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2665
Index
Path, 2368 ScrollPositionX, 2411
PdlProtection, 2369 ScrollPositionY, 2412
PicDeactReferenced, 2370 ScrollPosX, 2414
PicDeactTransparent, 2371 ScrollPosY, 2414
PicDeactUseTransColor, 2371 see properties, 1752
PicDownReferenced, 2372 SelBGColor, 2415
PicDownTransparent, 2373 Selected, 2415
PicDownUseTransColor, 2373 SelIndex, 2417
PicReferenced, 2374 SelText, 2417
PicTransColor, 2375 SelTextColor, 2417
PictureDeactivated, 2376 ServerName, 2418
PictureDown, 2376 ServerPrefix, 2419
PictureName, 2377 ShortCut, 2419
PictureUp, 2378 SignificantMask, 2421
PicUpReferenced, 2379 Size, 2422
PicUpTransparent, 2380 Sizeable, 2423
PicUpUseTransColor, 2380 SmallChange, 2423
PicUseTransColor, 2381 SnapToGrid, 2424
PointCount, 2382 SourceCode, 2426
Position, 2383 SourceLink, 2424
PositiveValue, 2384 StartAngle, 2428
PredefinedAngels, 2385 StatusText, 2428
Pressed, 2386 SubMenu, 2429
Process, 2387 SymbolLibraries, 2430
ProfileName, 2389 TabOrderAllHMIObjects, 2432
ProgID, 2389 TabOrderAlpha, 2431
ProjectName, 2390 TabOrderKeyboard, 2432
ProjectType, 2391 TabOrderMouse, 2433
Properties, 2391 TabOrderOtherAction, 2434
prototype, 2392 TabOrderSwitch, 2434
QualityCodeStateChecked, 2393 Tag, 2435
QualityCodeStateValues, 2395 TagPrefix, 2437
Radius, 2397 Text, 2440
RadiusHeight, 2397 Toggle, 2444
RadiusWidth, 2398 ToleranceHigh, 2444
RangeTo, 2399 ToleranceLow, 2445
ReferenceRotationLeft, 2399 ToolbarItems, 2446
ReferenceRotationTop, 2400 ToolTipText, 2448
Relevant, 2401 Top, 2449
ResultType, 2402 TopConnectedObjectName, 2449
RightComma, 2402 TopConnectedPointIndex, 2450
RotationAngle, 2403 Transparency, 2450
RoundCornerHeight, 2404 Trend, 2451
RoundCornerWidth, 2405 TrendColor, 2452
SameSize, 2405 Trigger, 2452
ScaleColor, 2406 Type:, 2453
ScaleTicks, 2407 TypeAlarmHigh, 2454
Scaling, 2407 TypeAlarmLow, 2455
ScalingMode, 2408 TypeLimitHigh4, 2455
ScalingType, 2408 TypeLimitHigh5, 2456
ScriptType, 2409 TypeLimitLow4, 2457
ScrollBars, 2410 TypeLimitLow5, 2458
WinCC: Scripting (VBS, ANSI-C, VBA)
2666 System Manual, 09/2018, A5E45518271-AA
Index
TypeToleranceHigh, 2459 VariableStateValues, 2549
TypeToleranceLow, 2460 VariableTriggers, 2550
TypeWarningHigh, 2461 VarName, 2551
TypeWarningLow, 2462 VBAVersion, 2552
Underlined, 2463 VBE, 2552
UnselBGColor, 2464 Version, 2552
UnselTextColor, 2465 Views, 2553
UpdateCycle, 2466 Visible, 2553
UserValue1, 2469 WarningHigh, 2554
UserValue2, 2470 WarningLow, 2555
UserValue3, 2470 Width, 2556, 2557
UserValue4, 2471 WindowBorder, 2558
Value, 2472 WindowMonitorNumber, 2559
VALUE_ACCESS_FAULT, 2473 WindowPositionMode, 2559
VALUE_ADDRESS_ERROR, 2475 WindowsStyle, 2559
VALUE_BAD_COMMLUV, 2477, 2479 WindowState, 2560
VALUE_BAD_CONFERROR, 2481 ZeroPoint, 2561
VALUE_BAD_DEVICE, 2483 ZeroPointValue, 2561
VALUE_BAD_MISCSTATES, 2485 Zoom, 2562
VALUE_BAD_NONSPECIFIC, 2487 Properties in VBA
VALUE_BAD_NOTCONNECTED, 2489 CommonVBSEventArea, 2202
VALUE_BAD_OUTOFSERV, 2491 CommonVBSPropertyArea, 2202
VALUE_BAD_PROCRELNOM, 2493 FaceplateType, 2235
VALUE_BAD_PROCRELSUB, 2495 TagScaleParam1, 2438
VALUE_CONVERSION_ERROR, 2497 TagScaleParam2, 2438
VALUE_HANDSHAKE_ERROR, 2499 TagScaleParam3, 2438
VALUE_HARDWARE_ERROR, 2501 TagScaleParam4, 2439
VALUE_HIGHLIMITED, 2503 Properties in VBS, 297
VALUE_INVALID_KEY, 2505 AlarmID, 303
VALUE_LOWLIMITED, 2507 BackStyle, 321
VALUE_MAX_LIMIT, 2509 Comment, 377
VALUE_MAX_RANGE, 2511 ComputerName, 379
VALUE_MIN_LIMIT, 2513 Context, 379
VALUE_MIN_RANGE, 2515 FillStyle, 420
VALUE_NOT_ESTABLISHED, 2517 FillStyleAlignment, 421
VALUE_SERVERDOWN, 2519 GlobalColorScheme, 438
VALUE_STARTUP_VALUE, 2521 HiddenInput, 306, 307, 445, 484, 516, 544, 577,
VALUE_TIMEOUT, 2523 679, 704
VALUE_UNCERT_ENGVHIGHLIM, 2525 IndependentWindow, 452
VALUE_UNCERT_ENGVLOWLIM, 2527 Index, 452
VALUE_UNCERT_ENGVONLIM, 2529 InputValue, 454
VALUE_UNCERT_INITVAL, 2531 Instance, 455
VALUE_UNCERT_LUV, 2533 ItemProviderClsid, 456
VALUE_UNCERT_MAINTDEM, 2535 LineJoinStyle, 481
VALUE_UNCERT_MISCSTATES, 2537 NumberLines, 511
VALUE_UNCERT_NONSPECIFIC, 2539 ProcessValue, 546
VALUE_UNCERT_PROCRELNOM, 2541 RotationAngle, 553
VALUE_UNCERT_SIMVAL, 2543 SavedTrend, 558
VALUE_UNCERT_SUBSTSET, 2545 Selected Trend, 566
VariablesExist, 2547 SelIndex, 569
VariableStateChecked, 2548 SelText, 569
VariableStateType, 2549 Smart tag, 581
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2667
Index
SortOrder, 581 Properties in VBS:BackColor, 318
State, 587 Properties in VBS:BackColor2, 319
TableFocusOnButtonCommand, 595 Properties in VBS:BackColor3, 319
Transparency, 646 Properties in VBS:BackColorBottom, 319
UserName, 679 Properties in VBS:BackColorTop, 320
WinCCStyle, 702 Properties in VBS:BackFlashColorOff, 320
WindowPositionMode, 702 Properties in VBS:BackFlashColorOn, 320
WindowsStyle, 703 Properties in VBS:Background, 320
Properties in VBS/ScrollPositionX, 562 Properties in VBS:Background Picture, 321
Properties in VBS/ScrollPositionY, 563 Properties in VBS:BackPictureAlignment, 321, 537
Properties in VBS: Properties in VBS:BackPictureName, 321
DesiredCurveSourceUAColumnY, 403 Properties in VBS:BarBackColor, 323
Properties in VBS:AccessPath, 297 Properties in VBS:BarDepth, 324
Properties in VBS:Activate, 298 Properties in VBS:BarFillColor, 325
Properties in VBS:ActiveProject, 299 Properties in VBS:BarHeight, 325
Properties in VBS:ActiveScreen, 299 Properties in VBS:BarWidth, 336
Properties in VBS:ActiveScreenItem, 300 Properties in VBS:BasePicReferenced, 337
Properties in VBS:Actualize, 301 Properties in VBS:BasePicTransColor, 337
Properties in VBS:ActualPointLeft, 301 Properties in VBS:BasePicture, 338
Properties in VBS:ActualPointTop, 301 Properties in VBS:BasePicUseTransColor, 338
Properties in VBS:AdaptBorder, 302 Properties in VBS:BaseScreenName, 338
Properties in VBS:AdaptPicture, 302 Properties in VBS:BaseX, 339
Properties in VBS:AdaptSize, 303 Properties in VBS:BaseY, 339
Properties in VBS:AdjustRuler, 303 Properties in VBS:BeginTime, 340
Properties in VBS:AlarmHigh, 304 Properties in VBS:BeginValue, 340
Properties in VBS:AlarmLogs, 304 Properties in VBS:BeginWidth, 343
Properties in VBS:AlarmLow, 304 Properties in VBS:BeginX, 340
Properties in VBS:Alignment, 305 Properties in VBS:BeginY, 341
Properties in VBS:AlignmentLeft, 305 Properties in VBS:BevelColorDown, 341
Properties in VBS:AlignmentTop, 305 Properties in VBS:BevelColorUp, 341
Properties in VBS:AllowPersistence, 306 Properties in VBS:Bevellnner, 342
Properties in VBS:AllServer, 306 Properties in VBS:BevelOuter, 342
Properties in VBS:Analog, 307 Properties in VBS:BitNumber, 343
Properties in VBS:AngleAlpha, 307 Properties in VBS:BlinkColor, 343
Properties in VBS:AngleBeta, 308 Properties in VBS:BorderBackColor, 350
Properties in VBS:AngleMax, 308 Properties in VBS:BorderColor, 351
Properties in VBS:AngleMin, 308 Properties in VBS:BorderColorBottom, 351
Properties in VBS:Application, 309 Properties in VBS:BorderColorTop, 351
Properties in VBS:Archive, 310 Properties in VBS:BorderEndStyle, 352
Properties in VBS:Assignments, 311 Properties in VBS:BorderFlashColorOff, 352
Properties in VBS:AssumeOnExit, 311 Properties in VBS:BorderFlashColorOn, 352
Properties in VBS:AssumeOnFull, 311 Properties in VBS:BorderStyle, 352
Properties in VBS:AutoRange, 313 Properties in VBS:BorderWidth, 353
Properties in VBS:AutoRangeX, 313 Properties in
Properties in VBS:AutoRangeY, 313 VBS:BottomConnectedConnectionPointIndex, 353
Properties in VBS:AutoScroll, 314 Properties in
Properties in VBS:AutoSize, 316 VBS:BottomConnectedObjectName, 354
Properties in VBS:Average, 316 Properties in VBS:BoxAlignment, 354
Properties in VBS:Axe, 316 Properties in VBS:BoxCount, 354
Properties in VBS:Axis, 604 Properties in VBS:BoxType, 355
Properties in VBS:AxisSection, 317 Properties in VBS:Button1Width, 359
Properties in VBS:BackBorderWidth, 317 Properties in VBS:Button2Width, 359
WinCC: Scripting (VBS, ANSI-C, VBA)
2668 System Manual, 09/2018, A5E45518271-AA
Index
Properties in VBS:Button3Width, 359 Properties in VBS:CommonX, 378
Properties in VBS:Button4Width, 360 Properties in VBS:CommonY, 379
Properties in VBS:ButtonColor, 355 Properties in VBS:ContinuousChange, 381
Properties in VBS:ButtonCommand, 355 Properties in VBS:Count, 381
Properties in VBS:Caption, 360 Properties in VBS:CurrentContext, 393
Properties in VBS:CaptionColor, 361 Properties in VBS:Cursor, 394
Properties in VBS:CaptionFont, 361 Properties in VBS:CursorControl, 394
Properties in VBS:CaptionOffset, 361 Properties in VBS:CurveForm, 395
Properties in VBS:CaptionText, 362 Properties in VBS:Danger, 396
Properties in VBS:CellCut, 362 Properties in VBS:DangerColor, 396, 399
Properties in VBS:CenterColor, 364 Properties in VBS:DataFormat, 396
Properties in VBS:CenterScale, 364 Properties in VBS:DataIndex, 397
Properties in VBS:CheckAlarmHigh, 364 Properties in VBS:DataLogs, 397
Properties in VBS:CheckAlarmLow, 365 Properties in VBS:DataSet, 397
Properties in VBS:CheckLimitHigh4, 365 Properties in VBS:DataX, 398
Properties in VBS:CheckLimitHigh5, 365 Properties in VBS:DataXY, 398
Properties in VBS:CheckLimitLow4, 366 Properties in VBS:DataY, 399
Properties in VBS:CheckLimitLow5, 366 Properties in VBS:DeleteData, 401
Properties in VBS:CheckToleranceHigh, 366 Properties in VBS:Delta, 401
Properties in VBS:CheckToleranceLow, 367 Properties in VBS:DesiredCurveColor, 401
Properties in VBS:CheckWarningHigh, 367 Properties in VBS:DesiredCurveCurveForm, 402
Properties in VBS:CheckWarningLow, 367 Properties in
Properties in VBS:ClearOnError, 368 VBS:DesiredCurveSourceNumberOfUAValues, 402
Properties in VBS:ClearOnNew, 368 Properties in
Properties in VBS:Closeable, 368 VBS:DesiredCurveSourceUAArchive, 402
Properties in VBS:CloseButton, 369 Properties in
Properties in VBS:CoarseGrid, 369 VBS:DesiredCurveSourceUAArchiveStartID, 403
Properties in VBS:CoarseGridValue, 370 Properties in
Properties in VBS:CoarseGridValueX, 371 VBS:DesiredCurveSourceUAColumnX, 403
Properties in VBS:CoarseGridValueY, 371 Properties in VBS:DesiredCurveVisible, 404
Properties in VBS:CoarseGridX, 370 Properties in VBS:Direction, 404
Properties in VBS:CoarseGridY, 370 Properties in VBS:DisplayOptions, 405
Properties in VBS:CollectValue, 371 Properties in VBS:Edit, 406
Properties in VBS:ColMove, 372 Properties in VBS:Editable, 406
Properties in VBS:Color, 372 Properties in VBS:EditAtOnce, 406
Properties in VBS:ColorAlarmHigh, 372 Properties in VBS:Enabled, 407
Properties in VBS:ColorAlarmLow, 373 Properties in VBS:EndAngle, 410
Properties in VBS:ColorBottom, 373 Properties in VBS:EndTime, 410
Properties in VBS:ColorChangeType, 373 Properties in VBS:EndValue, 411
Properties in VBS:ColorLimitHigh4, 374 Properties in VBS:EndX, 411
Properties in VBS:ColorLimitHigh5, 374 Properties in VBS:EndY, 411
Properties in VBS:ColorLimitLow4, 374 Properties in VBS:ErrorDescription, 411
Properties in VBS:ColorLimitLow5, 375 Properties in VBS:Exponent, 413
Properties in VBS:ColorToleranceHigh, 375 Properties in VBS:ExtendedOperation, 415
Properties in VBS:ColorToleranceLow, 375 Properties in VBS:ExtendedZoomingEnable, 416
Properties in VBS:ColorTop, 375 Properties in VBS:FillColor, 418
Properties in VBS:ColorWarningHigh, 376 Properties in VBS:Filling, 419
Properties in VBS:ColorWarningLow, 376 Properties in VBS:FillingIndex, 419
Properties in VBS:ColTitle, 376 Properties in VBS:FillStyle2, 421
Properties in VBS:ColWidth, 377 Properties in VBS:FineGrid, 422
Properties in VBS:Command, 377 Properties in VBS:FineGridValue, 422
Properties in VBS:CommonTime, 378 Properties in VBS:FineGridValueX, 422
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2669
Index
Properties in VBS:FineGridValueY, 423 Properties in VBS:Hotkey, 450
Properties in VBS:FineGridX, 423 Properties in VBS:HourNeedleHeight, 450
Properties in VBS:FineGridY, 423 Properties in VBS:HourNeedleWidth, 451
Properties in VBS:FlashBackColor, 423 Properties in VBS:Hysteresis, 451
Properties in VBS:FlashBorderColor, 424 Properties in VBS:HysteresisRange, 451
Properties in VBS:FlashFlashPicture, 424 Properties in VBS:InnerBevelOffset, 453
Properties in VBS:FlashForeColor, 424 Properties in VBS:InnerBevelStyle, 453
Properties in VBS:FlashPicReferenced, 425 Properties in VBS:InnerBevelWidth, 454
Properties in VBS:FlashPicTransColor, 425 Properties in VBS:InsertData, 454
Properties in VBS:FlashPicture, 425 Properties in VBS:ItemBorderBackColor, 455
Properties in VBS:FlashPicUseTransColor, 426 Properties in VBS:ItemBorderColor, 455
Properties in VBS:FlashRate, 426 Properties in VBS:ItemBorderStyle, 456
Properties in VBS:FlashRateBackColor, 427 Properties in VBS:ItemBorderWidth, 456
Properties in VBS:FlashRateBorderColor, 427 Properties in VBS:ItemVisible, 457
Properties in VBS:FlashRateFlashPic, 428 Properties in VBS:Label, 457
Properties in VBS:FlashRateForeColor, 428 Properties in VBS:LabelColor, 458
Properties in VBS:Flip, 429 Properties in VBS:LabelX, 458
Properties in VBS:FocusColor, 430 Properties in VBS:LabelY, 458
Properties in VBS:FocusRect, 430 Properties in VBS:Language-IDs, 459
Properties in VBS:FocusWidth, 430 Properties in VBS:LanguageSwitch, 458
Properties in VBS:Font, 431 Properties in VBS:LastError, 459
Properties in VBS:FontBold, 432 Properties in VBS:Layer, 461
Properties in VBS:FontItalic, 432 Properties in VBS:Layer00Checked, 462
Properties in VBS:FontName, 433 Properties in VBS:Layer00Color, 465
Properties in VBS:FontPosition, 433 Properties in VBS:Layer00Value, 473
Properties in VBS:FontSize, 433 Properties in VBS:Layer01Checked, 462
Properties in VBS:FontStrikeThru, 434 Properties in VBS:Layer01Color, 466
Properties in VBS:FontUnderline, 434 Properties in VBS:Layer01Value, 473
Properties in VBS:ForeColor, 435 Properties in VBS:Layer02Checked, 462
Properties in VBS:ForeFlashColorOff, 435 Properties in VBS:Layer02Color, 466
Properties in VBS:ForeFlashColorOn, 436 Properties in VBS:Layer02Value, 474
Properties in VBS:FrameColor, 436 Properties in VBS:Layer03Checked, 463
Properties in VBS:FrameColorDown, 436 Properties in VBS:Layer03Color, 466
Properties in VBS:FrameColorUp, 437 Properties in VBS:Layer03Value, 474
Properties in VBS:FramePicture, 437 Properties in VBS:Layer04Checked, 463
Properties in VBS:FrameScale, 437 Properties in VBS:Layer04Color, 467
Properties in VBS:FrameWidth, 438 Properties in VBS:Layer04Value, 474
Properties in VBS:FreezeProviderConnections, 438 Properties in VBS:Layer05Checked, 463
Properties in VBS:GraphDirection, 439 Properties in VBS:Layer05Color, 467
Properties in VBS:GridLineHorz, 440 Properties in VBS:Layer05Value, 474
Properties in VBS:Gridlines, 439, 440 Properties in VBS:Layer06Checked, 464
Properties in VBS:GridLinesValueX, 441 Properties in VBS:Layer06Color, 467
Properties in VBS:GridLinesValueY, 441 Properties in VBS:Layer06Value, 475
Properties in VBS:GridlinesX, 441 Properties in VBS:Layer07Checked, 464
Properties in VBS:GridLinesY, 441 Properties in VBS:Layer07Color, 468
Properties in VBS:GridLineValue, 442 Properties in VBS:Layer07Value, 475
Properties in VBS:GridLineVert, 442 Properties in VBS:Layer08Checked, 464
Properties in VBS:HandFillColor, 443 Properties in VBS:Layer08Color, 468
Properties in VBS:Handtype, 443 Properties in VBS:Layer08Value, 475
Properties in VBS:HeaderSort, 444 Properties in VBS:Layer09Checked, 465
Properties in VBS:Height, 444 Properties in VBS:Layer09Color, 468
Properties in VBS:HiddenInput, 445 Properties in VBS:Layer09Value, 476
WinCC: Scripting (VBS, ANSI-C, VBA)
2670 System Manual, 09/2018, A5E45518271-AA
Index
Properties in VBS:Layer10Checked, 465 Properties in VBS:MCKQTextColorOn, 494
Properties in VBS:Layer10Color, 469 Properties in VBS:MCKQTextFlash, 495
Properties in VBS:Layer10Value, 476 Properties in VBS:MCText, 495
Properties in VBS:LayerDeclutteringEnable, 476 Properties in VBS:MeasurePoints, 495
Properties in VBS:Layers, 477 Properties in VBS:MessageClass, 504
Properties in VBS:Left, 477 Properties in VBS:Min, 507
Properties in VBS:LeftComma, 478 Properties in VBS:MinuteNeedleHeight, 508
Properties in VBS:LightEffect, 478 Properties in VBS:MinuteNeedleWidth, 508
Properties in VBS:LimitHigh4, 478 Properties in VBS:Movable, 508
Properties in VBS:LimitHigh5, 479 Properties in VBS:MsgCtrlFlags, 509
Properties in VBS:LimitLow4, 479 Properties in VBS:MsgFilterSQL, 509
Properties in VBS:LimitLow5, 479 Properties in VBS:Name, 510
Properties in VBS:LimitMax, 480 Properties in VBS:NeedleColor, 511
Properties in VBS:LimitMin, 480 Properties in VBS:NormalColor, 511
Properties in VBS:LineFont, 480 Properties in VBS:NumItems, 512
Properties in VBS:LineHeight, 481 Properties in VBS:Object, 512
Properties in VBS:LineTitle, 481 Properties in VBS:ObjectName, 513
Properties in VBS:LineWidth, 482 Properties in
Properties in VBS:ListType, 482 VBS:ObjectSizeDeclutteringEnable, 514
Properties in VBS:LoadDataImmediately, 483 Properties in VBS:ObjectSizeDeclutteringMax, 514
Properties in VBS:LocaleID, 483 Properties in VBS:ObjectSizeDeclutteringMin, 515
Properties in VBS:LockBackColor, 484 Properties in VBS:OffsetLeft, 516
Properties in VBS:LockStatus, 484 Properties in VBS:OffsetTop, 516
Properties in VBS:LockText, 485 Properties in VBS:Online, 517
Properties in VBS:LockTextColor, 485 Properties in VBS:OnTop, 517
Properties in VBS:Logging, 485 Properties in VBS:OperationMessage, 518
Properties in VBS:LongStrokesBold, 485 Properties in VBS:OperationReport, 526
Properties in VBS:LongStrokesOnly, 486 Properties in VBS:Orientation, 527
Properties in VBS:LongStrokesSize, 486 Properties in VBS:OuterBevelStyle, 527
Properties in VBS:LongStrokesTextEach, 486 Properties in VBS:OuterBevelWidth, 528
Properties in VBS:LowerLimit, 487 Properties in VBS:Outline, 528
Properties in VBS:LowerLimitColor, 488 Properties in VBS:OutputFormat, 528
Properties in VBS:LowerLimitValue, 488 Properties in VBS:OutputValue, 528
Properties in VBS:Marker, 489 Properties in VBS:Parent, 529
Properties in VBS:Max, 489 Properties in VBS:PasswordLevel, 531
Properties in VBS:MaximizeButton, 489 Properties in VBS:Path, 531
Properties in VBS:MCGUBackColorOff, 490 Properties in VBS:PersistentRT, 533
Properties in VBS:MCGUBackColorOn, 490 Properties in VBS:PersistentRTCS, 533
Properties in VBS:MCGUBackFlash, 490 Properties in VBS:PersistentRTCSPermission, 534
Properties in VBS:MCGUTextColorOff, 491 Properties in VBS:PersistentRTPermission, 534
Properties in VBS:MCGUTextColorOn, 491 Properties in VBS:PicDeactReferenced, 535
Properties in VBS:MCGUTextFlash, 491 Properties in VBS:PicDeactTransparent, 535
Properties in VBS:MCKOBackColorOff, 491 Properties in VBS:PicDeactUseTransColor, 535
Properties in VBS:MCKOBackColorOn, 492 Properties in VBS:PicDownReferenced, 536
Properties in VBS:MCKOBackFlash, 492 Properties in VBS:PicDownTransparent, 536
Properties in VBS:MCKOTextColorOff, 492 Properties in VBS:PicDownUseTransColor, 536
Properties in VBS:MCKOTextColorOn, 493 Properties in VBS:PicReferenced, 536
Properties in VBS:MCKOTextFlash, 493 Properties in VBS:PicTransColor, 537
Properties in VBS:MCKQBackColorOff, 493 Properties in VBS:Picture, 537
Properties in VBS:MCKQBackColorOn, 493 Properties in VBS:PictureBack, 537
Properties in VBS:MCKQBackFlash, 494 Properties in VBS:PictureDeactivated, 538
Properties in VBS:MCKQTextColorOff, 494 Properties in VBS:PictureDown, 538
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2671
Index
Properties in VBS:PictureName, 539 Properties in VBS:SecondNeedleHeight, 563
Properties in VBS:PictureSelected, 539 Properties in VBS:SecondNeedleWidth, 564
Properties in VBS:PictureThumb, 539 Properties in VBS:SelBGColor, 564
Properties in VBS:PictureUnselected, 540 Properties in VBS:SelectionMode, 566
Properties in VBS:PictureUp, 540 Properties in VBS:SelectionRectColor, 567
Properties in VBS:PicUpReferenced, 540 Properties in VBS:SelectionRectWidth, 567
Properties in VBS:PicUpTransparent, 541 Properties in VBS:SelectionType, 568
Properties in VBS:PicUpUseTransColor, 541 Properties in VBS:SelTextColor, 569
Properties in VBS:PicUseTransColor, 541 Properties in VBS:ServerData, 569
Properties in VBS:PointCount, 542 Properties in VBS:ServerNames, 571
Properties in VBS:Position, 542 Properties in VBS:ServerPrefix, 572
Properties in VBS:Precisions, 543 Properties in VBS:ShowBar, 572
Properties in VBS:PrecisionX, 543 Properties in VBS:ShowDanger, 573
Properties in VBS:PrecisionY, 543 Properties in VBS:ShowDecimalPoint, 573
Properties in VBS:PredefinedAngles, 544 Properties in VBS:ShowNormal, 574
Properties in VBS:Pressed, 544 Properties in VBS:ShowPeak, 574
Properties in VBS:PrintJob, 545 Properties in VBS:ShowPosition, 574
Properties in VBS:Process, 545 Properties in VBS:ShowRulerImmediately, 575
Properties in VBS:ProjectPath, 546 Properties in VBS:ShowThumb, 577
Properties in VBS:ProviderClsID, 546 Properties in VBS:ShowValuesExponentialX, 578
Properties in VBS:ProviderType, 546 Properties in VBS:ShowValuesExponentialY, 579
Properties in VBS:QualityCode, 547 Properties in VBS:ShowWarning, 579
Properties in VBS:Radius, 548 Properties in VBS:SignificantMask, 579
Properties in VBS:RadiusHeigth, 548 Properties in VBS:SmallChange, 580
Properties in VBS:RadiusWidth, 548 Properties in VBS:SourceBeginTime, 581
Properties in VBS:RangeMax, 549 Properties in VBS:SourceEndTime, 582
Properties in VBS:RangeMin, 549 Properties in VBS:SourceNumberOfUAValues, 583
Properties in VBS:Rectangular, 549 Properties in VBS:SourceNumberOfValues, 583
Properties in VBS:ReferenceRotationLeft, 550 Properties in VBS:SourceTagNameX, 583
Properties in VBS:ReferenceRotationTop, 550 Properties in VBS:SourceTagNameY, 584
Properties in VBS:RelayCurves, 550 Properties in VBS:SourceTagProviderDataX, 584
Properties in VBS:Relevant, 551 Properties in VBS:SourceTagProviderDataY, 584
Properties in VBS:Replacement, 551 Properties in VBS:SourceTimeRange, 585
Properties in VBS:ReplacementColor, 551 Properties in VBS:SourceUAArchive, 585
Properties in VBS:RightComma, 552 Properties in VBS:SourceUAArchiveStartID, 585
Properties in VBS:RoundCornerHeight, 553 Properties in VBS:SourceUAColumnX, 586
Properties in VBS:RoundCornerWidth, 554 Properties in VBS:SourceUAColumnY, 586
Properties in VBS:RulerPrecisions, 556 Properties in VBS:SquareExtent, 587
Properties in VBS:RulerPrecisionX, 556 Properties in VBS:StartAngle, 587
Properties in VBS:RulerPrecisionY, 557 Properties in VBS:Statusbar, 588
Properties in VBS:SameSize, 558 Properties in VBS:StatusbarPanes, 592
Properties in VBS:ScaleColor, 558 Properties in VBS:StatusbarStretch, 594
Properties in VBS:ScaleTicks, 558 Properties in VBS:Tag, 698
Properties in VBS:Scaling, 559 Properties in VBS:TagName, 596
Properties in VBS:ScalingType, 559 Properties in VBS:TagPrefix, 596
Properties in VBS:ScalingTypeX, 560 Properties in VBS:TagProviderClsid, 598
Properties in VBS:ScalingTypeY, 560 Properties in VBS:Tags, 597
Properties in VBS:Screen, 561 Properties in VBS:Template, 598
Properties in VBS:ScreenItems, 561 Properties in VBS:Text, 599
Properties in VBS:ScreenName, 561 Properties in VBS:ThumbBackColor, 600
Properties in VBS:Screens, 305 Properties in VBS:TicColor, 601
Properties in VBS:ScrollBars, 562 Properties in VBS:TicFont, 601
WinCC: Scripting (VBS, ANSI-C, VBA)
2672 System Manual, 09/2018, A5E45518271-AA
Index
Properties in VBS:Ticks, 603 Properties in VBS:UnselBGColor, 675
Properties in VBS:TicksColor, 603 Properties in VBS:UnselTextColor, 675
Properties in VBS:TickStyle, 603 Properties in VBS:UpdateCycle, 675
Properties in VBS:TicOffset, 601 Properties in VBS:UpperLimit, 676
Properties in VBS:TicTextColor, 602 Properties in VBS:UpperLimitColor, 676
Properties in VBS:TicTextOffset, 602 Properties in VBS:UpperLimitValue, 677
Properties in VBS:TicWidth, 602 Properties in VBS:UserValue1, 680
Properties in VBS:TimeAxisFormat, 606 Properties in VBS:UserValue2, 680
Properties in VBS:TimeAxisX, 611 Properties in VBS:UserValue3, 680
Properties in VBS:TimeColumnAlignment, 613 Properties in VBS:UserValue4, 681
Properties in VBS:TimeFormat, 621 Properties in VBS:Value, 683
Properties in VBS:TimeJump, 621 Properties in VBS:ValueColumnAlignment, 691
Properties in VBS:TimeJumpColor, 622 Properties in VBS:ValueMax, 698
Properties in VBS:TimeOverlap, 622 Properties in VBS:ValueMin, 698
Properties in VBS:TimeOverlapColor, 622 Properties in VBS:Visible, 699
Properties in VBS:TimeRange, 623 Properties in VBS:Warning, 700
Properties in VBS:TimeRangeBase, 623 Properties in VBS:WarningColor, 700
Properties in VBS:TimeRangeFactor, 624 Properties in VBS:WarningHigh, 700
Properties in VBS:TimeStamp, 624 Properties in VBS:WarningLow, 701
Properties in VBS:TimeZone, 626 Properties in VBS:Width, 701
Properties in VBS:TitleCut, 627 Properties in VBS:WindowBorder, 702
Properties in VBS:Titleline, 628 Properties in VBS:WindowsStyle, 703
Properties in VBS:Toggle, 629 Properties in VBS:WindowType, 703
Properties in VBS:ToleranceHigh, 630 Properties in VBS:WithAxes, 704
Properties in VBS:ToleranceLow, 630 Properties in VBS:WithLabels, 704
Properties in VBS:Toolbar, 630 Properties in VBS:ZeroPoint, 711
Properties in VBS:ToolbarAlignment, 631 Properties in VBS:ZeroPointValue, 712
Properties in VBS:ToolbarButtons, 640 Properties in VBS:Zoom, 712
Properties in VBS:ToolbarHotKeys, 641 Properties: FillingDirection, 2241
Properties in VBS:ToolTipText, 643 Property, 2467
Properties in VBS:Top, 644 Protect VBA Code, 1619
Properties in Push Button Control, 291
VBS:TopConnectedConnectionPointIndex, 645 putc, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Properties in VBS:TopConnectedObjectName, 645 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Properties in VBS:Transparent, 646 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Properties in VBS:Trend, 646 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Properties in VBS:TrendColor, 649 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Properties in VBS:Type, 669 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Properties in VBS:TypeAlarmHigh, 670 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Properties in VBS:TypeAlarmLow, 671 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Properties in VBS:TypeLimitHigh4, 671 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Properties in VBS:TypeLimitHigh5, 671 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Properties in VBS:TypeLimitLow4, 672 1091, 1092, 1093, 1094, 1095, 1096
Properties in VBS:TypeLimitLow5, 672
Properties in VBS:TypeToleranceHigh, 672
Properties in VBS:TypeToleranceLow, 672
Properties in VBS:TypeWarningHigh, 673
Properties in VBS:TypeWarningLow, 673
Properties in VBS:UnitColor, 673
Properties in VBS:UnitFont, 674
Properties in VBS:UnitOffset, 674
Properties in VBS:UnitText, 674
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2673
Index
Registry2, 947
remove, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Q 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
qsort, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1091, 1092, 1093, 1094, 1095, 1096
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
rename, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1091, 1092, 1093, 1094, 1095, 1096
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
QuitHorn, 784
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
QuitSelected, 785
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
QuitVisible, 785
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
R 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
rand, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1091, 1092, 1093, 1094, 1095, 1096
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, Rename:Module, 51
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, Renaming, 51, 75
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, Renaming:Action, 75
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, Renaming:Procedure, 51
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, ReportJob, 969
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, rewind, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1091, 1092, 1093, 1094, 1095, 1096 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
ReadTags, 789 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
realloc, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1091, 1092, 1093, 1094, 1095, 1096
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, RPTJobPreview, 1001
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, RPTJobPrint, 1001
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, RptShowError, 1002
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, RulerBlock object, 224
1091, 1092, 1093, 1094, 1095, 1096 RulerColumn object, 225
Reference, 1752 RulerControl, 266
Event Handling, 1752 Runtime, 77
Methods, 1752 Activating Global Actions, 77
Object model, 1752
Objects and Lists, 1752
Properties, 1752
VBA Object Model, 1752
References, 1619
WinCC: Scripting (VBS, ANSI-C, VBA)
2674 System Manual, 09/2018, A5E45518271-AA
Index
ScreenItem:Static Text, 163
ScreenItem:Status Display, 197
S ScreenItem:Text list, 194
ScreenItem:T-piece, 214
Save, 64
ScreenItem:Tube Arc, 215
Module, 49
ScreenItem:WinCC Digital Analog Clock, 244
procedure, 49
ScreenItem:WinCC Function Trend Control, 281
Save As...
ScreenItem:WinCC FunctionTrendControl, 246
Applying, 888
ScreenItem:WinCC Gauge Control, 251
Save:Action, 64
ScreenItem:WinCC Online Table Control, 285
Saving file as, 923
ScreenItem:WinCC OnlineTableControl, 254
Screen Object, 129
ScreenItem:WinCC Push Button Control, 291
ScreenItem, 254, 260, 266, 274, 288
ScreenItem:WinCC Slider Control, 270
Control, 179
ScreenItems object (list), 127
Controls, 216
Screens Object (List), 132
Customized object, 294
Script file, 90
Faceplate instance, 184
Script File:Action Names, 92
WinCC Alarm Control, 279
Script file:open in Debugger, 94
WinCC AlarmControl, 238
Script File:Permissible action name length, 92
ScreenItem Object, 123
Script File:Set bookmark, 98
ScreenItem:3D bar, 167
Script files of VBScripts, 90
ScreenItem:Application window, 171
SelectedStatisticArea, 801
ScreenItem:Bar, 172
ServerExport, 801
ScreenItem:Button, 199
ServerImport, 801
ScreenItem:Check Box, 202
Set_Focus, 1288
ScreenItem:Circle, 147
SetActualPointLeft, 1296
ScreenItem:Circle segment, 150
SetActualPointTop, 1297
ScreenItem:Circular arc, 149
SetAlarmHigh, 1320
ScreenItem:Combobox, 187
SetAlarmLow, 1321
ScreenItem:Connector, 165
SetAlignment, 1248
ScreenItem:Double T-piece, 214
SetAlignmentLeft, 1289
ScreenItem:Ellipse, 142
SetAlignmentTop, 1290
ScreenItem:Ellipse arc, 144
SetAssumeOnExit, 1313
ScreenItem:Ellipse segment, 145
SetAssumeOnFull, 1313
ScreenItem:Graphic Object, 185
SetAverage, 1356
ScreenItem:Group, 296
SetAxisSection, 1249
ScreenItem:Group Display, 192
SetBackBorderWidth, 1397
ScreenItem:HMI Symbol Library, 237
SetBackColor, 1258
ScreenItem:I/O Field, 182
SetBackColor2, 1259
ScreenItem:Line, 152
SetBackColor3, 1259
ScreenItem:ListBox, 187
SetBackColorBottom, 1260
ScreenItem:Multiline Text, 188
SetBackColorTop, 1261
ScreenItem:Object types, 141
SetBackFlashColorOff, 1278
ScreenItem:OLE Element, 189
SetBackFlashColorOn, 1279
ScreenItem:Picture window, 177
SetBasePicTransColor, 1391
ScreenItem:Polygon, 154
SetBasePicUseTransColor, 1392
ScreenItem:Polygon Tube, 213
SetBitNumber, 1314
ScreenItem:Polyline, 156
SetBorderBackColor, 1262
ScreenItem:Radio Box, 205
SetBorderColor, 1263
ScreenItem:Rectangle, 157
SetBorderColorBottom, 1263
ScreenItem:Roundbutton, 207
SetBorderColorTop, 1264
ScreenItem:Rounded Rectangle, 160
SetBorderEndStyle, 1398
ScreenItem:Slider, 210
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2675
Index
SetBorderFlashColorOff, 1280 SetFilling, 1276
SetBorderFlashColorOn, 1280 SetFillingIndex, 1277
SetBorderStyle, 1399 SetFillStyle, 1401
SetBorderWidth, 1399 SetFillStyle2, 1402
SetBoxAlignment, 1400 SetFlashBackColor, 1281
SetBoxCount, 1298 SetFlashBorderColor, 1282
SetBoxType, 1356 SetFlashFlashPicture, 1393
setbuf, 1012, 1013, 1014, 1015, 1016, 1017, 1018, SetFlashForeColor, 1283
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, SetFlashPicTransColor, 1393
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, SetFlashPicUseTransColor, 1394
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, SetFlashRateBackColor, 1283
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, SetFlashRateBorderColor, 1284
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, SetFlashRateFlashPic, 1395
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, SetFlashRateForeColor, 1285
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, SetFontBold, 1291
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, SetFontItalic, 1291
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, SetFontName, 1292
1091, 1092, 1093, 1094, 1095, 1096 SetFontSize, 1293
SetButtonColor, 1265 SetFontUnderline, 1294
SetCheckAlarmHigh, 1322 SetForeColor, 1268
SetCheckAlarmLow, 1322 SetForeFlashColorOff, 1286
SetCheckLimitHigh4, 1323 SetForeFlashColorOn, 1287
SetCheckLimitHigh5, 1324 SetHeight, 1300
SetCheckLimitLow4, 1325 SetHiddenInput, 1316
SetCheckLimitLow5, 1325 SetHysteresis, 1361
SetCheckToleranceHigh, 1326 SetHysteresisRange, 1362
SetCheckToleranceLow, 1327 SetIndex, 1396
SetCheckWarningHigh, 1328 SetItemBorderBackColor, 1269
SetCheckWarningLow, 1328 SetItemBorderColor, 1270
SetClearOnError, 1315 SetItemBorderStyle, 1403
SetClearOnNew, 1316 SetItemBorderWidth, 1403
SetColorAlarmHigh, 1329 SetLanguage, 1516
SetColorAlarmLow, 1330 SetLanguageByID, 1516
SetColorBottom, 1266 SetLanguageByName, 1517
SetColorChangeType, 1357 SetLeft, 1301
SetColorLimitHigh4, 1331 SetLeftComma, 1251
SetColorLimitHigh5, 1332 SetLimitHigh4, 1337
SetColorLimitLow4, 1332 SetLimitHigh5, 1338
SetColorLimitLow5, 1333 SetLimitLow4, 1339
SetColorToleranceHigh, 1334 SetLimitLow5, 1339
SetColorToleranceLow, 1335 SetLimitMax, 1340
SetColorTop, 1267 SetLimitMin, 1341
SetColorWarningHigh, 1336 SetLink, 1354
SetColorWarningLow, 1336 SetLongStrokesBold, 1252
SetCursorControl, 1358 SetLongStrokesOnly, 1253
SetCursorMode, 1359 SetLongStrokesSize, 1253
SetDirection, 1299 SetMarker, 1342
SetEditAtOnce, 1360 SetMax, 1363
SetEndAngle, 1300 SetMin, 1363
SetExponent, 1250 SetNumberLines, 1317
SetExtendedOperation, 1360 SetOffsetLeft, 1364
SetFillColor, 1267 SetOffsetTop, 1365
WinCC: Scripting (VBS, ANSI-C, VBA)
2676 System Manual, 09/2018, A5E45518271-AA
Index
SetOperation, 1365 SetTagByteState, 1483
SetOperationMessage, 1366 SetTagByteStateWait, 1471
SetOperationReport, 1367 SetTagByteWait, 1492
SetOrientation, 1294 SetTagChar, 1504
SetOutputValueChar, 1318 SetTagCharState, 1483
SetOutputValueDouble, 1319 SetTagCharStateWait, 1472
SetPasswordLevel, 1368 SetTagCharWait, 1493
SetPicDeactTransparent, 1378 SetTagDateTime, 1504
SetPicDeactUseTransColor, 1379 SetTagDouble, 1505
SetPicDownTransparent, 1380 SetTagDoubleState, 1484
SetPicDownUseTransColor, 1381 SetTagDoubleStateWait, 1473
SetPicTransColor, 1381 SetTagDoubleWait, 1494
SetPictureDeactivated, 1382 SetTagDWord, 1506
SetPictureDown, 1383 SetTagDWordState, 1485
SetPictureName, 1369 SetTagDWordStateWait, 1474
SetPictureUp, 1384 SetTagDWordWait, 1495
SetPicUpTransparent, 1385 SetTagFloat, 1506
SetPicUpUseTransColor, 1386 SetTagFloatState, 1486
SetPicUseTransColor, 1386 SetTagFloatStateWait, 1475
SetPointCount, 1302 SetTagFloatWait, 1495
SetPosition, 1375 SetTagMultiStateWait, 1476
SetPressed, 1404 SetTagMultiWait, 1496
SetProcess, 1370 SetTagPrefix, 1371
SetPropBOOL, 1387 SetTagRaw, 1507
SetPropChar, 1388 SetTagRawState, 1487
SetPropDouble SetTagRawStateWait, 1477
0, 1389 SetTagRawWait, 1497
SetPropWord, 1390 SetTagSByte, 1508
SetRadius, 1303 SetTagSByteState, 1488
SetRadiusHeight, 1304 SetTagSByteStateWait, 1478
SetRadiusWidth, 1304 SetTagSByteWait, 1498
SetRangeMax, 1376 SetTagSDWord, 1509
SetRangeMin, 1377 SetTagSDWordState, 1489
SetReferenceRotationLeft, 1305 SetTagSDWordStateWait, 1479
SetReferenceRotationTop, 1306 SetTagSDWordWait, 1499
SetRightComma, 1254 SetTagSWord, 1510
SetRotationAngle, 1307 SetTagSWordState, 1490
SetRoundCornerHeight, 1308 SetTagSWordStateWait, 1480
SetRoundCornerWidth, 1308 SetTagSWordWait, 1499
SetScaleColor, 1271 SetTagValue, 1510
SetScaleTicks, 1255 SetTagValueWait, 1500
SetScaling, 1256 SetTagWord, 1511
SetScalingType, 1257 SetTagWordState, 1491
SetSelBGColor, 1272 SetTagWordStateWait, 1481
SetSelTextColor, 1272 SetTagWordWait, 1501
SetSmallChange, 1370 SetText, 1295
SetStartAngle, 1309 SetToggle, 1405
SetTagBit, 1502 SetToleranceHigh, 1342
SetTagBitState, 1482 SetToleranceLow, 1343
SetTagBitStateWait, 1471 SetTop, 1310
SetTagBitWait, 1491 SetTrend, 1372
SetTagByte, 1503 SetTrendColor, 1273
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2677
Index
SetTypeAlarmHigh, 1344 ShowSortDialog, 810
SetTypeAlarmLow, 1345 ShowTagSelection, 810
SetTypeLimitHigh4, 1346 ShowTimebaseDialog, 811
SetTypeLimitHigh5, 1347 ShowTimeSelection, 811
SetTypeLimitLow4, 1347 ShowTrendSelection, 812
SetTypeLimitLow5, 1348 Simulation, 2421
SetTypeToleranceHigh, 1349 SimulationBit, 2421
SetTypeToleranceLow, 1350 sin, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019,
SetTypeWarningHigh, 1351 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027,
SetTypeWarningLow, 1352 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035,
SetUnselBGColor, 1274 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043,
SetUnselTextColor, 1275 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051,
setvbuf, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1092, 1093, 1094, 1095, 1096
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, sinh, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1091, 1092, 1093, 1094, 1095, 1096 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
SetVisible, 1373 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
SetWarningHigh, 1353 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
SetWarningLow, 1353 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
SetWidth, 1311 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
SetWindowsStyle, 1406 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
SetZeroPoint, 1312 1091, 1092, 1093, 1094, 1095, 1096
SetZeroPointValue, 1374 Slider control, 270
SetZoom, 1374 Smart object, 1672
ShowBadTagState, 2421 Editing with VBA, 1674
ShowColumnSelection, 802 Smart Objects
ShowComment, 802 Combobox,
ShowDisplayOptionsDialog, 803 Control, 179
ShowEmergencyQuitDialog, 803 Faceplate instance,
ShowHelp, 803 Smart objects:3D bar, 167
ShowHideList, 804 Smart objects:Application window, 171
ShowHitList, 804 Smart objects:Bar, 172
ShowInfoText, 805 Smart Objects:Graphic Object, 185
ShowLockDialog, 805 Smart objects:Group Display, 192
ShowLockList, 806 Smart objects:I/O Field, 182
ShowLongTermArchiveList, 806 Smart objects:List Box, 187
ShowMessageList, 806 Smart Objects:Multiline Text, 188
ShowPercentageAxis, 807 Smart Objects:OLE Element, 189
ShowPropertyDialog, 807 Smart objects:Picture window, 177
ShowSelectArchive, 808 Smart objects:Status Display, 197
ShowSelection, 808 Smart objects:Text list, 194
ShowSelectionDialog, 809 Smart tag object, 134
ShowSelectTimeBase, 808 SmartTag property, 581
ShowShortTermArchiveList, 809
ShowSort, 810
WinCC: Scripting (VBS, ANSI-C, VBA)
2678 System Manual, 09/2018, A5E45518271-AA
Index
sqrt, 1012, 1013, 1014, 1015, 1016, 1017, 1018, Status bar, 880
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, StatusbarElement object, 227
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, stdio, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1091, 1092, 1093, 1094, 1095, 1096 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
srand, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1091, 1092, 1093, 1094, 1095, 1096
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, stdlib, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1091, 1092, 1093, 1094, 1095, 1096 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Standard function 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Application, 870 1091, 1092, 1093, 1094, 1095, 1096
Applying, 900 StorePicture, 1408
Characteristics, 870 strcat, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Deleting, 889 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
SysAckNuisanceMsg, 941 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Standard object, 1672 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Editing with VBA, 1674 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Standard Objects:Circle, 147 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Standard Objects:Circle segment, 150 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Standard Objects:Circular arc, 149 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Standard Objects:Connector, 165 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Standard Objects:Ellipse, 142 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Standard Objects:Ellipse arc, 144 1091, 1092, 1093, 1094, 1095, 1096
Standard Objects:Ellipse segment, 145 strchr, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Standard Objects:Line, 152 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Standard Objects:Polygon, 154 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Standard Objects:Polyline, 156 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Standard Objects:Rectangle, 157 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Standard Objects:Rounded Rectangle, 160 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Standard objects:Static Text, 163 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Standard procedure, 45 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Standard procedure:Use, 45 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Start, 1623 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
VBA editor, 1619 1091, 1092, 1093, 1094, 1095, 1096
VBA Macros, 1623
Starting Global Script, 28
StartStopUpdate, 812
StatisticAreaColumn object, 226
StatisticResultColumn object, 226
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2679
Index
strcmp, 1012, 1013, 1014, 1015, 1016, 1017, 1018, strftime, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096 1091, 1092, 1093, 1094, 1095, 1096
strcpy, 1012, 1013, 1014, 1015, 1016, 1017, 1018, string, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096 1091, 1092, 1093, 1094, 1095, 1096
strcspn, 1012, 1013, 1014, 1015, 1016, 1017, 1018, strlen, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096 1091, 1092, 1093, 1094, 1095, 1096
strerror, 1012, 1013, 1014, 1015, 1016, 1017, 1018, strncat, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096 1091, 1092, 1093, 1094, 1095, 1096
WinCC: Scripting (VBS, ANSI-C, VBA)
2680 System Manual, 09/2018, A5E45518271-AA
Index
strncmp, 1012, 1013, 1014, 1015, 1016, 1017, 1018, strspn, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096 1091, 1092, 1093, 1094, 1095, 1096
strncpy, 1012, 1013, 1014, 1015, 1016, 1017, 1018, strstr, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096 1091, 1092, 1093, 1094, 1095, 1096
strpbrk, 1012, 1013, 1014, 1015, 1016, 1017, 1018, strtod, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096 1091, 1092, 1093, 1094, 1095, 1096
strrchr, 1012, 1013, 1014, 1015, 1016, 1017, 1018, strtok, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096 1091, 1092, 1093, 1094, 1095, 1096
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2681
Index
strtol, 1012, 1013, 1014, 1015, 1016, 1017, 1018, system, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1091, 1092, 1093, 1094, 1095, 1096 1091, 1092, 1093, 1094, 1095, 1096
strtoul, 1012, 1013, 1014, 1015, 1016, 1017, 1018, System behavior, 907
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, T
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Table Control, 285
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Tag, 25, 65, 72, 2436, 2565
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Change limits with VBA, 2565
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Change type with VBA, 2565
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Configure a Trigger to an Action, 72
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Creating with VBA, 2565
1091, 1092, 1093, 1094, 1095, 1096
Define type with VBA, 2565
SVG library
Deleting with VBA, 2565
Copying an object with VBA, 1660
Read limits with VBA, 2565
create with VBA, 1658
Read properties with VBA, 2565
Creating a folder with VBA, 1660
Tag Logging, 2576
Deleting a folder with VBA, 1660
Create archive tag with VBA, 2576
Edit write protection with VBA, 1658
Create process value archive with VBA, 2576
Editing with VBA, 1658, 1660
Delete archive tag with VBA, 2576
Export with VBA, 1658
Delete process value archive with VBA, 2576
Import with VBA, 1658
Edit archive tag with VBA, 2576
Symbol library, 1650
Edit process value archive with VBA, 2576
Access with VBA, 1650
Tag Object, 135
Copying an object with VBA, 1653
Tag:global in VBS, 25
Creating a folder with VBA, 1653
tagname, 2437
Deleting a folder with VBA, 1653
Tags Object (List), 137
Editing with VBA, 1653
TagScaleParam1 properties, 2438
Paste Object into a Picture with VBA, 1656
TagScaleParam2 properties, 2438
Syntax, 64
TagScaleParam3 properties, 2438
Syntax:Control, 64
TagScaleParam4 properties, 2439
Syntax:Error, 64
TagSet Object (List), 139
SysAckNuisanceMsg, 941
tagtype, 2439
SysFree, 1012
SysMalloc, 1012
WinCC: Scripting (VBS, ANSI-C, VBA)
2682 System Manual, 09/2018, A5E45518271-AA
Index
tan, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019, TitleForeColorActive property, 2443
1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, TitleForeColorInactive property, 2443
1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035, TlgGetColumnPosition, 999
1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, TlgGetNumberOfColumns, 993
1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051, TlgGetNumberOfRows, 994
1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, TlgGetNumberOfTrends, 994
1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, TlgGetRowPosition, 995
1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, TlgGetRulerArchivNameTrend, 995
1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, TlgGetRulerTimeTrend, 996
1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, TlgGetRulerValueTrend, 997
1092, 1093, 1094, 1095, 1096 TlgGetRulerVariableNameTrend, 998
tanh, 1012, 1013, 1014, 1015, 1016, 1017, 1018, TlgGetTextAtPos, 998
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, TlgTableWindowPressEditRecordButton, 970
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, TlgTableWindowPressFirstButton, 971
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, TlgTableWindowPressInsertRecordButton, 972
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, TlgTableWindowPressLastButton, 972
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, TlgTableWindowPressNextButton, 973
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, TlgTableWindowPressNextItemButton, 974
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, TlgTableWindowPressOpenArchiveVariableSelectio
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, nDlgButton, 974
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, TlgTableWindowPressOpenDlgButton, 975
1091, 1092, 1093, 1094, 1095, 1096 TlgTableWindowPressOpenItemSelectDlgButton,
Template, 2439 976
Testing, 85 TlgTableWindowPressOpenTimeSelectDlgButton,
Testing:with the Debugger, 85 976
Text library, 2610 TlgTableWindowPressPrevButton, 977
Changing text with VBA, 2610 TlgTableWindowPressPrevItemButton, 978
Creating language with VBA, 2610 TlgTableWindowPressRemoveRecordButton, 978
Creating text with VBA, 2610 TlgTableWindowPressStartStopButton, 979
Deleting text with VBA, 2610 TlgTrendWindowActivateCurve, 1000
Read text with VBA, 2610 TlgTrendWindowPressFirstButton, 979
Read TextID with VBA, 2610 TlgTrendWindowPressHelpButton, 980
TextBiblIDs, 2440 TlgTrendWindowPressLastButton, 981
time, 1012, 1013, 1014, 1015, 1016, 1017, 1018, TlgTrendWindowPressLinealButton, 981
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, TlgTrendWindowPressNextButton, 982
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, TlgTrendWindowPressNextItemButton, 983
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, TlgTrendWindowPressOneToOneButton, 984
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, TlgTrendWindowPressOpenArchiveVariableSelectio
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, nDlgButton, 984
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, TlgTrendWindowPressOpenDlgButton, 985
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, TlgTrendWindowPressOpenItemSelectDlgButton,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 986
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, TlgTrendWindowPressOpenTimeSelectDlgButton,
1091, 1092, 1093, 1094, 1095, 1096 986
TimeAxis object, 228 TlgTrendWindowPressPrevButton, 987
TimeColumn object, 229 TlgTrendWindowPressPrevItemButton, 988
Timer, 65, 71 TlgTrendWindowPressPrintButton, 988
Configure a Trigger to an Action, 71 TlgTrendWindowPressReportSaveButton, 989
TitleBackColorActiveEnd property, 2442 TlgTrendWindowPressStartStopButton, 990
TitleBackColorActiveStart property, 2442 TlgTrendWindowPressStatsResultButton, 990
TitleBackColorInactiveEnd property, 2443 TlgTrendWindowPressStatsSelectRangeButton, 991
TitleBackColorInactiveStart property, 2443 TlgTrendWindowPressZoomInButton, 992
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2683
Index
TlgTrendWindowPressZoomOutButton, 992 toupper, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
tmpfile, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, 1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, 1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, 1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, 1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, 1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, 1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, 1091, 1092, 1093, 1094, 1095, 1096
1091, 1092, 1093, 1094, 1095, 1096 TraceText, 1519
tmpnam, 1012, 1013, 1014, 1015, 1016, 1017, 1018, TraceTime, 1520
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, TransformDisplayCoordinate, 1898
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, TransformPixelCoordinate, 1898
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, trend, 2451
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, Trend object, 231
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, TrendWindow object, 232
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, Trigger, 65
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, Changing, 921
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, Deleting, 922
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, Effect on actions, 916
1091, 1092, 1093, 1094, 1095, 1096 Picture cycle, 1716
tolower, 1012, 1013, 1014, 1015, 1016, 1017, 1018, Standard cycle, 1716
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, Tag, 1716
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, Window Cycle, 1716
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, Trigger type, 866, 916
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, Triggers, 71, 72, 1715
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, Adding type "Timer", 71
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, Adding type Tag, 72
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, Changing, 73
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, Configuring with VBA, 1715
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, Deleting, 74
1091, 1092, 1093, 1094, 1095, 1096 Tube objects:Double T-piece, 214
toolbar, 1663 Tube objects:Polygon tube, 213
Add icon, Tube objects:T-piece, 214
application-specific, Tube objects:Tube Arc, 215
Assigning help text, 1643 TubeArcObject object, 2097
Assigning status text, 1643 TubeDoubleTeeObject object, 2099
Assigning VBA macro, 1645 TubePolyline object, 2101
Configuring, 1630 TubeTeeObject object, 2103
Insert, 1639
picture-specific, 1663
Placement,
Properties,
user-defined,
Working with toolbars,
Toolbar:GSC Diagnostics, 81
ToolbarButton object, 230
ToolbarItemType, 2447
WinCC: Scripting (VBS, ANSI-C, VBA)
2684 System Manual, 09/2018, A5E45518271-AA
Index
VB Scripts, 1705
Dynamize property with VBA, 1705
U VBA, 1618
Access to a copy of the pictures, 1663
ungetc, 1012, 1013, 1014, 1015, 1016, 1017, 1018,
Access to external applications, 1721
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026,
Access to group objects, 1682
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034,
Access to layers, 1663
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042,
Access to objects in the Graphics Designer, 1670
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050,
Access to other programs, 1721
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058,
Access to the component library, 1650
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066,
Access to the symbol library, 1650
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074,
Accessing MS Excel with VBA, 1722
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082,
Action configuring, 1707
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090,
Add menu entry to user-defined menu, 1635
1091, 1092, 1093, 1094, 1095, 1096
Adding a New Icon to the used-defined
UnhideAlarm, 814
Toolbar, 1641
UnlockAlarm, 814
Alarm Logging, 2624
UsedLanguage, 2467
Assign help text to user-defined menu, 1643
UseEventState, 2467
Assign help text to user-defined toolbar, 1643
UseGlobalAlarmClasses, 2468
Assigning VBA macro to user-defined
UseGlobalSettings, 2469
menu, 1645
User interface language, 1628
Assigning VBA macro to user-defined
Access with VBA, 1628
toolbar, 1645
UserArchiveControl, 274
C Scripts (Delimitation), 1618
User-defined menu, 1623, 1631
Configure user-defined menu, 1630
Add menu entry, 1635
Configure user-defined toolbar, 1630
Assigning help text, 1643
Configuring a Direct Connection, 1709
Assigning status text, 1643
Configuring C Action on an Event, 1711
Assigning VBA macro, 1645
Configuring Dynamics in a Property with C
Configuring, 1630
Script, 1702
Creating, 1633
Configuring Dynamics in a Property with Dynamic
creating multiple languages, 1637
Dialog, 1699
Placement, 1631
Configuring Dynamics in a Property with VB
Properties, 1631
Script, 1705
User-defined toolbar, 1623, 1631
Configuring event-controlled actions, 1707
Add icon, 1641
Configuring for multiple languages, 1628
Assigning help text, 1643
Configuring triggers, 1715
Assigning status text, 1643
Configuring VB Action on an Event, 1713
Assigning VBA macro, 1645
Controlling the visibility of layers, 1666
Configuring, 1630
Create an application-specific menu, 1633
Creating, 1639
Create application-specific toolbar, 1639
Placement, 1631
Create user-defined menu, 1633
Properties, 1631
Create user-defined menu in multiple
UseValueText, 2472
languages, 1637
Create user-defined toolbar, 1639
Creating a group object, 1684
V Customized Object, 1690
Validity range, 876 Deleting Group Objects, 1684
ValueAxis object, 233 Dynamic Wizards (Delimitation), 1618
ValueColumn object, 234 Dynamization, 1694
VB action, 1713 Edit component library, 1653
Configuring on an event with VBA, 1713 Edit layers, 1666
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2685
Index
Edit Smart object, 1674 protecting, 1619
Edit standard object, 1674 References, 1619
Edit SVG library, 1658, 1660 VBA editor, 1619
Edit Windows object, 1674 Start, 1619
Editing a copy of a picture, 1668 VBA events
Editing a group object, 1684 see VBA Events:VBA Event Handling, 1752
Editing Customized Objects, 1691 VBA in the Graphics Designer, 1625
Editing objects in a group object, 1687 VBA Macros, 1623
Editing objects in Graphic Designer, 1670 Specifics during the execution, 1619
Editing objects in Graphics Designer, 1670 Version, 1623
Editing picture, 1663 VBA Object Model, 1752
Editing symbol library, 1653 VBA Reference, 1752
Event Handling, 1717 Event Handling, 1752
Executing VBA macros, 1623 Events, 1752
Export code, 1622 Methods, 1752
global VBA code, 1619 Object model, 1752
Group Objects, 1682 Properties, 1752
HMIGO class, 2563 VBA Object Model, 1752
Import code, 1622 VBS, 25, 825
in Graphics Designer, 1625 Application scenarios, 12
in other WinCC Editors, 2563 Basics, 863
Inserting an ActiveX control into a picture, 1679 Examples, 857
Language-dependent configuration, 1628 Examples in WinCC, 825
Making properties dynamic, 1695 Methods, 713
ODK (Delimitation), 1618 Object model, 103
OLE Element, 1677 Objects, 105
Paste Object from component library into a Reference, 103
Picture, 1656 Target Group of the Documentation, 12
Paste Object from symbol library into a VBS:Action, 19
Picture, 1656 VBS:CrossReference, 23
Paste Object into Picture, 1672 VBS:Editors, 27
picture-specific VBA code, 1619 VBS:Module, 16
Project language, 1628 VBS:Object Types, 141
project-specific VBA Code, 1619 VBS:Procedure, 16
Tag Logging, 2576 VBS:Properties, 297
Tag Management, 2565 VBS:Standard Functions, 42
Text library, 2610 VBS:Using Global Tags, 25
Ungrouping Group Object, 1684 VBScript
Usage, 1618 Activating in Runtime, 77
User interface language, 1628 VBScript Files, 90
User-defined menu, 1631 VBScript Files:Structure, 90
User-defined toolbar, 1631 VBScript:debugging, 85
VB Scripts (Delimitation), 1618 VBScript:open in Debugger, 94
VBA Code, 1622 VBScript:print, 102
Execution sequence, 1619
Exporting, 1622
global, 1619
Importing, 1622
Organization within the WinCC Project, 1619
Password protection, 1619
picture-specific, 1619
project-specific, 1619
WinCC: Scripting (VBS, ANSI-C, VBA)
2686 System Manual, 09/2018, A5E45518271-AA
Index
vfprintf, 1012, 1013, 1014, 1015, 1016, 1017, 1018, WinCC OnlineTableControl
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, Example of C script, 1585
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, StatusbarElement object, 227
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, TimeColumn object, 229
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, ToolbarButton object, 230
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, ValueColumn object, 234
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, VBS example, 853
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, WinCC OnlineTrendControl
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, Example of C script, 1586
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, StatusbarElement object, 227
1091, 1092, 1093, 1094, 1095, 1096 ToolbarButton object, 230
View, 887 Trend object, 231
Setting different views, 887 TrendWindow object, 232
Visual Basic script, 12 VBS example, 848
Visual Basic script in WinCC, 12 VBS example to setpoint trend, 851
vsprintf, 1012, 1013, 1014, 1015, 1016, 1017, 1018, WinCC RulerControl
1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, RulerBlock object, 224
1027, 1028, 1029, 1030, 1031, 1032, 1033, 1034, RulerColumn object, 225
1035, 1036, 1037, 1038, 1039, 1040, 1041, 1042, StatisticAreaColumn object, 226
1043, 1044, 1045, 1046, 1047, 1048, 1049, 1050, StatisticResultColumn object, 226
1051, 1052, 1053, 1054, 1055, 1056, 1057, 1058, StatusbarElement object, 227
1059, 1060, 1061, 1062, 1063, 1064, 1065, 1066, ToolbarButton object, 230
1067, 1068, 1069, 1070, 1071, 1072, 1073, 1074, WinCC UserArchiveControl
1075, 1076, 1077, 1078, 1079, 1080, 1081, 1082, Column object, 219
1083, 1084, 1085, 1086, 1087, 1088, 1089, 1090, StatusbarElement object, 227
1091, 1092, 1093, 1094, 1095, 1096 ToolbarButton object, 230
WinCC:Graphic object types, 141
WinCC:WinCC Digital Analog Clock, 244
W WinCC:WinCC Function Trend Control, 281
WinCC:WinCC FunctionTrendControl, 246
WinCC, 12, 141
WinCC:WinCC Gauge Control, 251
Script Languages, 12
WinCC:WinCC Online Table Control Online, 285
Visual Basic script, 12
WinCC:WinCC Online Trend Control, 288
WinCC Alarm Control, 279
WinCC:WinCC OnlineTableControl, 254
WinCC AlarmControl, 238
WinCC:WinCC OnlineTrendControl, 260
WinCC MediaControl, 254
WinCC:WinCC Push Button Control Controls:WinCC
WinCC AlarmControl
Push Button Control, 291
HitlistColumn object, 220
WinCC:WinCC RulerControl, 266
MessageBlock object, 221
WinCC:WinCC UserArchiveControl, 274
MessageColumn object, 221
Window, 79, 82
OperatorMessage object, 222
Windows object, 1672
StatusbarElement object, 227
Editing with VBA, 1674
ToolbarButton object, 230
Windows Objects:Button, 199
VBS example, 855
Windows Objects:Check Box, 202
WinCC coding rules, 910
Windows Objects:Radio Box, 205
WinCC FunctionTrendControl
Windows Objects:Roundbutton, 207
StatusbarElement object, 227
Windows Objects:Slider, 210
ToolbarButton object, 230
WPFControl, 2113
Trend object, 231
WriteTag, 819
TrendWindow object, 232
Writing tag values, 830
XAxis object, 235
YAxis object, 236
WinCC: Scripting (VBS, ANSI-C, VBA)
System Manual, 09/2018, A5E45518271-AA 2687
Index
X
XAxis object, 235
Y
YAxis object, 236
Z
ZoomArea, 820
ZoomInOut, 820
ZoomInOutTime, 820
ZoomInOutValues, 821
ZoomInOutX, 821
ZoomInOutY, 822
ZoomMove, 822
WinCC: Scripting (VBS, ANSI-C, VBA)
2688 System Manual, 09/2018, A5E45518271-AA
You might also like
- WinCCInformationSystemGeneralInfo_en-USNo ratings yetWinCCInformationSystemGeneralInfo_en-US128 pages
- Simatic Energy Manager Basic Operating Manual en-US en-USNo ratings yetSimatic Energy Manager Basic Operating Manual en-US en-US311 pages
- WinCC GeneralInfo Installation Readme en-US en-US PDFNo ratings yetWinCC GeneralInfo Installation Readme en-US en-US PDF212 pages
- Simatic S7-1200 Simatic S7-200 To Simatic S7-1200 Software Conversion Tool V11No ratings yetSimatic S7-1200 Simatic S7-200 To Simatic S7-1200 Software Conversion Tool V1136 pages
- WinCC Working With WinCC en-US en-US PDFNo ratings yetWinCC Working With WinCC en-US en-US PDF2,776 pages
- 840D SL ONE PMM 3d SW Inst Man 0122 en-USNo ratings yet840D SL ONE PMM 3d SW Inst Man 0122 en-US44 pages
- Readme Wincc Comfort Advanced v13 Enus PDFNo ratings yetReadme Wincc Comfort Advanced v13 Enus PDF62 pages
- WinCC GeneralInfo Installation Readme en-US en-US PDFNo ratings yetWinCC GeneralInfo Installation Readme en-US en-US PDF266 pages
- WinCC V7.5 WinCC: General Information and InstallationNo ratings yetWinCC V7.5 WinCC: General Information and Installation266 pages
- Simatic Hmi HMI Devices Migration Guide Comfort PanelsNo ratings yetSimatic Hmi HMI Devices Migration Guide Comfort Panels52 pages
- s71500 Pid Control Function Manual en-US en-USNo ratings yets71500 Pid Control Function Manual en-US en-US558 pages
- Simatic Energy Manager Pro Operating Manual en-US en-USNo ratings yetSimatic Energy Manager Pro Operating Manual en-US en-US913 pages
- Cybersecurity for Executives: A Guide to Protecting Your BusinessFrom EverandCybersecurity for Executives: A Guide to Protecting Your BusinessNo ratings yet
- Java Basics - Java Programming Tutorial PDF100% (1)Java Basics - Java Programming Tutorial PDF41 pages
- Https Doc 00 3g Apps Viewer - GoogleusercontentNo ratings yetHttps Doc 00 3g Apps Viewer - Googleusercontent227 pages
- CSE 102: Computer Programming: StructuresNo ratings yetCSE 102: Computer Programming: Structures12 pages
- خوارزمية جدولة مقترحة للمعالجات المتعددةNo ratings yetخوارزمية جدولة مقترحة للمعالجات المتعددة12 pages
- Exceptions and Processes!: Jennifer Rexford!No ratings yetExceptions and Processes!: Jennifer Rexford!35 pages
- BSC - Computer Science Cs - Semester 6 - 2022 - April - Object Oriented Programming II Core Java 2019 PatternNo ratings yetBSC - Computer Science Cs - Semester 6 - 2022 - April - Object Oriented Programming II Core Java 2019 Pattern2 pages
- Main PDF 2 - PHP Operators and Control Structures PDFNo ratings yetMain PDF 2 - PHP Operators and Control Structures PDF27 pages
- Volume of Add Operator: Create 2 Simple Mathematical Operator Function Using C++ Programming Language SoftwareNo ratings yetVolume of Add Operator: Create 2 Simple Mathematical Operator Function Using C++ Programming Language Software10 pages
- Simatic Energy Manager Basic Operating Manual en-US en-USSimatic Energy Manager Basic Operating Manual en-US en-US
- WinCC GeneralInfo Installation Readme en-US en-US PDFWinCC GeneralInfo Installation Readme en-US en-US PDF
- Simatic S7-1200 Simatic S7-200 To Simatic S7-1200 Software Conversion Tool V11Simatic S7-1200 Simatic S7-200 To Simatic S7-1200 Software Conversion Tool V11
- WinCC GeneralInfo Installation Readme en-US en-US PDFWinCC GeneralInfo Installation Readme en-US en-US PDF
- WinCC V7.5 WinCC: General Information and InstallationWinCC V7.5 WinCC: General Information and Installation
- Simatic Hmi HMI Devices Migration Guide Comfort PanelsSimatic Hmi HMI Devices Migration Guide Comfort Panels
- Simatic Energy Manager Pro Operating Manual en-US en-USSimatic Energy Manager Pro Operating Manual en-US en-US
- Cybersecurity for Executives: A Guide to Protecting Your BusinessFrom EverandCybersecurity for Executives: A Guide to Protecting Your Business
- BSC - Computer Science Cs - Semester 6 - 2022 - April - Object Oriented Programming II Core Java 2019 PatternBSC - Computer Science Cs - Semester 6 - 2022 - April - Object Oriented Programming II Core Java 2019 Pattern
- Main PDF 2 - PHP Operators and Control Structures PDFMain PDF 2 - PHP Operators and Control Structures PDF
- Volume of Add Operator: Create 2 Simple Mathematical Operator Function Using C++ Programming Language SoftwareVolume of Add Operator: Create 2 Simple Mathematical Operator Function Using C++ Programming Language Software