Overview of VBA scripting
Welcome to the Help for using Visual Basic for Applications with PcVue. It provides the language reference for scripting the application objects.
It includes:
- Introduction to VBA in PcVue
- The HMI object model reference
- The Graphic controls object model reference
- The HDS object model reference
If you are unfamiliar with VBA, you will benefit from learning more about it:
- By working through one of the many available resources on VBA, with examples of code
- By contacting your distributor for details about training courses
The VBA reference documentation can be found in a help file opened from the Help entry in the VBA editor menu. Documentation for objects specific to PcVue is available in this section.
Except introduction topics, these sections of the help are only available in the English language.
Accessing the VBA environment
The VBA development environment can be accessed in several ways:
- From the keyboard using Alt + F11
- Using the following button
in the toolbar
- In Design mode using the shortcut View script from the context menu displayed by right-clicking on any graphic element. This turns on the VBA control attribute for the element
Content of this help
You can use this Help to find information on an Object or a Collection of objects, or on an object's Properties, Methods and Events. You can also find examples of code.
The help for VBA is displayed by clicking F1 when in the VBA development environment.
Searching this help
You can find information in several ways:
-
Use the table of contents in the left pane to navigate through the books and topics
-
Use the Search feature to list all topics that contain the word or phrase that you enter. You can include logical search expressions, using the operators AND, OR, NOT and NEAR, plus nesting of them inside parentheses '(...)'.
For further guidance,
Below the title of each topic, there are 'See Also' links to closely related topics:
-
Each Object or Collection topic provides links to its Properties, Methods, Events and Examples.
-
Each Property, Method or Event topic provide links to the object(s) to which it applies.
-
Any of these topics may have links to relevant Example topics.
The examples illustrate the syntax to be used, rather than best practice for scripting.
Style conventions used in this help
It follows the styling of Microsoft Visual Basic help (see Visual Basic Language Reference.Miscellaneous.Document Conventions). In particular:
- Words that you are instructed to type appear in bold.
- Placeholders for information you supply appear in italic.
- A bulleted list is used for items that have no particular order.
- A numbered list is used for a list with a sequence, for example giving the steps of a task.
- etc.
File contents and data lists are shown by text in a mono-spaced font.
'Show ...' indicates a link within a topic. Click on it to display a picture, list or table.
The links below the title of a topic give you access to other topics that are related to the one you are on. The selection of links depends on the kind of topic:
See Also, Example, Properties, Methods, Events, Applies To and Specifics
When you click on such a link, it either displays a list of relevant topics or directly opens the one relevant topic.