Display Building Guide EP-DSXX36

Experion
Display Building Guide
EP-DSXX36
April 2010
Release 400
Document Release Issue Date
EP-DSXX36 400 0 April 2010
Notice
This document contains Honeywell proprietary information. Information
contained herein is to be used solely for the purpose submitted, and no part of this
document or its contents shall be reproduced, published, or disclosed to a third
party without the express permission of Honeywell International Sàrl.
While this information is presented in good faith and believed to be accurate,
Honeywell disclaims the implied warranties of merchantability and fitness for a
purpose and makes no express warranties except as may be stated in its written
agreement with and for its customer.
In no event is Honeywell liable to anyone for any direct, special, or consequential
damages. The information and specifications in this document are subject to
change without notice.
Copyright 2010 – Honeywell International Sàrl
Honeywell trademarks
Experion®, PlantScape®, SafeBrowse®, TotalPlant® and TDC 3000® are
trademarks of Honeywell International Inc.
Other trademarks
Microsoft and SQL Server are either registered trademarks or trademarks of
Microsoft Corporation in the United States and/or other countries.
Trademarks that appear in this document are used only to the benefit of the
trademark owner, with no intention of trademark infringement.
2 www.honeywell.com/ps
Support and other contacts
United States and Canada
Contact Honeywell Solution Support Center

Phone 1-800-822-7673
Calls are answered by dispatcher between 6:00 am and 4:00 pm Mountain
Standard Time. Emergency calls outside normal working hours are
received by an answering service and returned within one hour.
Facsimile 1-973-455-5000
Mail Honeywell TAC, MS L17
1860 W. Rose Garden Lane
Phoenix, AZ 85027 USA
Europe, Middle East, and Africa (EMEA)
Contact Honeywell TAC-EMEA

Phone +32-2-728-2345
Facsimile +32-2-728-2696
Mail TAC-BE02
Hermes Plaza
Hermeslaan, 1H
B-1831 Diegem, Belgium
Pacific
Contact Honeywell Global TAC - Pacific

Phone 1300-364-822 (toll free within Australia)
+61-8-9362-9559 (outside Australia)
Facsimile +61-8-9362-9564
Mail Honeywell Limited Australia
5 Kitchener Way
Burswood, WA, 6100, Australia
Email GTAC@honeywell.com
3
India
Contact Honeywell Global TAC - India

Phone +91-20-6603-2718 / 19
1800-233-5051
Facsimile +91-20-6603-9800
Mail Honeywell Automation India Ltd.
56 and 57, Hadapsar Industrial Estate
Hadapsar, Pune - 411 013, India
Email Global-TAC-India@honeywell.com
Korea
Contact Honeywell Global TAC - Korea

Phone +82-80-782-2255 (toll free within Korea)
Facsimile +82-2-792-9015
Mail Honeywell Co., Ltd
4F, Sangam IT Tower B4-4 Block,
1590, DMC Sangam-dong,
Mapo-gu, Seoul, 121-835, Korea
Email Global-TAC-Korea@honeywell.com
People’s Republic of China
Contact Honeywell Global TAC - China

Phone +86-21-2219-6888
800-820-0237
400-820-0386
Mail Honeywell (China) Co., Ltd
33/F, Tower A, City Center, 100 Zunyi Rd.
Shanghai 200051, People’s Republic of China
Email Global-TAC-China@honeywell.com
Singapore
Contact Honeywell Global TAC - South East Asia

Phone +65-6580-3500
Facsimile +65-6580-3501
+65-6445-3033
Mail Honeywell Private Limited
Honeywell Building
17, Changi Business Park Central 1
Singapore 486073
Email GTAC-SEA@honeywell.com
Taiwan
Contact Honeywell Global TAC - Taiwan

Phone +886-7-536-2567
Facsimile +886-7-536-2039
Mail Honeywell Taiwan Ltd.
17F-1, No. 260, Jhongshan 2nd Road.
Cianjhen District
Kaohsiung, Taiwan, ROC
Email Global-TAC-Taiwan@honeywell.com
Japan
Contact Honeywell Global TAC - Japan

Facsimile +81-3-6730-7228
Mail Honeywell K.K
New Pier Takeshiba, South Tower Building,
20th Floor, 1-16-1 Kaigan, Minato-ku,
Tokyo 105-0022, Japan
Email Global-TAC-JapanJA25@honeywell.com
Elsewhere
Call your nearest Honeywell office.
World Wide Web

Honeywell Process Solutions Support Online web site:
http://www.honeywell.com/ps
5
Training classes
Honeywell holds technical training classes on Experion. These classes are taught
by experts in the field of process control systems. For more information about
these classes, contact your Honeywell representative, or see http://
www.automationcollege.com.
Related documentation
For a complete list of publications and documents for Experion, see the Experion
Overview.
Contents
1 About this guide 13

Before reading this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
How to use this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2 Getting started with (DSP) Display Builder 17

Starting display builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Using the toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Standard toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Toolbox toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
View toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Arrange toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Format Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Basic drawing techniques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Setting the defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Creating a display object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Selecting display objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Locking display objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Aligning display objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Distributing display objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Flipping display objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Moving a display object to the front or back. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Grouping display objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Resizing display objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Duplicating display objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Deleting display objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Editing display objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Rotating display objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Moving display objects with the arrow keys. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Selecting colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Undoing the previous action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Using the Properties Window (DSP displays). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Linking display objects to the database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Using shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Shape sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Dynamic shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Using the Shape Gallery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Registering shape folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Using the supplied shape library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
7
CONTENTS
Using SafeBrowse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
URL formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Linking to displays from HTML pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Inserting graphics created by other applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Pasting text from another application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Setting the display’s options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Working with files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Creating a new display or shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Saving a new display or shape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Opening a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Distributing and validating files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Checking the validity of point IDs in remotely-built files . . . . . . . . . . . . . . . . . . . . . . . 71
Distributing files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Exporting numbered displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
3 Defining display object properties 75

Animation tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Appearance tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Custom XY tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Data tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Defining a link to a point. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Defining a link to a database file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Using local display objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Details tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
ActiveX document object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Alarm Line object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Alphanumeric object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Chart object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Checkbox object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Combobox object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Indicator object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Pushbutton object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
SafeBrowse object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Scrollbar object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Text object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Font tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
General tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Options tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Selecting the type of chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Repeats tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
XY Plot tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .111
About acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112
Selecting default acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113
Using custom acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
CONTENTS
4 Defining display and shape properties (DSP) 117

General tab for a (DSP) display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Details tab for a (DSP) display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Restricting page callup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Keys tab for a (DSP) display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Callup Task tab for a (DSP) display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Periodic Task tab for a (DSP) display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Help tab for a (DSP) display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Assigning an HTML Help topic (to a DSP display) . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Assigning a help document (to a DSP display) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
General tab for a shape file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
5 Scripting reference 131

Scripting basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Events and event handlers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Using general scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Referencing objects, properties and methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Using the Dictionary object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Writing scripts for shapes and shapelinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Event handling in groups and shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Using timers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Using the Script Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Writing scripts for displays and shape files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Writing scripts for Station . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
About the possibilities of automation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Overview of the Station Automation object model. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Application object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
AppWindow object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Dictionary object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Display objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Objects collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Page object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Add method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
AddListItem method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
BeginCriticalSection method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Blue method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
CancelChange method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
CancelClick method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
CancelDoubleClick method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
CancelNavigate method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
CancelOperatorCommand method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Clear method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
9
CONTENTS
CreateTimer method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

CrossScreenInvocationPending method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
DPToLPX and DPToLPY methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
EndCriticalSection method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
ExecuteOperatorCommand method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
GetResponse method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
GoBack method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
GoForward method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
GoHome method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
GoSearch method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Green method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
InvokeMenu method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Item method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
KillTimer method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
LPToDPX and LPToDPY methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
MakeColor method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
OpenHelp method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Quit method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Red method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Redraw method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Refresh method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Remove method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
RemoveListItem method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
RequestServerLRN method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
SelectText method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
SetFocus method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Shell method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Stop method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Update method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
UserObjectNotify method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
OnAlarm event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
OnAppStartup event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
OnBeginNavigate event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
OnChange event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
OnClick event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
OnConnect event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
OnDisconnect event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
OnDoubleClick event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
OnDownloadBegin event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
OnDownloadComplete event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
OnFocus event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
OnLoad event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
OnMenu event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
OnMenu2 event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
OnMouseEnter event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
CONTENTS
OnMouseLeave event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

OnMouseMove event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
OnNavigateComplete event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
OnOperatorChange event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
OnOperatorCommand event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
OnPageComplete event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
OnPageLoad event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
OnPeriodicUpdate event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
OnQuit event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
OnRightClick event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
OnTimer event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
OnUnload event. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
OnUpdate event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
OnUserObjectNotify event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
About display coordinates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Mouse coordinates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Converting between logical and display coordinates . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Animation using a shape sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Color animation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Adding tool tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Controlling Station from another application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Controlling another application from Station . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Using the Document property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
6 Guidelines for creating user-friendly displays 251

General standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Title bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Alphanumeric data boxes and labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Pushbuttons and hyperlinks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Comboboxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Checkboxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Group headings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Faceplates and LEDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Further reading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
7 Tutorial 265
Setting up the drawing window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Drawing the objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Drawing the title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Drawing the pump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Drawing the tank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Drawing the pipe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Drawing and configuring the alphanumeric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
11
CONTENTS
Drawing and configuring the push button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

Animating the pump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Animating the tank with level fill . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Saving the display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
8 Reference information 281

Keyboard shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Using the shortcut menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Creating a point detail display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Using Display Builder’s command-Line parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Using DisplayInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Glossary
About this guide
1
This guide describes how to use Display Builder to create custom displays for
your Experion system.
This guide:
• Introduces you to the basic concepts behind Display Builder
• Describes how to create displays and link them to points in the server database
• Describes how to write scripts—mini programs—that increase the
functionality of your displays
• Provides guidelines for creating user-friendly displays
Attention This version of Display Builder creates displays with a proprietary “DSP”
format. If you want to create Web-based displays, see the HMIWeb Display
Building Guide
13
1 – ABOUT THIS GUIDE
Before reading this guide

This guide assumes that you are familiar with the Experion server database, so
that when creating custom displays, you can link display objects to appropriate
points within that database.
You should also be familiar with the standard displays that come with Station, and
understand their capabilities and limitations.
Pre-requisite skills
This guide assumes that you have some knowledge of Microsoft Windows, and
understand phrases such as “double-clicking” and “dragging”.
HOW TO USE THIS GUIDE
How to use this guide

This guide is structured as follows:
• Getting started with (DSP) Display Builder introduces you to Display Builder,
and describes how to use the drawing tools.
• Defining display object properties describes how to configure the
characteristics of display objects, including linking them to the database.
• Defining display and shape properties (DSP) describes how to specify the
characteristics of display and shape files.
• Scripting reference describes how to add extra functionality to displays with
scripts.
• Guidelines for creating user-friendly displays provides guidelines and tips.
• Tutorial provides step-by-step instructions that show you how to create a
simple display.
• Reference information covers miscellaneous topics, such as keyboard
shortcuts and migrating displays from older products.
15
1 – ABOUT THIS GUIDE
Getting started with (DSP)
Display Builder 2
Custom displays work in the same way as the standard displays supplied with
Experion. However, custom displays allow you to present information in a more
sophisticated and “user-friendly” manner. As a consequence, custom displays
make it easier for operators to visualize complex processes, and reduce the
probability of operator errors.
Attention This version of Display Builder creates displays with a proprietary “DSP”
format. If you want to create Web-based displays, see the HMIWeb Display
Building Guide.
17
2 – GETTING STARTED WITH (DSP) DISPLAY BUILDER
Starting display builder

To start Display Builder from the Start menu if you are on the server, choose:
Start > All Programs > Honeywell Experion PKS > Server > Display Builder.
To start Display Builder from the Start menu on any other computer, choose:
Start > All Programs > Honeywell Experion PKS > Client Software >
Display Builder.
When Display Builder starts, you see what at first appears to be a standard
drawing application, with several toolbars and a blank drawing. At its simplest
level, this is true because you draw display objects, such as rectangles and push
buttons, in much the same way as you do in a standard drawing application.
The big difference, however, is that you can “animate” display objects in a
number of ways. For example, you can link an alphanumeric display object to a
point in the server database, so that it displays the point’s value. You can also
make a display interactive by adding controls such as push buttons and check
boxes.
Figure 1 Layout of Display Builder
USING THE TOOLBARS
Using the toolbars

The toolbars provide speedy access to many of Display Builder’s functions.
To display (or hide) a toolbar:

1 Choose View > Toolbars to see the list of toolbars.
Figure 2 Toolbars menu
A tick opposite a toolbar indicates that it is already visible.

2 Select the toolbar you want to display (or hide).
3 If appropriate, drag the toolbar to a convenient location. For example if you
have a large screen, it is a good idea to reserve one part of the screen for the
display you are creating and another part for the toolbars—that way, they
never obscure your work. (If you drag a toolbar to the edge of the Display
Builder window, they will “dock” to the edge, and effectively become part of
it.)
19
Standard toolbar
The Standard toolbar includes basic Windows-related buttons such as Open and
Save.
Figure 3 Standard toolbar
Button Description
Display/Shape. Creates a new display or shape. Click the arrow to the
right to display the list:
Display. Creates a new display.
Shape Sequence. Creates a new shape sequence. See “Using shapes” on

page 51.
Dynamic Shape. Creates a new dynamic shape. See “Using shapes” on
page 51.
Open. Opens an existing display.
Save. Saves the display.
Print. Prints the display (to the Windows printer on the computer
running Display Builder).
Cut. Removes the selected object(s) from the display (and copies them
to the clipboard).
Copy. Copies the selected object(s) to the clipboard.
Paste. Pastes the clipboard’s contents into the display.
Duplicate. Makes duplicates of the selected object(s).
Find. Finds an object by its name (as shown in the Name property of the
Properties Window).
Undo. Undoes the previous action.
Help. Displays the Help for Display Builder.
USING THE TOOLBARS
Toolbox toolbar
The Toolbox toolbar contains two types of buttons:
• Editing buttons, which you use to edit existing objects.
• Object creation buttons, which you use to create display objects. For example,
if you want to draw a rectangle, you click Rectangle.
Figure 4 Toolbox toolbar
Editing buttons
Button Description
Pointer. Selects, moves and resizes display objects.
Zoomer. Zooms in and of your display. To zoom in on a part of your

display, first click Zoomer and then click the area of interest. You can
zoom in further by clicking repeatedly.
To zoom out, hold down SHIFT and click.
Rotator. Rotates the selected rotatable object. See “Rotating display
objects” on page 42.
Object creation buttons
Button Description
Text. Creates text, such as the display’s title.
Line. Creates a straight line.
Freehand Line. Creates a freehand line which follows the path you trace
with the pointer.
Rectangle. Creates a rectangle or square.
Rounded Rectangle. Creates a rectangle or square with rounded

corners.
Oval. Creates an oval or circle.
21
Button Description
Polyline. Creates a multi-segment line (which are similar to polygons,
but with one open side).
To create a polyline, you click to mark each apex, except for the last.
You mark the last apex by double-clicking.
Polygon. Creates a polygon.
To create a polygon, you click to mark each apex, except for the last.
You mark the last apex by double-clicking, which then closes the
polygon.
Arc. Creates an arc (a quarter of an oval or circle).
Wedge. Creates a segment (quarter) of an oval or a circle.
Video. Creates a “window” for viewing video information.

(To display a video in Station, the computer requires a Microsoft Media
(MCI) compliant video overlay card. If there is no video card, the video
object appears as a colored rectangle.)
SafeBrowse. Creates a “window” for viewing a SafeBrowse® object. (A
SafeBrowse object is a Web browser specifically designed for use with
Station. See “Using SafeBrowse” on page 60.)
ActiveX Document. Creates a “window” for viewing an ActiveX
document. (This is any ActiveX-compliant document, such as a
Microsoft Excel spreadsheet or a Microsoft Word document.)
Alphanumeric. Used to display database values in many different
formats.
Push button. Creates a push button that users can click in an interactive
display. When clicked the specified command is performed.
Check box. Creates a check box so that users can select or clear an
option in an interactive display.
Combo box. Creates a combo box so that users can select from a list of
options in an interactive display.
Chart. Creates a chart (graph) that shows changes in values over time.
Scroll bar. Creates a scroll bar that users can operate in an interactive
display. See “About scrollbars” on page 99.
Indicator. Creates a “gauge” that indicates relative values. (Similar in
principal to a car’s fuel gauge.)
Alarm Line. Used to display alarms, delay or event conditions.
USING THE TOOLBARS
View toolbar
The View toolbar includes a range of editing buttons.
Figure 5 View toolbar
Button Description
Rulers. Shows/hides the rulers. The rulers make it easier to arrange
display objects in a neat and consistent manner. See “Setting the
display’s options” on page 64.
Grid. Shows/hides the grid. The grid makes it easier to arrange display
objects in a neat and consistent manner. See “Setting the display’s
options” on page 64.
Snap-to-Grid. Turns the “snap-to-grid” function on/off. When snap-to-
grid is active, objects automatically align to the grid when you create,
move or resize them.
Properties Window. Opens/closes the Properties Window. You use the
Properties Window to edit the characteristics of the selected object(s).
See “Using the Properties Window (DSP displays)” on page 47.
Script Editor. Opens/closes the Script Editor. You use the Script Editor
to write scripts—a script is a mini-program that performs a specific task.
See “Using the Script Editor” on page 142.
Scripts enable you to increase the sophistication of your displays, and
can vary widely in functionality and complexity. Anyone with minimal
programming skills can write simple scripts. Scripts are described in
detail in “Scripting reference” on page 131.
Shape Gallery. Opens/closes the Shape Gallery. The Shape Gallery
makes it easy to preview and add pre-built shapes to your displays. See
“Using the Shape Gallery” on page 57.
23
Arrange toolbar
The Arrange toolbar contains buttons for aligning and grouping display objects.
Figure 6 Arrange toolbar
Button Description
Bring To Front. Moves the selected object(s) to the “front” so that it is
not obscured by overlapping objects.
Send To Back. Moves the selected object(s) to the “back” where it is
obscured by overlapping objects.
See “Moving a display object to the front or back” on page 36.
Group. Groups the selected objects so that they become one object. If
necessary, you can “nest” grouped objects to create even more complex
display objects.
Ungroup. Splits a grouped object into its component objects.
See “Grouping display objects” on page 37.
Align Left. Moves the selected objects horizontally so that they are all
aligned to the left.
Align Center. Moves the selected objects horizontally so that their
centers are aligned.
Align Right. Moves the selected objects horizontally so that they are all
aligned to the right.
Align to Page Center. Moves the selected objects so that they are
centered on an imaginary line that runs vertically through the center of
the display.
See “Aligning display objects” on page 33.
Align Top. Moves the selected objects vertically so that they are all
aligned at the top edge.
Align Middle. Moves the selected objects vertically so their centers are
aligned.
Align Bottom. Moves the selected objects vertically so that they are all
aligned at the bottom edge.
Align to Page Middle. Moves the selected objects horizontally so that
they are centered on an imaginary line that runs horizontally through the
center of the display.
See “Aligning display objects” on page 33.
USING THE TOOLBARS
Button Description
Even Horizontal Spacing. Moves the selected objects (except the outer
two) horizontally so that they are spaced evenly. For example, if you
select three objects, the inner one will move left or right so that is
centered between the two outer ones.
Even Vertical Spacing. Moves the selected objects (except the top and
bottom ones) vertically so that they are spaced evenly. For example, if
you select three objects, the inner one will move up or down so that is
centered between the top and bottom ones.
See “Distributing display objects” on page 34.
Flip Horizontal. Flips the selected objects horizontally (as in a mirror
image).
Flip Vertical. Flips the selected objects vertically.
Rotate Left. Rotates the selected objects 90 degrees clockwise.
Rotate Right. Rotates the selected objects 90 degrees anti-clockwise.
See “Flipping display objects” on page 35.
Lock Objects Toggle. Locks/unlocks an object. Locking an object
protects it from being accidently moved or resized. See “Locking display
objects” on page 32.
25
Format Toolbar
The Format toolbar contains buttons for controlling the appearance of display
objects.
You can use Format buttons in two ways:
• If you click a button while one or more objects are selected, it only affects the
appearance of selected object(s).
• If you click a button while no object is selected, you change the display’s
default value (standard value), which is then used whenever you create new
objects in that display. See “Setting the defaults” on page 29.
Figure 7 Format toolbar
Button Description
Font. Sets the font of text. Note that you should only use fonts that are
loaded on every Station computer.
Font Size. Sets the size of text.
Bold, Italic and Underline. Change the text’s appearance.
Justify Left, Justify Center and Justify Right. Align lines of text
within a paragraph.
Line Color. Sets the line color of objects. When you click the button, a
palette opens from which you select the color. See “Selecting colors” on
page 44.
Fill Color. Sets the fill color of objects. When you click the button, a
palette opens from which you select the color. See “Selecting colors” on
page 44.
Line Style. Sets the line thickness.
Arrows. Sets the line-end style, such as arrows.
USING THE TOOLBARS
Button Description
Effects. Sets the “3D” effects of objects.
27
Basic drawing techniques

This section describes basic drawing techniques. Note that techniques are similar
to those used in other Windows-based drawing and paint programs.
You can access many commands using keyboard shortcuts—see “Keyboard
shortcuts” on page 282. You can also access many commands from the shortcut
menu—see “Using the shortcut menu” on page 283.
BASIC DRAWING TECHNIQUES
Setting the defaults

When drawing objects, you generally want most of them to have similar
characteristics, such as color, line thickness and font. The easiest way of ensuring
such uniformity is to set the default values, which Display Builder then uses when
you draw each new object.
Most toolbar buttons show their default settings. For example, if the default text
size has been set to 12 points, “12” appears in Font Size.
For example, to set the default colors to red line and yellow fill:
1 Make sure no object is selected. (If an object is selected, click a blank part of
the display, or choose Edit > Deselect All.)
2 Click Line Color to open the color palette.
Figure 8 The color palette
3 Click the red box.

The box sets the color to the display’s background color, and the box
sets the color to “transparent”.
4 Click Fill Color to open the color palette again.
5 Click the yellow box.
29
Creating a display object

To create a display object:
1 Click the appropriate button on Toolbox toolbar.
2 Drag the pointer diagonally over the display, and release the mouse button
when the dotted “outline rectangle” is the correct size and shape.
To create a square/round display object, hold down SHIFT while dragging.
Selecting display objects

When you select an object, a set of eight selection handles appears around the
object’s boundary. Having selected an object you manipulate it as required.
Figure 9 A selected display object
To select: Do this:
One object Click it.
Several objects Hold down SHIFT click each object.
Several objects, which are Drag the pointer diagonally across the objects. This
generally close together selects any object that falls entirely within the “selection
rectangle” which appears while dragging.
One object from a stack of Hold down CTRL and click repeatedly until the object
objects you want is selected. Each time you click, the next
object in the stack (starting from the top) is selected.
Do not click too quickly—if you do, your action will be
interpreted as a double-click.
All objects Choose Edit > Select All.
All objects linked to the Choose Edit > Select Dynamic.
database (dynamic objects)
All objects not linked to the Choose Edit > Select Static.
database (static objects)
No object Click a blank part of the display, or choose Edit >
Deselect All.
Deselecting display objects
To deselect: Do this:
All objects Click a blank part of the display. (If an object, such as a
“background bitmap”, covers the entire display, choose
Edit > Deselect All.)
One or more objects from a Hold down SHIFT and click each object you want to
group of selected objects deselect.
31
Locking display objects

Locking objects in place prevents them from being accidently moved or modified
with the mouse. (You can still move and resize locked objects by editing their size
and position properties in the Properties Window.)
To lock an object:
1 Select the object.
2 Click Lock Objects. Note how the selection handles turn grey to indicate that
the object is locked.
Figure 10 The selection handles of a locked object
To unlock a locked object, select it and then click Lock Objects a second time.
Aligning display objects

To align two or more display objects:
1 Select the display objects you want to align.
2 Click the appropriate Align button on the Arrange toolbar. For example, if you
want the left sides of the objects to be in line, click Align Left.
See “Arrange toolbar” on page 24 for a description of each of the Arrange
buttons.
33
Distributing display objects

To distribute three or more display objects:
1 Select the display objects you want to distribute.
2 Click Even Horizontal Spacing or Even Vertical Spacing on the Arrange
toolbar.
Flipping display objects

To flip one or more display objects:
1 Select the display objects you want to flip.
2 Click the appropriate Flip button on the Arrange toolbar. For example, if you
want to create a mirror-image, click Flip Horizontal.
If you want to flip the objects on their sides, click Rotate Left or Rotate Right.
35
Moving a display object to the front or back

When display objects overlap, you may need to change the order in which they
are “stacked” on top of each other, so that one object doesn’t obscure another.
To move display object(s) to the front or back of the stack:

1 Select the display objects you want move.
2 Click Bring to Front or Send to Back on the Arrange toolbar.
Grouping display objects

You can create a complex display object by creating a number of simple objects,
arranging them in an appropriate manner and then grouping them. If appropriate,
you can “nest” grouped objects to create even more complex display objects.
To group two or more display objects:

1 Select the display objects you want group.
2 Click Group on the Arrange toolbar.
To ungroup a grouped object, select it and then click Ungroup.
37
Resizing display objects

To resize one or more display objects:
1 Select the object(s). Their selection handles appear.
2 Drag one of the selection handles as required. The objects are resized as you
drag.
Tip If you want to retain the object proportions, hold down SHIFT and drag a
corner handle.
Duplicating display objects

To make duplicate copies of one or more display objects:
1 Select the display object(s) you want to duplicate.
2 Choose Edit > Duplicate. A copy of the selected object(s) appears near the
center of the display.
39
Deleting display objects

To delete one or more display objects:
1 Select the display object(s) you want to delete.
2 Choose Edit > Delete. (Alternatively, press DELETE.)
Editing display objects

You edit display objects by selecting them and then making the appropriate
changes in the Properties Window.
For example, to change the font of one or more alphanumerics to 12 point, bold:
1 Select the alphanumeric(s).
2 If necessary, open the Properties Window by clicking Properties Window on
the View toolbar.
3 Click the Font tab.
4 Select 12 from the Size property.
5 Select Bold from the Font style property.
For more information about the Properties Window, see “Using the Properties
Window (DSP displays)” on page 47.
41
Rotating display objects

You can rotate the following types of display objects. You can also rotate a group
if all objects in the group are rotatable.
Arc Metafile Rectangle JPEG

Bitmap Oval Rounded Rectangle TGA
Freehand Line Polygon Text
Line Polyline Wedge
You cannot rotate a shapelink if the associated shape contains any dynamic
objects. (Shapelinks are described in “Using shapes” on page 51.)
To rotate an object:
1 Click Rotator on the Toolbox toolbar.
2 Click the object you want to rotate.
Four rotation handles appear, as well as a rotation marker—this indicates the
point about which the object rotates.
Figure 11 The rotation marker and rotation handles
3 If you want to rotate the object about a specific point, drag the rotation marker
to that point—the point can even be outside the object.
4 Drag one of the rotation handles clockwise or anti-clockwise. As you drag the
handle, the object rotates about the rotation marker.
Moving display objects with the arrow keys

If you want to move an object a small distance—a technique called nudging—
you may find it easier to use the arrow keys than to use the mouse. Each time you
press an arrow key, the selected object(s) move a few pixels in the direction of the
arrow. If you hold down an arrow key, the selected object(s) move slowly in the
direction of the arrow.
43
Selecting colors
Note that a display object linked to the database can only use sixteen colors, these
being: white, gray, black, red, green, cyan, blue, magenta and yellow and their
low-intensity equivalents. If you select a non-standard color, the nearest standard
color will be used.
To select the line or fill color for the selected objects:

1 Click Line Color or Fill Color, as appropriate to open the color palette.
2 Click the appropriate color in the palette.
3 Alternatively, if you want to:
• Select a custom color, see “Selecting a custom color” on page 44.
• Remove the color, so that the line or fill becomes transparent, click the
box.
• Make the color the same as the display’s background color, click the
box.
Selecting a custom color
To select a custom line or fill or line color for the selected objects:
1 Click Line Color or Fill Color, as appropriate to open the color palette.
2 Click Other to open the Color dialog box.
Figure 12 The Color dialog box
3 Click the point in the “color spectrum” box that has the color you want.
There are two other ways of selecting a color. Either, type the HSL or RGB
values in the appropriate boxes, or drag the Color marker (the “x” in the color
spectrum box) and the Saturation marker on the Saturation scroll bar.
4 Click Add to Custom Colors so that the color appears in the next available
Custom colors box.
5 Click the custom color you have just created and then click OK.
45
Undoing the previous action

When creating a display, it is very easy to make mistakes. If you realize your
mistake immediately after making it, choose Edit > Undo to undo your last
action. (Alternatively, press CTRL+Z.)
USING THE PROPERTIES WINDOW (DSP DISPLAYS)
Using the Properties Window (DSP displays)

You use the Properties Window to view and edit the properties of the selected
display objects. (The properties include physical characteristics, such as color and
size, as well as database link details.)
You also use the Properties Window to view and edit the display’s properties—
these appear when no display objects are selected.
The Properties Window changes whenever you select another object. In the
following figures, the first example shows the window when you select an
alphanumeric, whereas the second example shows the window when you select a
chart.
Figure 13 Selecting a tab changes the Properties Window example 1
47
Figure 14 Selecting a tab changes the Properties Window example 2
The Properties Window is modeless, which means that the selected object(s)
change as soon as you change a property’s value. (Unlike a standard dialog box,
you do not have to click an OK button.)
Properties are grouped according to the tabs that run across the top of the window.
The following examples show how the window changes as you click the tabs.
Figure 15 Properties are grouped according to tab example 1
USING THE PROPERTIES WINDOW (DSP DISPLAYS)
Figure 16 Properties are grouped according to tab example 2
The Properties Window also changes if you:

• Select several display objects of the same type. Any properties whose values
are not identical are blanked or grayed out. For example, Name in the General
tab will be blank because each object has a unique name.
If you edit a property, you change all selected objects—for example, if you
change Fill Color to red, they will all turn red.
• Select display objects of various types, such as a push button and an
alphanumeric. In this case, the window only displays tabs that are shared by
all selected objects. For example, if you selected an alphanumeric and a push
button, you could change the properties on the Font tab because both objects
contain text.
• Deselect all objects. The Properties Window then shows the display’s
properties, and its title changes to “Display Properties”.
For a description of each property, see:
• “Defining display object properties” on page 75
• “Defining display and shape properties (DSP)” on page 117
49
Linking display objects to the database

A major feature of Display Builder that distinguishes it from a standard drawing
application is its ability to link display objects to the server database. Some types
of display object, such as alphanumerics and indicators, are specifically designed
for displaying database information.
You can link most types of display object to either a point parameter (such as the
point’s value) or to a database file, whose contents are controlled by an
application. For more information about linking objects to the database, see
“Defining display object properties” on page 75.
A display can have up to 300 database links.
USING SHAPES
Using shapes
A shape is, in effect, a “custom object” that is used in displays to present complex
dynamic data. Having created a shape, you can use it as many times as necessary,
including multiple times in the same display.
You add a shape to a display by inserting a shapelink that provides a link to the
shape. The shapelink controls the size and position of the shape in the display.
(Note that if you subsequently change a shape, the displays that include
shapelinks to it are automatically updated, except for size and position.)
There are two types of shape:
• Shape sequence
• Dynamic shape
51
Shape sequence
A shape sequence consists of a set of shapes that can be used as either a status
indicator, or as a simple animation.
Using a shape sequence as a status indicator

The following figure shows a shape sequence representing traffic light statuses.
Figure 17 A shape sequence
Amber
Red Green
When used in a display, the status of the associated point determines which of the
three shapes appears in the display. For, example, when the status is 0 (Stop) the
red octagon appears; and when the status changes to 1, the octagon disappears and
amber triangle appears.
Figure 18 Linking to a shape sequence
Display file
Shapelink
Amber
Shape file
Amber
Red Green
Using a shape sequence for an animation

A shape sequence can also be used in conjunction with a script to produce a
simple animation—in this case, each shape represents a separate “frame” in the
animation. For an example of a simple animation, see “Animation using a shape
sequence” on page 243.
USING SHAPES
Creating a shape sequence
Notes
• A shape sequence cannot contain any dynamic display objects, such as
alphanumerics and combo boxes.
• All objects that make up a shape must be grouped. In the above example, the
text “Green” and the circle are grouped to form one shape.
• If the shape sequence is to be used as a status indicator, you must create a
separate shape for each state.
• You must arrange the shapes (left-to-right/top-to-bottom) in the appropriate
order. In the case of a status indicator, the top-left shape corresponds to 0, the
next shape corresponds to 1, and so on. In the case of an animation, the top-
left shape represents the first frame, and so on.
To create a shape sequence:

1 Choose File > New > Shape Sequence to open a new display.
2 Draw the shapes as required.
Inserting a shape sequence into a display

Note that each time you insert a shape, you create a separate shapelink object. The
shapelink’s properties control the characteristics of that instance (copy) of the
shape.
To insert a shape sequence into a display:

1 Choose Edit > Insert Shapelink to open the Insert Shapelink dialog box.
2 Select the required shape file from the list of files. (If you click at the top
of the dialog box and then click at the bottom, the shapes in the selected
file are displayed sequentially.)
Alternatively, drag a shape from the Shape Gallery and drop it directly into the
display. See “Using the Shape Gallery” on page 57.
3 Move and resize the shapelink as required.
4 While the shapelink is selected, open the Properties Window and click the
Data tab.
5 Type the database link details. (If you are linking to a particular point
parameter, select Point/Parameter from Type of database link, and then
type the appropriate point and parameter details.)
6 Click the Animation tab and select Shape Sequence from Type of animation.
7 Type the number of shapes you want to use in Number of shapes. (A shape
file may contain more shapes than is required for a particular point/parameter.
53
If, for example, there are only four states but the shape file contains eight
shapes, type 4 to use the first four shapes.)
USING SHAPES
Dynamic shape
A dynamic shape can contain dynamic objects, such as alphanumerics, that are
designed to be linked to the database.
For example, you could create dynamic shape that represents a pump and contains
two alphanumerics which show the flow rate and pressure. Each time you insert
an instance of dynamic shape into a display, you assign the appropriate point
parameters to the two alphanumerics of that instance.
Creating a dynamic shape
Notes
• All objects in the dynamic shape must be grouped into one group.
To create a dynamic shape:

1 Choose File > New > Dynamic Shape to open a new dynamic shape.
2 Add the required display objects in the normal manner.
3 Open the Properties Window and for each dynamic object:
• Click the Data tab and clear the Point and Parameter properties.
• Click the General tab and give the object a suitable Name. An intuitive
name makes it much easier when you insert the shape into a display. For
example, if an alphanumeric is to represent a pump’s flow rate you might
name it FlowRate.)
Remember to group all objects before saving the shape.
Inserting a dynamic shape into a display

Note that each time you insert a shape, you create a separate shapelink object. The
shapelink’s properties control the characteristics of that instance (copy) of the
shape.
To insert to a dynamic shape to a display:

1 Choose Edit > Insert Shapelink to open the Insert Shapelink dialog box.
2 Select the required shape file from the list of files. (If you click at the top
of the dialog box and then click at the bottom, the shapes in the selected
file are displayed sequentially.)
Alternatively, drag a shape from the Shape Gallery and drop it directly into the
display. See “Using the Shape Gallery” on page 57.
3 Move and resize the shapelink as required.
55
4 While the shapelink is selected, open the Properties Window and click the
Data tab. This lists each of the dynamic objects in the shape.
5 Specify the appropriate point and parameter details for each object.
USING SHAPES
Using the Shape Gallery

The Shape Gallery makes it easy to preview and add pre-built shapes to your
displays. To open the Shape Gallery, click Shape Gallery in the View toolbar.
Note that you can only open the Shape Gallery if at least one display is open.
To preview a set of shapes:

1 Select the appropriate folder in the left-hand pane. A one-line summary of
each shape appears in the right-hand pane.
Figure 19 The Shape Gallery
2 If you want to preview each shape, click .

3 In you want to preview individual shapes in a shape sequence (No of shapes
is 2 or more), double-click it. (Alternatively, select the shape and click .)
To insert a shape into a display:

1 Drag it from the list and drop it into the display.
57
Registering shape folders

If your displays include shapes that are not in the same folder as the displays, you
must register those folders in the Shapelink Search Paths window. (If you don’t
do this, Display Builder will replace any shapes with place-markers the next time
you open a display.)
To register the folders:

1 Choose View > Shapelink Search Paths to open the Shapelink Search Paths
window.
2 Click to add a blank line to the list.
3 Either type the folder’s full path, or click and browse for the folder.
4 If necessary, use and to rearrange the order of folders in the list.
(Display Builder searches through the folders in the order listed.)
USING SHAPES
Using the supplied shape library

Display Builder is supplied with a library of pre-built shapes that you can include
in your displays. These shapes are stored in \ShapeLib, and are organized into
subfolders according to subject. (The \examples folder contains some example
displays built using the shape library.)
59
Using SafeBrowse
A SafeBrowse® object is a Web browser specifically designed for use with
Station.
SafeBrowse includes appropriate security features that prevent users from calling
up unauthorized Web pages or other documents in Station. For details about
restricting access, see the “Web access tab, Connection properties” topic in the
“Customizing Stations” section of the Server and Client Configuration Guide.
URL formats
The general format for the URL (Uniform Resource Locator) of a SafeBrowse
object is:
Protocol://ResourceName
Part Description
Protocol The protocol, which can be either http, ftp, gopher,
or file.
The default protocol is file. If the protocol is not
specified, Station assumes that the URL refers to a file,
either on the Station computer or on the network.
ResourceName The resource address or identifier, such as a file or Web
address. If the extension is not specified, Station
assumes that it is a display file.
Example The URL for a HTML file called “procedure.htm”, either:

file://c:\procs\procedure.htm
or
c:\procs\procedure.htm
The URL for a Web address:

http://www.ourwebsite.com
The URL for a Word file called “sp.doc”:

file://c:\procs\sp.doc
USING SAFEBROWSE
Linking to displays from HTML pages

If you create “full-page” HTML files for Station users, you can include
hyperlinks to displays—the specified display is called up when a user clicks a
link. (A HTML file is displayed in full-page mode when a user calls it up from the
Command Zone.)
The protocol for inserting a link to a display is http://station/. For example, to
add a link to a display called “pumps.dsp”:
<a href="http://station/pumps">Pump Summary</a>
Attention You cannot call up a display if the HTML page is displayed within a
SafeBrowse object.
61
Inserting graphics created by other applications

Inserting suitable graphics, such as digitized photographs or schematic drawings,
can enhance your displays.
Attention Inserting graphics—especially large ones—may affect Station’s

performance when the display is called up by an operator.
Display Builder supports the following graphic formats:
• Windows Bitmap (*.bmp)
• JPEG (*.jpg)
• Targa (*.tga)
• Metafile (*.wmf)
• Enhanced Metafile (*.emf)
To insert a graphic:
1 Choose Edit > Insert Picture to open the Insert Picture dialog box.
2 Select the graphic file you want to insert. If necessary, browse for the file,
restrict the list to the appropriate file type and preview the graphic in the right-
hand box.
3 Move, resize and group the graphic, like any other display object.
You can also paste a graphic from the clipboard. To do this, create your graphic in
a suitable application, copy it to the clipboard and then paste it into your display.
PASTING TEXT FROM ANOTHER APPLICATION
Pasting text from another application

You can paste text into your displays from other applications. For example, if you
want to include a large block of text in your display, you may find it easier to
compose it in a text editor or word processor.
Attention The characteristics of pasted text vary according to the application in

which it was written. For example, if you select several paragraphs from
Microsoft Word, they are pasted into your display as a metafile (a type of
graphic) which retains the original layout. However, if you select several
paragraphs from Windows Notepad, each paragraph is pasted into your
display as a separate text object, without word wrapping.
To paste text into a display:

1 Start Display Builder and open the display in which you want to paste the text.
2 Start the text editor or word processor and write the text.
3 Select the text.
4 Use the application’s Copy function to copy the text to the clipboard.
5 Select Display Builder, so that it is the active application.
6 Choose Edit > Paste.
7 Move, resize and group the text, like any other display object.
63
Setting the display’s options

A display has a number of options that make display creation easier.
To set a display’s options:

1 Choose View > Options to open the Options dialog box.
Figure 20 The Options dialog box
2 Set the options as required.
Option Description
Grid settings Specifies the spacing, style and color or grid lines.
The spacing is based on the display’s logical coordinates,
which range from 0, 0 (top, left) to 7999, 4399 (bottom,
right). The default spacing is 100 units.
For more information about logical coordinates, see “About
display coordinates” on page 241.
Page background color Sets the display’s background color in Display Builder. Note
that this does not affect the display when viewed in Station.
Show rulers Shows/hides the rulers. Note that you can change this by
clicking Rulers on the View toolbar.
Show grid Shows/hides the grid. Note that you can change this setting
by clicking Grid on the View toolbar.
Align objects to grid When selected objects automatically align to grid lines when
you create, move or resize them. Note that you can change
this setting by clicking Snap-to-Grid on the View toolbar.
WORKING WITH FILES
Working with files

In Display Builder, you create, save and open files in a similar manner to any
other Windows-based application. This section, however, describes tasks that are
specific to Display Builder files.
Display Builder uses a “.dsp” extension for displays and shape files.
65
Creating a new display or shape

To create a new display or shape, choose File > New and then the appropriate
type of file. A blank display appears.
Notes
• You cannot change the file’s type after creating it. For example, you cannot
change a shape sequence into a dynamic shape.
• For instructions specific to creating a dynamic shape, see “Creating a dynamic
shape” on page 55; for instructions specific to a shape sequence, see “Creating
a shape sequence” on page 53.
Defining the display’s properties

You must define the file’s properties, such as its title and type. For details, see
“Defining display and shape properties (DSP)” on page 117.
WORKING WITH FILES
Saving a new display or shape

When you save a display or shape for the first time, you specify:
Item Description
File name The display’s name or number. See “Named versus
numbered displays” on page 67.
Save as type The display’s format. (By default, Display Builder uses the
current format.)
You only need to select an earlier format if you are creating a
display for an earlier version Experion, or for an earlier
product. See “Saving displays in earlier formats” on
page 68.
Named versus numbered displays

In general, making a display numbered or named is simply a matter of choice.
Named displays
An advantage of a named display is that Station users can call up it up by typing
the display’s filename (without the extension) in the Command Zone. It is also
easier for users to remember an intuitive name like “overview” than a number
such as “309”.
Notes
• If you want to assign the display to a function key so that users can press the
key to call up the display, the filename must not be longer than 20 characters.
• If the filename only contains numbers, such as 1234.dsp, users must also
include the extension when calling up the display from the Command Line.
Numbered displays
A display must be numbered if:
• You want to configure the PAGE UP and PAGE DOWN keys so that they call
up the next/previous pages. Both the page for which you configure the keys
and the pages you call up must be numbered pages.
• You want the display listed in the Display Summary.
• An Algorithm (“algo”) references the display.
• The point cross-reference report references the display.
67
Page numbering for custom displays starts at 301. (Numbers 1 to 300 are reserved
for the system displays supplied with Experion.) The maximum page number
depends on system sizing, and available disk space.
Saving displays in earlier formats

If you are creating a display for an earlier release of Experion, or for an earlier
product, such as SCAN 3000 or XSM, you must select the appropriate format
from Save as type when saving the display for the first time.
Attention When saving a display in an earlier format, only features supported by that
format will be saved.
Save as type: Product release:

Release 320.3 Experion R300, Experion PKS R100, PlantScape R500, EBI
R200.2
Release 320.2 PlantScape R400/R320, EBI R200/R110
Release 320 EBI R100
Release 310 PlantScape R200/R130
Release 300 PlantScape R110, SCAN 3000 R620 (ActiveX edition), XFi
R620 (ActiveX edition), XSM R630
Release 230 XSM R610
Release 220 SCAN 3000 R620, XFi R620, XSM R550
Release 110 SCAN 3000 R530 (Unix), XFi R530, XSM R515
WORKING WITH FILES
Opening a file
To open an existing Display Builder file, choose File > Open and use the Open
dialog box to select the file you want to open.
Attention If you open a file saved in an earlier file format, Display Builder
automatically opens it in the current format. Having made the required
changes, you must therefore select the original format when saving it if you
want to retain the earlier file format.
Working with several files

If required, you can have up to ten files open simultaneously—a useful feature
when copying and pasting objects between displays and shape files.
69
Distributing and validating files

Having created your displays and shape files, you must perform the appropriate
distribution and validation tasks.
DISTRIBUTING AND VALIDATING FILES
Checking the validity of point IDs in remotely-built files

If you are working remotely—that is, you are creating displays and shape files on
a computer other than a server—you must check that the point IDs specified in
the file are valid.
One way of doing this is to copy the file to the appropriate server folder, open the
file using Display Builder on the server or network, and immediately save it. The
server generates an error message if there is any invalid point ID.
Another way is to use Display Builder’s command-line parameters. See “Using
Display Builder’s command-Line parameters” on page 287.
71
Distributing files
There are two storage techniques for displays and shape files:
• Centralized, where all files are stored centrally on the server, and accessed by
Stations as required.
• Distributed, where each Station has its own copies on a local folder. (This
storage technique reduces communication traffic and call-up delays because
Stations do not have to download display files before displaying them.)
To distribute files if you use centralized storage:

1 Copy the display and shape files to the appropriate “display” folder on the
server.
2 If you have any numbered displays, export them. See “Exporting numbered
displays” on page 73.
To distribute files if you use distributed storage:

1 Copy the display files to the appropriate server folder. (Shape files do not need
to be on the server.)
2 If you have any numbered displays, export them. See “Exporting numbered
displays” on page 73.
3 Copy the display and shape files to the appropriate “display” folder on each
Station computer that needs those files.
DISTRIBUTING AND VALIDATING FILES
Exporting numbered displays

You must export numbered displays so that the server can establish a link between
the page number and the filename.
If, when saving a numbered display in Display Builder, you save it to the
appropriate “display” folder on the server, the display is generally exported as
part of the saving process. A warning message appears if the display was not
exported. (Exporting is not possible if, for example, the server is down.)
To export a remotely-built display:

1 Copy the display file to the appropriate folder on the server.
2 Open the file using Display Builder on the server or network, and immediately
save it. The display is then exported as you save it.
73
Defining display object
properties 3
This chapter describes display object properties, which you access through the
Properties Window (described in “Using the Properties Window (DSP displays)”
on page 47).
If the Properties Window is not open, click Properties Window in the View
toolbar.
For details about this tab: Go to:

Animation page 76
Appearance page 78
Custom XY page 79
Data page 80
Details page 86
Font page 104
General page 105
Options page 106
Repeats page 108
X-Y Plot page 111
75
3 – DEFINING DISPLAY OBJECT PROPERTIES
Animation tab
The animation tab controls the correspondence between the object’s color and the
value or status of the associated point.
Figure 21 Animation tab
Property Description
Type of animation The type of animation used for the object:
• Color breakpoints. The color changes as the
value changes. You can specify up to nine colors and
the percentage range for which each color applies.
(For example, you could make an object turn red
when the value is between 90 and 100 percent of its
range.)
• Level fill. When the value is low, the color
applies to only the bottom part of the object; as the
value rises, the color rises to fill more of the object.
• Shape sequence. Only applicable to a shapelink.
Specifies the number of shapes in the shape sequence
you want to use. See “Inserting a shape sequence into
a display” on page 53.
Note that the Details properties change in accordance
with the selected type of animation.
ANIMATION TAB
Details These properties change in accordance with the option
selected in Type of animation.
Type of breakpoint specifies how the color changes:
• Continuous. (Only applicable to analog values.)
The color changes as the value changes. You can
specify up to nine colors and the percentage range for
which each color applies. (For example, you could
make an object turn red when the value is between 90
and 100 percent of its range.)
• Discrete. The color changes as the state changes.
You define a separate color for each state. Select
Inverse if you want to animate the fill color rather
than the line color—this produces a “reverse video”
effect, which makes text stand out providing you
have selected an appropriate color scheme.
Indicate alarm state with color Station overrides the current color with the system-
defined colors during alarm or off scan states. (The
system-defined colors are specified in “System-defined
colors” on page 77.)
Not applicable if you select the Shape sequence option.
System-defined colors
Point state System-defined color

In alarm and unacknowledged Red and blinking
In alarm and acknowledged Red
Returned to normal but alarm not acknowledged Normal color, but blinking
Point off scan (scanning disabled) White
77
Appearance tab
The Appearance tab controls the object’s overall appearance, such as its fill color
and line thickness.
Figure 22 Appearance tab
Colors These properties control the object’s line and fill colors.
Lines These properties control the line characteristics, such as
dashed lines and arrows at line ends.
CUSTOM XY TAB
Custom XY tab
Not applicable to Experion.
79
Data tab
The Data tab specifies the object’s link to the database. The Type of database
link property specifies the type of link:
• Point/Parameter. The object is linked to a point parameter. See “Defining a
link to a point” on page 81.
• Database file. The object is linked to a file in the server database, whose
contents are controlled by another application. See “Defining a link to a
database file” on page 83.
• None. The object has no link to the database. See “Using local display objects”
on page 85.
DATA TAB
Defining a link to a point

When defining a link to a point, you specify the point and the appropriate
parameter. (Each point has a number of parameters associated with it, such as
field values and configuration details. For details about points and their
parameters, see the “Points” section of the Server and Client Configuration
Guide.)
Figure 23 Data tab—linking to a point
Point The ID of the point to which the object is linked.
If you are working remotely—not on a server—type the
point’s ID. (When the display is finalized, you should
check that the IDs are valid—see “Checking the validity
of point IDs in remotely-built files” on page 71.)
If you are creating the display on a server, you can
normally select the ID from the list. (However, in a
multi-server system, the server you are working on may
not know of the existence of every point in the system.)
Parameter The point parameter to which the object is linked.
If you select a history parameter, such as H24H, History
offset controls which history value is used. (0, the
default, represents the latest history value, 1 represents
the second-to-last value, and so on.)
81
Data entry allowed Allows users to edit the object’s value. (See “About the
Value Property” on page 163.)
If you select Data entry allowed, Security Level
appears, from which you select the appropriate level.
(Only users with the specified level, or higher, can enter
data.)
DATA TAB
Defining a link to a database file

For details about database (user) files, see the Application Development Guide.
Figure 24 Data tab—linking to a database file
File The number of the file to which the object is linked.
Select the indexing option from the list opposite:
• No indexing.
• Indexed by file offset. Adds Station’s current
file offset to the file number. The offset can be set by
scrollbars, by the host and by the PAGE UP and
PAGE DOWN keys.
83
Record The number of the record within the file. Select the
indexing option from the list opposite:
• No indexing.
• Indexed by record offset. Adds Station’s
current record offset to the record number. The offset
can be set by scrollbars, by the server and by the
PAGE UP and PAGE DOWN keys.
• Indexed by field offset. Adds Station’s
current field offset to the word number. The offset
• Indexed by Station no. Each Station uses
separate records in the user file. The effect is to view
the User file as a series of logical files, one for each
Station. Set the record and word numbers as normal;
for example, if you want the link to refer to the
second record for each Station, set Record to 2.
Word The word number within the file. Select the indexing
option from the list opposite:
• No indexing.
• Indexed by field offset. Adds Station’s
current field offset to the word number. The offset
Format The data format.
If you select String, you must specify the length of the
string.
If you select Bits, you must specify the starting bit and
the number of bits within the word.
Read from oldest record of Applicable if it is a circular file and you want to read the
circular file oldest record first.
Data entry allowed Applicable only to a text object. Allows users to edit
Security level currently displayed text.
If you select Data entry allowed, you must also select a
Security level. (Only users with the selected level, or
higher, can enter data.)
DATA TAB
Using local display objects

Instead of linking a display object to the database, you can use it as an input or
output for a script. Such display objects are known as local objects because they
are not linked to the database.
For example, you could configure a scrollbar as a user-input control for a script—
see “Using a scrollbar to set a value” on page 100.
You make a display object local by setting the Type of database link property to
none.
85
Details tab
The Details tab contains properties that are specific to each type of object.
For details about this type of object: Go to:

ActiveX Document page 87
Alarm Line page 88
Alphanumeric page 89
Chart page 91
Checkbox page 92
Combobox page 93
Indicator page 95
Pushbutton page 96
SafeBrowse page 98
Scrollbar page 99
Text page 103
DETAILS TAB
ActiveX document object
Figure 25 Details tab for a ActiveX object
File Name The URL (Uniform Resource Locator) of the document
that you want to display. If necessary, find the document
by clicking Browse.
87
Alarm Line object
Figure 26 Details tab for an Alarm Line
Type The type of message the object displays, such as alarm
or event.
Alarm priorities displayed Only messages with the specified priorities are
displayed.
DETAILS TAB
Alphanumeric object
Figure 27 Details tab for an alphanumeric object
Display as These properties specify how the point parameter
Details information is displayed. See “Alphanumeric display
options” on page 89.
Number of characters The maximum number of characters that can be
displayed displayed.
Word wrap Selecting Word wrap allows the value (normally text)
to appear over several lines, where it is longer than the
object’s width.
Local edit Indicates that when a user edits the object’s value, the
edited value is stored locally, rather than being sent to
the server. Also, pressing ENTER inserts carriage
returns, instead of sending the contents to the server.
In practice, this option is only used for the “message
object” on the message pad system display.
Alphanumeric display options
Display As option Description

Numeric Displays the value as a number. If you clear Floating
decimal point, you must type the number of decimals
you want to display in Number of decimals.
89

State Descriptor Applicable to a status point. Displays the state descriptor
corresponding to the point’s status.
Text Applicable if the value is a text string. (255 characters
maximum.)
Acronym Displays an acronym, which is based on the point’s
(integer) value.
If you want to learn about acronyms, see “About
acronyms” on page 112.
To select a set of acronyms from:
• The default acronym file, see “Selecting default
• A custom acronym file, see “Selecting custom
Date Applicable if the value is a date in Julian format.
Time Applicable if the value represents time. If the value is an
integer, then it is assumed to represent minutes after
midnight. If it is a real number, it is assumed to represent
seconds after midnight.
Specify the number of characters you want to display in
Decimals.
Hexadecimal Applicable if you want to display the value in
hexadecimal format.
Source Address Applicable if the value is the point’s source address.
This option is generally only used by Honeywell
personnel.
Destination Address Applicable if the value is the point’s destination address.
This option is generally only used by Honeywell
personnel.
Parameter of given point Applicable if the value is a point number in a user file.
Select the parameter you want to display from the field
opposite.
State descriptor of point at Applicable if the value is a state descriptor of a point in a
word user file, with the Point ID at the word specified in the
field opposite. This option is generally only used by
Honeywell personnel.
Parameter name of point at Applicable if the value is a parameter name of a point in
word a user file, with the Point ID at the word specified in the
field opposite. This option is generally only used by
DETAILS TAB
Chart object
Figure 28 Details tab for a chart object
Plot You can simultaneously display the values of up to eight
points, depending on the type of chart you have selected
in the Chart type property on the Options tab.
Point ID The IDs of the points whose values you want to display.
Parameter The point parameter(s) whose values you want to
display.
Color The color used to display the values of the associated
point on the chart.
91
Checkbox object
Figure 29 Details tab for a checkbox object
Label The descriptive text that appears to the right of the
checkbox.
Use inverse logic Reverses the standard checkbox logic, so that it
corresponds to the wording of Label. (In standard logic,
checked equals “1”.)
For example, labelling a checkbox “Open” would
require the opposite logic to labelling it “Close”.
DETAILS TAB
Combobox object
Figure 30 Details tab for a combobox object
Display as Specifies how the object is animated. See “Selecting the
Details display options for a combobox object” on page 93.
Sort alphabetically Alphabetically sorts the items in the list.
Selecting the display options for a combobox object

State Descriptor Displays the defined states of the selected point as
entries in the combobox’s list.
Acronym Displays an acronym, based on the point’s state.
If you want to learn about acronyms, see “About
To select a set of acronyms from:
• The default acronym file, see “Selecting default
• A custom acronym file, see “Selecting custom
93

Parameter name of point at Only applicable if the value is a parameter name of a
word point in a user file, with the Point ID at the word
specified in the field opposite. This option is generally
only used by Honeywell personnel.
DETAILS TAB
Indicator object
Figure 31 Details tab for an indicator object
Display as Specifies how the object is animated. See “Selecting the
display options for an indicator object” on page 95.
Orientation Specifies whether the indicator moves vertically or
horizontally.
Level fill color The color of the bar or pointer.
Selecting the display options for an indicator object
Display as option Description

Bar A colored bar of variable height within the object
indicates the relative value.
Pointer A colored pointer moves up and down within the object
to indicate the relative value.
95
Pushbutton object
Figure 32 Details tab for a pushbutton object
Label The pushbutton’s label.
Action The action performed when a user clicks the pushbutton.
Details See “Defining a pushbutton’s action” on page 96.
Defining a pushbutton’s action
Select this action: To do this:

Callup Page Call up the specified display or Web page.
If you specify a Web page, you must ensure that it does
not conflict with the Web access restrictions specified in
Station. For details, see the “Web access tab, Connection
properties” topic in the “Customizing Stations” section
of the Server and Client Configuration Guide.
Request Report Request the specified report.
Request Task Perform the task associated with the specified task LRN.
In addition to specifying a task LRN, you must also
specify:
• Appropriate values for the task parameters
• The security level required to perform the task
DETAILS TAB
Select this action: To do this:

Menu Tag Perform the menu command selected from the list of
menu commands.
Launch Application Launch the specified application. Either type the
application’s name in Application, or click the button
opposite to navigate through the folder structure and
find the executable.
97
SafeBrowse object
Figure 33 Details tab for a SafeBrowse object
URL The URL (Uniform Resource Locator) of the document
that is displayed in the browser object. See “Using
SafeBrowse” on page 60.
DETAILS TAB
Scrollbar object
For an introduction to scrollbars, see “About scrollbars” on page 99.
Figure 34 Details tab for a scrollbar object
Minimum, Maximum, Range These parameters specify the range and other
visible and File number characteristics of the scrollbar. See “Defining the
scrollbar range” on page 102.
Minimum at bottom/right Specifies which end of the scrollbar represents the
minimum value. If not selected, the minimum value is at
the top or left end, depending on the scrollbar’s
orientation.
About scrollbars
Scrollbars can control:
• A value in the server database. For example, you could use a scrollbar to
control the value of a set point.
• A value in a script.
• An offset to a record or field for the display. Used in this way, the scrollbar
controls any other display objects that use the offset.
99
Using a scrollbar to set a value

The following figure shows how to use a scrollbar to set a value in the server
database (or in a script). When a user moves the scroll box up or down, the value
varies accordingly between the minimum and maximum values.
Figure 35 Setting the value with a scrollbar
Maximum value
Sets the value
Minimum value
Using a scrollbar to control the offset

The following figure shows how to use a scrollbar to display the contents of
records in a large file. The alphanumerics are configured so they display five
adjacent records. (In practice, you would create one alphanumeric, and use the
Repeat function to create the “clones” and specify their relative offsets.)
When a user moves the scroll box up or down, the display offset changes and the
contents of the alphanumerics change accordingly. In this example, the
alphanumerics display the values of records 3443 to 3446.
DETAILS TAB
Figure 36 Controlling the offset with a scrollbar
Relative offset Alphanumerics

Records
0 9434.53
3441 1027.05
+1 84535.55
3442 1324234.98
+2 4249.84
3443 9434.53
+3 234.07
3444 84535.55
3445 4249.84
3446 234.07
3447 83449.23
3448 7559.45
Selecting the control option

The value you select from Type of database link on the Data tab determines
what the scrollbar controls.
Value Description
Record Offset Controls the current record offset for the display. See
“Using a scrollbar to control the offset” on page 100.
When a user moves the scroll box, the current record
offset changes. This affects any other objects in the
display for which Indexed by record offset is
selected on the Data tab—see “Defining a link to a
Field Offset Controls the current field offset for the display. See
“Using a scrollbar to control the offset” on page 100.
When a user moves the scroll box, the current field
offset changes This affects any other objects in the
display for which Indexed by field offset is
selected on the Data tab—see “Defining a link to a
Database File or Controls a value in the database. See “Using a scrollbar
Point/Parameter to set a value” on page 100.
101
Defining the scrollbar range

The Range properties specify the scrollbar’s range and other scrolling
characteristics.
Item Description
Minimum The minimum value that the scrollbar can scroll to.
If you select Point/Parameter or Database file
from Type of database link on the Data tab, this
property is ignored and the minimum database value is
used.
Maximum The maximum value that the scrollbar can scroll to.
If you select Record Offset or Field Offset from
Type of database link on the Data tab, and want to
access all records or fields, set the value to 0. If you
select Point/Parameter or Database file, this
property is ignored and the maximum database value is
used.
Range visible Controls the relative width of the scroll box, with respect
to the total length of the scrollbar. For example, if you
set Maximum to 100, Minimum to 0, and Range
visible to 20, the scroll box will be one fifth the length of
the scrollbar.
File number Only applicable if you select Record Offset or Field
Offset from Type of database link on the Data tab.
Specifies the file whose record or field the scrollbar is
offsetting.
DETAILS TAB
Text object
Figure 37 Details tab for a text object
Label The text that appears in the display.
103
Font tab
The font tab controls the appearance of the object’s text, such as the font and
point size.
Figure 38 Font tab
Font Text is displayed in the selected font. Note that you
should select fonts with care, and only use fonts that are
suitable for computer displays.
Size The text size, expressed in points.
Style The text style, such as italics.
Justify The horizontal alignment of text within the object.
Effects Strikeout draws a line through the text and Underline
draws a line under it.
GENERAL TAB
General tab
The General tab controls the object’s position and size.
Figure 39 General tab
Name The object’s name. You use this name when referring to
the object in scripts.
Position The object’s position and size, expressed in logical units.
(For a description of logical units, see “About display
coordinates” on page 241).
Rotation Angle indicates the clockwise angle through which the
object has been rotated.
The Center properties indicate the logical coordinates of
the point about which the object has been rotated.
Visible Indicates that the object is visible in Station.
Note that you can use an invisible object as a
placeholder for information, so that it can be accessed by
scripts.
Tab stop Allows users to “select” the object by pressing TAN.
If you enable Tab stop for several objects in a display,
the tabbing order progresses from left-to-right and top-
to-bottom.
105
Options tab
The Options tab is only applicable to a chart object, and controls its major
characteristics, such as its type (line, pie and so on) and the rate at which it plots
new values.
Figure 40 Options tab for a chart object
Chart type The type of chart—see “Selecting the type of chart” on
page 107.
Axis Specifies the colors used for the legend text and its
background.
History type The interval between samples.
Samples The number of samples you want to display, between 1
and 1000. The default is 61. Note that the larger the
number of samples, the heavier the load on the server
and the longer the time required to update the chart.
Units Specifies whether samples are displayed as percentage
values or as engineering units.
OPTIONS TAB
Selecting the type of chart

Bar Trend Displays successive values of one point as a bar chart.
Line Trend Displays the values of up to eight points as lines.
Numeric Trend Displays the values of up to eight points as numbers.
Type the number of decimals you want to display in
Decimals, and the required number of columns in
Columns.
Tuning Trend Displays a line trend of a point’s real-time values, and its
SP and OP parameters.
Pie Chart Displays the values of up to eight points as segments of
a pie chart.
X-Y Plot Plots the successive values of one point against another.
If you select this option, the XY plot tab appears. See
“XY Plot tab” on page 111.
Custom X-Y Plot Not applicable to Experion.
107
Repeats tab
The Repeats tab reduces the amount of work required when creating repetitive
displays. For example, if you wanted to create a list of point values, you would
create only one alphanumeric object and use the Repeat tab to create all the other
objects. You can also specify the relative position of each repeated object, as well
as the relative address of each point.
Note that repeated objects are created as a group.
Figure 41 Repeats tab
Number The number of objects you want.
Orientation Determines whether repeated objects appear either
below or to the right of the original object.
Spacing The inter-object spacing, expressed in logical units. (For
a description of logical units, see “About display
coordinates” on page 241.)
REPEATS TAB
Increment The increment option:
• Point ID. Increments the point ID, starting from the
ID specified in the original display object.
• Parameter. Increments the point parameter for the
point ID specified in the original display object.
• History offset. Increments the history offset.
Only applicable to history parameters.
• Value. Only applicable for alphanumerics. Used to
create a sequence of numbers. See “Repeating a
numeric value” on page 109.
• File, Record and Field. Only applicable if the
original display object is linked to a user file.
Increments the specified option. For example, the
Record option, increments the record number.
• Parameter 1 to Parameter 4. Only applicable for
pushbuttons. Specifies which task request parameter
is incremented.
Repeating a numeric value

You can create a sequence of numbers (1, 2, 3 and so on) using repeated
alphanumerics. Each repeated alphanumeric shows the display’s current offset,
plus its sequence number.
This technique is typically used, in conjunction with a scrollbar, to show the
record numbers of a table. In the following figure, the first column of repeated
alphanumerics shows the record number and the next column of repeated
alphanumerics shows the contents of the corresponding records.
109
Figure 42 Using a scrollbar to control a list
To create the alphanumerics for this example:

1 Create the original alphanumeric.
2 Open the Properties Window and click the Data tab.
3 Set the properties as follows.
Property Value
Type of database link Database file
File 2
Record 1 and Indexed by Station no.
Word 253
Format Integer 4
4 Click the Repeats tab.

5 Select Value from Increment.
6 Set the remaining repeat properties as required.
XY PLOT TAB
XY Plot tab
The XY Plot tab only appears when you select X-Y Plot from Chart Type on the
Options tab.
Figure 43 Options tab for a chart object
Range The minimum and maximum percentage values of the X
and Y axes.
Marker The type of marker used in the graph:
• Circles mark successive plot values.
• Line draws vertical and horizontal lines that
intersect at the current plot value.
• Graph draws a line.
Use historical data Only applicable if you select the Graph option from
Marker. Specifies whether to use historical data, or
only to plot new samples while the chart is displayed.
111
About acronyms
An acronym describes the meaning of a parameter’s state (or integer value). For
example, the acronyms “Stopped” and “Running” are much more meaningful in
displays than the raw parameter values “0” and “1”.
The default acronym file contains acronyms suitable for most purposes.
Acronyms in this file are divided into two ranges:
• System. These are supplied with Experion, and include commonly required
acronyms. System acronyms are stored in records 1 to 2048.
• User. These records are initially blank, so that you can define your own
acronyms as required. User acronyms are stored in records 2881 to 3880.
You define user acronyms in Station by selecting Configure > Acronyms > User.
The following figure shows how acronyms are stored in the default acronym file.
Related acronyms are stored as contiguous records in the order corresponding to
the parameter values. For example, “Closed” (record 3342) represents 0, and
“Open” (record 3343) represents 1.
To select a set of acronyms, you specify the starting record, as well as the number
of records you require. For example, if you wanted to use Stopped, Slow, Medium
and Fast, you would set the starting record to 3444 and the number of records to
4.
Figure 44 Storing related acronyms in contiguous records
3441 ...
3442 Closed
3443 Open
3444 Stopped
3445 Slow
3446 Medium
3447 Fast
3448 ...
If the default acronym file is not sufficient for your needs, create your own
acronym files—see “Using custom acronyms” on page 114.
ABOUT ACRONYMS
Selecting default acronyms

To select a set of default acronyms:
1 Select Acronym in Display as and Default file in Source.
2 Specify the appropriate value for each property.
Figure 45 Selecting default acronyms
Start at acronym The record that contains the first acronym.
System acronyms are stored in records 1 to 2048, and
user-defined acronyms are stored in records 2881 to
3880.
Number of acronyms The number of acronyms you want to use.
Preview If you are on the server, and you press TAB, the selected
acronyms appear in this box.
113
Using custom acronyms

If the default acronym file is inadequate for your needs, create your own custom
acronym files. The main advantage of a custom acronym file is that you can
define acronyms that are more than 10 characters long.
Creating and using a custom acronym file is a complex process that involves the
following tasks.
Task: Go to:
Create a custom acronym file with the correct size and format. page 114
Create a Custom Acronyms display. (Functionally, this display is identical page 114
to the standard acronym displays used to manage the system/user acronyms
in the default acronym file.)
Add the Custom Acronym display to Station’s Acronyms menu page 115
Define the acronyms, in Station, using the display page 115
Assign custom acronyms to display objects page 115
Creating a custom acronym file

You use the command-line utility utbbld, to create custom acronym files. For
details, see the Application Development Guide.
For example, if you wanted to create a file that can hold 1000 acronyms, with a
20-character limit, you would specify a file with 1000 records and 10 words per
record. (Each 16-bit word holds 2 characters.)
Creating a custom acronym display

You must create one or more custom acronym displays that are functionally
identical to the standard acronym displays. (Note that each tab on the standard
acronyms display is actually a separate display, with its own filename.)
The easiest solution is to copy a standard acronym display (such as sys154.dsp)
and modify it as required.
To create a custom acronym display:

1 Open a standard acronym display.
2 Select File > Save As and specify a suitable filename.
3 Modify the layout as appropriate. For example, change the title and increase
the width of the alphanumerics that are used for entering acronyms.
If your acronyms are up to 20 characters long, you must halve the number of
columns in the original display.
4 Click the first alphanumeric and open the Properties Window.
ABOUT ACRONYMS
5 Click the Data tab.
Figure 46 Acronym dialog box
6 Type the file number of the custom acronym file in File.

7 Specify the values, in accordance with the structure of the file.
8 Click the Details tab and type the maximum acronym length in Number of
characters displayed.
Adding the custom acronym display to the Station menu

When you have created the custom acronym display(s), you need to make them
easily accessible in Station by adding it to the Acronym menu.
Defining acronyms in a custom file

Having added the custom acronym display(s) to Station’s Acronym menu, you
define custom acronyms in the same way as you define acronyms in the default
file.
Selecting custom acronyms
To select a set of default acronyms:

1 Select Acronym in Display as and User file in Source.
2 Specify the appropriate value for each property.
115
Figure 47 Selecting custom acronyms
File The file that contains the custom acronyms.
Start at record The record that contains the first acronym.
Number of acronyms The number of acronyms you want to use.
Start at word The word that contains the first acronym.
Length of acronyms The length of the acronyms.
Location Specifies how the acronyms are stored within the file:
• Consecutive records
• Single record, where the acronyms are stored in
consecutive words with the same record.
Preview If you are on the server, and you press TAB, the selected
acronyms appear in this box.
Defining display and shape
properties (DSP) 4
If the Properties Window is not open, choose File > Properties. If the Properties
Window is open, but one or more objects is selected, choose Edit > Deselect All.
For details about this tab: Go to:

General tab for a display page 118
Details tab for a display page 119
Keys tab for a display page 122
Callup Task tab for a display page 123
Periodic Task tab for a display page 124
Help tab for a display page 125
General tab for a shape file page 129
117
4 – DEFINING DISPLAY AND SHAPE PROPERTIES (DSP)
General tab for a (DSP) display
Title The display’s title that appears in the Station Title Bar
(and in the Display Summary display if it is a numbered
display).
Description Any notes or comments about the display.
DETAILS TAB FOR A (DSP) DISPLAY
Details tab for a (DSP) display
Type Specifies the display’s type. Select Standard, the
default, unless you are creating a special-purpose
display.
Select Point Detail if you are creating a point detail
display for a new type of point. See “Creating a point
detail display” on page 284.
The other display types are generally only used by
Zooming allowed If this check box is cleared, operators cannot zoom in/
out on the display.
Single use application set Only applicable if the display is to be used by a multi-
window Station.
An application set consists of two or more related
displays that must never be simultaneously displayed.
The name of each application set must be unique.
SafeView window category Only applicable if the display is to be used in
conjunction with SafeView.
The window category, which determines how SafeView
handles the display. The standard categories are:
• HW_System_Alarm_Summary. The Alarm
Summary.
• HW_System_Detail. A point detail display.
• HW_System_Faceplate. A faceplate.
• HW_System_Group. A group display.
• HW_System_Trend. A trend.
• HW_System_Display. A system display other than
the above categories.
Alternatively, type the name of the user-defined
category.
Allow callup for Specifies the asset assignment required to call up the
display. See “Restricting page callup” on page 121.
Refresh rate By default, Station updates all displays at a standard
rate, typically once every five seconds. This option
allows you to specify a slower rate for the display. (If the
display is particularly complex, slowing the refresh rate
will reduce the load on the system.)
119
Previous display idle timeout Station displays the previous display if there has been no
user activity for the specified period.
Numbered display Used to create a numbered display. The reasons for
creating a numbered display are described in “Named
versus numbered displays” on page 67.
If you select Numbered display, you type the page
number in the opposite box which is revealed.
DETAILS TAB FOR A (DSP) DISPLAY
Restricting page callup

This topic is only applicable if assets have been defined for your system. For
details about assets, see the Server and Client Planning Guide.
Callup option Description

All areas The default selection, which does not restrict access to
the display.
Only area Restricts access to the specified asset.
Only area defined by Restricts access to the asset specified by the file/word
File combination. (In general, these fields are used only by
Honeywell.)
Word
121
Keys tab for a (DSP) display

You can assign a range of common commands to the PAGE UP, PAGE DOWN
keys, as well as the softkeys. (A softkey is a function key whose action is defined
for each page rather than being fixed for the Station. For details about configuring
softkeys, see the topic “Connection Properties” in the Configuration Guide.)
Key A key and the associated action it performs when
Action pressed.
To assign an action to a key, select the key from the list
and then the action. Repeat for each key as required.
Enable application control keys Not applicable to Experion.
CALLUP TASK TAB FOR A (DSP) DISPLAY
Callup Task tab for a (DSP) display

The Callup Task tab specifies the task that is performed whenever the display is
called up. (A task is any of the standard server programs or an application
program.)
Notes
• Do not call up a periodic task in the Callup Task properties of a display. If
you want to perform the task at regular intervals while the display is visible,
use the Periodic Task tab.
• Do not call up the Server Display Program (LRN 21) task in the Callup Task
properties of a display. It does not make sense to call up another page on
display callup.
• For more information about displaying the LRN assigned to an application
program, see the Application Development Guide.
Request task on page callup Select this to specify a callup task.
Details The task details, including its LRN (task identifier),
parameters and the security level required to perform the
task.
Attention DEPRECATED. The use of the following
option is provided only for legacy systems
which may have made use of this functionality.
The recommended method is to use
multithreading instead of Station offsets.
If you select Add station number offset to LRN, a
separate task is performed on each Station. (The number
of the task performed on a particular Station is equal to
the sum of the specified LRN and the Station’s number.)
123
Periodic Task tab for a (DSP) display

The Periodic Task tab specifies the task that is performed at regular intervals
while the display is visible. (A task is any of the standard server programs or an
application program.)
For details about the Server Display Program (also known as “LRN 21”), see the
Configuration Guide. For details about application programs, see the Application
Development Guide.
Request task periodically Select this to specify a periodic task.
Details The task details, including its LRN (task identifier),
parameters and the security level required to perform the
task.
Attention DEPRECATED. The use of the following
option is provided only for legacy systems
which may have made use of this functionality.
The recommended method is to use
multithreading instead of Station offsets.
If you select Add station number offset to LRN, a
separate task is performed on each Station. (The number
of the task performed on a particular Station is equal to
the sum of the specified LRN and the Station’s number.)
Request every The request interval, specified in display update
intervals. (By default, Station updates all displays at the
same rate, typically every five seconds. However, you
can specify a longer interval in Refresh rate on the
General tab.)
HELP TAB FOR A (DSP) DISPLAY
Help tab for a (DSP) display

The Help tab specifies the help associated with the display. Station users can call
up the help by pressing the help key or selecting a menu item. (Each Station must
be configured so that users can assess the help. For details, see the topic
“Connection Properties” in the Configuration Guide.
The help can be either:
• A topic within a HTML Help file (which has a chm extension)—see
“Assigning an HTML Help topic (to a DSP display)” on page 126
• A document, such as a HTML file or a Microsoft Word document—see
“Assigning a help document (to a DSP display)” on page 128
125
Assigning an HTML Help topic (to a DSP display)

If you have an HTML Help compiled help module (.CHM), you can assign one of
its topics to a display by specifying either the help topic number or internal
filename.
(You can create HTML Help using a variety of help authoring tools, including
Microsoft HTML Help Workshop, which you can download from Microsoft’s
Web site.)
Figure 48 Help tab for a display—specifying a HTML Help topic by its number
Help file name The HTML Help filename, including its chm extension.
If the file is not in one of Station’s display folders, you
must include the full path.
Help file type Automatically set to HTML Help when you specify the
filename’s chm extension.
HELP TAB FOR A (DSP) DISPLAY
Help Topic The help topic associated with the display.
To specify the topic’s internal filename, set
Locate topic by to Topic file and specify the
filename of the topic in Topic file.
To specify the topic’s number, set Locate topic by to
Topic number and specify the number in
Topic number.
127
Assigning a help document (to a DSP display)

You can assign any document, such as a HTML file or Microsoft Word document.
Figure 49 Help tab for a display—specifying a help document other than an HTML Help file
Help file name The filename of the document, including its extension.
If the file is not in one of Station’s display folders, you
must include the full path.
Help file type Automatically set to Document if its extension is not
chm.
GENERAL TAB FOR A SHAPE FILE
General tab for a shape file

Some properties are specific to a particular type of shape. For example, Use first
shape for bad value is only applicable to a shape sequence.
Figure 50 General tab for a shape file
Title The title of the shape file.
Description Any notes or comments about the shape.
Numbered shape Not applicable to Experion.
Use first shape for bad value Only applicable to a shape sequence. If selected, Station
displays the first shape if the associated point no longer
exists.
129
Scripting reference
5
This chapter describes how to enhance the functionality of your displays with
display scripts. (A script is a mini-program that performs a specific task.)
131
5 – SCRIPTING REFERENCE
Scripting basics
This section introduces you to the various features and rules that are applicable to
writing DSP display scripts for use with Display Builder (and not HTM display
scripts as used with HMIWeb Display Builder).
You write DSP display scripts in VBScript, a popular scripting language, which
does not require extensive programming skills and is relatively easy to use.
Select Help > VBScript Reference to display the VBScript Language Reference,
which is installed with Display Builder.
Attention The use of the plain term “script” in the Display Building Guide refers to
VBScript only, unless suitably qualified.
VBScript language is case insensitive, so objects such as “application” are
interpreted the same as “Application”, “APPLICATION” or “ApLiCaTiOn”.
VBScript in interpreted line-by-line. Each command instruction must be written
on a separate line. The line-break signifies the end of a command instruction
(unlike other scripting languages such as JavaScript which uses a semicolon to
indicate the end of a command instruction).
Tip If you prefer to use another scripting language such as JavaScript, you
need to use the HMIWeb Display Builder (which supports JScript) rather
than using Display Builder (which only supports the use of VBScript).
In VBScript, comments are preceded by an apostrophe. You should always
comment your code to briefly describe its intent. This will greatly assist you in
code maintenance and debugging.
VBScript is event driven, however, timers can be used in DSP display scripts for
running scripts at regular intervals.
In DSP display scripts, event handlers are assigned to objects by appending the
event to the object name with an underscore character.
For example, to assign the onClick event to a display object named “Pump2”, you
would name the VBScript subroutine “Pump2_onClick”:
Sub Pump2_onClick()
'perform some action here
End Sub
In DSP display scripts, you do not need to specify the object name in a script if
the script is attached to that object. For example, the following script changes the
“FillColor” property of the “Rect1” object:
Sub Rect1_onAlarm()
FillColor = vbRed
End Sub
SCRIPTING BASICS
To access the properties of another object on the page, you specify the object’s
name. For example, the following script accesses the “FillColor” property of the
“Rect1” object from another object on the page, such as a pushbutton:
Sub bntAck_onClick()
Rect1.FillColor = vbBlue
End Sub
DSP display scripts access the Station’s menu, toolbar, Message Zone, and
Command Zone through the root “Application” object.
Attention Do not use the VBScript “MsgBox” function in Station. To send a message
to the operator, you should only ever use the Station Message Zone.
Application.MessageZoneText = “Your message goes here”
Further details and examples are provided in the following topics to guide and
assist you in the development of your DSP display scripting.
133
Events and event handlers

Scripts are event-driven, which means that a script only runs when the controlling
event occurs. In the case of a display, you can write event-driven scripts for the
display itself (that is, the Page object) as well as each of its display objects.
The following example shows the structure of a typical event handler that runs
when a user clicks a display object called “Pump2”. (The click fires an OnClick
event.)
Sub Pump2_OnClick()
MsgBox "This is the backup pump"
End Sub
All event names have an “On” prefix, as in OnClick and OnLoad. In addition, an
event handler for particular object is prefixed with the object’s name, as in
“Pump2_OnClick”“.
Validating events
Event handlers are called before the events are processed. This means that you
can use scripts to verify whether an event should proceed, canceling it if
necessary. The following example compares the user-entered value with the limit
and cancels the change if the value is greater than the limit.
Sub Alphanum1_OnChange(vNewValue)
tempvalue = CInt(vNewValue)
If tempvalue > Limit Then
MsgBox "Value must be below " & CStr(Limit) & "."
CancelChange()
End If
End Sub
SCRIPTING BASICS
Using general scripts

Although most scripts are attached to events, the Application and Page objects
can have general scripts, which are not attached to any particular object. General
scripts are typically used for declaring variables and for storing general-purpose
subroutines. Note that general scripts are used by event handlers; they are not
executed by themselves.
135
Referencing objects, properties and methods

This section describes the rules and conventions applicable to referencing objects,
properties and methods.
Referencing the “attached” object

A script attached to a particular object is considered to be “within the scope” of
that object. This means the script can access the object’s properties and methods
directly without having to specify the object’s name.
For example, in a script attached to “Rectangle1” you could set its FillColor
property as follows:
FillColor = vbRed
Similarly, in a script attached to “Alphanum2” you could clear its value using its
Clear method as follows:
Clear()
Referencing other objects

However in scripts attached to other objects, you have to use:
Rectangle1.FillColor = vbRed
Alphanum2.Clear()
Referencing objects within groups and shapes

Objects can only be referenced within groups or shapelinks via the containing
object’s collection. For example, if “Rectangle1” is part of “Group1”, you would
reference it as:
Group1.Objects.Item("Rectangle1")
Or, because Item is the default method for the Objects collection, as:
Group1.Objects("Rectangle1")
Referencing an object by number

In addition to referencing an object by name, it can also be referenced object by
its sequence number within the collection. This is especially useful when dealing
with shapelinks, which are generally used in a sequential manner. The following
example shows how you could access the third object in the collection for
Shapelink4:
Shapelink4.Objects(3)
SCRIPTING BASICS
Obtaining the number of objects in a group or shapelink

When working with groups and shapelinks, you may need to find out the number
of objects in the group or shapelink. (You need the count if, for example, you
want your script to step through the shapes.) The following example shows how
to obtain the count.
Count = Shapelink4.Objects.Count
Using methods belonging to other objects

In general, a method can only be used with the objects to which it belongs.
However, some Application methods, such as Blue (which returns the blue
component of an RGB color value), can be used with other objects. When using
such methods with other objects, you must add the “Application.” prefix to the
method.
The following example shows how you could use the Blue method to obtain the
blue component of the FillColor of “Rect3”:
BlueValue = Application.Blue(Rect3.FillColor)
Referencing the Application object

The Application object can be referenced directly in any script regardless of the
object to which the script is attached. The following example shows how any
script would obtain the value of the Application’s CurrentPage property (the
name of the current display):
DisplayName = Application.CurrentPage
Referencing objects within a display

Within a display, the Page object and its top-level display objects can be
referenced directly from any script attached to the Page or any of its display
objects.
Visibility of general scripts

The General script attached to the current display is “visible” to all scripts
attached to the Page object and its display objects. However, it is not visible to
scripts attached to the Application object or other displays (ones not currently
displayed).
The General script attached to the Application object is visible to all scripts
attached to the Application object, but it is not visible to the Page object or its
display objects.
137
Using the Dictionary object

The Dictionary object provides a “communications link” between scripts that
need to pass or share data. You would use the Dictionary, for example, if you
wanted to use a particular variable in several displays.
The following line creates a variable called “Position” and sets its value to “12”:
Application.Dictionary.Add "Position", 12
Any script can access the value as follows:
Box2.Left = Application.Dictionary.Item("Position").Value
SCRIPTING BASICS
Writing scripts for shapes and shapelinks

You can write scripts for shapes (display objects within shape files), and for
shapelinks (display objects that link shapes into displays). However, the
following special rules apply to such scripts:
• Events are only passed to the current shape (the one that is currently visible in
the display).
• Shapes do not have OnClick and OnDoubleClick events. Other than that, they
have the same events as a display object of the same type. For example, if you
create a Pushbutton in a display, it will have an OnClick event; however, if
you create a Pushbutton in a shape file, it will not have that event.
• A shape file cannot have any General script.
Referencing shapelinks and shapes

You reference a shape in a similar manner to an object within a group. For
example, if the shape is called “Rectangle2”, and it is linked to the display
through “shapelink1”, you would reference the shape as follows:
Shapelink1.Objects.Item("Rectangle2")
Or, because Item is the default method for Objects, as:
Shapelink1.Objects("Rectangle2")
You use the shapelink’s Value property to set the current shape. For example, to
select the second shape:
Shapelink1.Value = 2
Note that shapes are transient and only “exist” while they are displayed.
139
Event handling in groups and shapes

Events fired by a user action are directed toward any appropriate object within the
group or shape. For example, if a group contains a pushbutton and the user clicks
the pushbutton, the event is directed to the pushbutton and not to the group
containing it.
If an object does not have an appropriate event handler, the event is passed up to
the containing group or shapelink (recursively if necessary).
SCRIPTING BASICS
Using timers
Timers provide a convenient mechanism for running scripts at regular intervals.
For performance reasons, timers with intervals of less than 100ms are not
recommended.
For example, to “move” a display object across the display, you would:
1 Create a timer for the display object using the object’s CreateTimer method.
(A timer interval of about 250ms would be suitable.)
2 Write an OnTimer event for the object which moves the object a small
distance (to the left or right) when it fires.
Periodic update events

The Application, Page and display objects each have default “timers” in the form
of OnPeriodicUpdate events. These events fire each time the system time in
Station’s Status Line is updated by the server. The frequency of these events is
determined by Station’s setup.
141
Using the Script Editor

You use the Script Editor to write scripts. Like the Properties Window, the Script
Editor is modeless, which means that your script is saved to memory as soon as
you select another object or event. (Your changes are only saved to disk when you
save the display.)
Figure 51 The Script Editor window
WRITING SCRIPTS FOR DISPLAYS AND SHAPE FILES
Writing scripts for displays and shape files

Display-based scripts are stored in the display file. You write these scripts in
Display Builder itself.
To write a script for the display or any of its display objects:

1 Open the Script Editor by clicking Script Editor on the View toolbar.
2 Select an object from the Object list. This lists every display object in the
display, as well as Page (the display itself) and General (for general purpose
scripts).
3 Select the event you want to trigger your script from the Event list. This list
only contains events applicable to the type of object you have selected. (Note
however, if you select a display object, some of the events may not be
applicable to that particular type of display object. For example, the
OnBeginNavigate event is not applicable if you select a rectangle.)
4 A skeleton event handler appears in the Script Editor. Click below the Sub
statement and start writing your script for that event.
5 Repeat steps 2 to 4 if you want to write scripts for other combinations of
object and event.
Notes
• Objects that already have scripts are shown in bold in the Object list.
Similarly, events that contain scripts for the selected object are shown in bold
in the Event list.
• The Script Editor supports the Cut (CTRL+X), Copy (CTRL+C) and Paste
(CTRL+V) functions.
• Changes to scripts are added to the display file when you select another object
or event; however, they are only saved to disk when you save the display file.
• The syntax of your script is checked when you select another object or event.
Any syntax errors are displayed via a message box.
• You can change the font by right-clicking in the Script Editor and selecting
Font from the floating menu.
143
Writing scripts for Station

If you want to write a Station-level script—for example a script that runs when
Station starts—you must create a Station Scripting Object. A Scripting Object
(SSO) is an ActiveX control that attaches Station-level scripts to a Station.
Notes
• For details about creating an SSO, see the Application Development Guide.
• Station is represented by the HMIWeb Object Model, in particular the
Application and AppWindow objects. (Note that the objects with the same
name in this document represent the old version of Station.) For details, see
the HMIWeb Display Building Guide.
• The sample Visual Basic project for an SSO.vbp provides the framework for
implementing an SSO. (The project and associated components are zipped
into SSO_Sample.zip. This file is located in Station\Samples.)
ABOUT THE POSSIBILITIES OF AUTOMATION
About the possibilities of automation

For details about using the object model to control Station, see the scripting topics
in the HMIWeb Display Building Guide.
Attention This topic has not been updated to reflect HMIWeb-related changes to
Station’s functionality. For the updated information, see the scripting
section in the HMIWeb Display Building Guide.
Apart from making scripting possible, the Station Automation object model also
allows other applications to control Station. Other applications interact with a
Station object in the same way as does a script; that is, by using the object’s
properties, methods and events.
Conversely, because many other applications, such as Microsoft Excel, also have
Automation object models, you can control them via Station scripts. For example,
you could use the sophisticated charting features of Excel to display system
information in a manner that is not possible using only Station.
Getting two programs to interact requires considerable programming skills that
are beyond the scope of this guide. However, the two examples, “Controlling
Station from another application” on page 247 and “Controlling another
application from Station” on page 248 give an idea of what is possible.
145
Overview of the Station Automation object model

Before writing any scripts, you need to become familiar with the Station
Automation object model. This model provides the interface through which
scripts control Station and its displays.
From a practical point of view, think of the model as consisting of two parts: the
first part represents the higher level aspects of Station, whereas the second part
represents the current display and its display objects.
The first part of the model

The following figure shows the first part of the model.
Figure 52 The first part of the object model
AppWindow
Application (Station) Dictionary
Page
This part of the model is hierarchical and consists of four objects:

• Application, which is the root object in the hierarchy. It represents Station
itself, as well as the Menu, Toolbar, Message Zone and Command Zone.
• AppWindow, which represents Station’s main window, including its size,
position and state.
• Dictionary, which is a collection of named values that scripts can share as
required.
• Page, which represents the current display. Because of the complexity and
importance of displays, the Page object is, in effect, the second part of the
object model.
OVERVIEW OF THE STATION AUTOMATION OBJECT MODEL
The Page model

The second part of the model represents the current display. If you are interested
only in writing scripts for displays, you need to concentrate on the Page model.
(In practice, you can often ignore the first part.)
Figure 53 The Page model
Objects collection
Display Object #1
Page
Display Object #n
The Page model includes the Display objects, each of which represents an
individual display object, such as a rectangle, alphanumeric or pushbutton.
The Page model also includes the Objects collection, which contains the top-level
display objects on the page. (Note that each group and shapelink has its own
Objects collection, consisting of the display objects that make up the group or
shapelink.)
About objects
Think of an object as a convenient way of interacting with a particular part of
Station, or one of its displays. When writing scripts, you need to become familiar
with three object-related terms:
• Properties, which are the object’s attributes or characteristics. A display
object, for example, has properties such as FillColor, Height and Width.
Consequently, you change the color of a display object by changing the value
of its FillColor property.
• Methods, equivalent to the terms “function” or “command”, which are
applicable to the object. For example, the Page object has a Redraw method,
which redraws the current display.
• Events, such as alarms and user actions, which are applicable to the object. A
display object, for example, has events such as OnClick (which occurs when a
user clicks the object) and OnLoad (occurs when the object is first loaded).
147
Objects
The objects are listed in alphabetical order.
OBJECTS
Application object
Description
The Application object is Station’s root object. It represents Station’s window,
Menu, Toolbar, Message Zone and Command Zone. All other objects in the
object hierarchy can be reached from the Application object.
Station’s functionality. For the updated description, see the “Application
object” topic in the “HMIWeb Object Model reference” section of the
HMIWeb Display Building Guide.
Syntax
For scripts:
Application
When being addressed by other applications:

Station.Application
Remarks
• The Application object cannot be referenced from within the general script
section.
Properties
AlarmZonePointID Returns the ID of the current alarm point. (The
associated alarm appears in the Alarm Line.)
AlarmZonePointServerAli Returns the alias of the server on which the current
asName alarm point resides.
AlarmZonePointServerNet Returns the base-name of the server on which the
workName current alarm point resides.
Application Returns the Application object.
AppWindow Returns the AppWindow object.
AreSafeBrowseRightMouse Returns True if right-clicking a SafeBrowse object is
ClicksAllowed allowed (that is, displays the shortcut menu). If not, it
returns False.
CommandZoneText Sets, but does not execute, the command that appears in
the Command Zone. To execute the command, the user
must press ENTER.
149
CurrentFieldOffset Sets or returns the sequence number of the current field
in the current record/database. For example, a value of 3
represents the third field in the record.
Used in conjunction with the CurrentRecordOffset and
CurrentFileOffset properties to uniquely identify a
particular field.
CurrentFileOffset Sets or returns the sequence number of the current file
(in the set of files). For example, a value of 3 represents
the third file in the set.
Used in conjunction with the CurrentRecordOffset and
CurrentFieldOffset properties to uniquely identify a
particular field.
CurrentPage Sets or returns the name of the current display. If set,
Station displays that display.
CurrentPointID Returns the ID of the currently selected point.
CurrentPointServerAlias Returns the alias of the server on which the currently
Name selected point resides.
CurrentPointServerNetwo Returns the base-name of the server on which the
rkName currently selected point resides.
CurrentRecordOffset Sets or returns the sequence number of the current
record in the current file. For example, a value of 3
represents the third record.
Used in conjunction with the CurrentFieldOffset and
CurrentFileOffset to uniquely identify a particular field.
DetailPointID Only applicable if the current display is a Point Detail
display. Returns the ID of the point whose details are
currently displayed.
DetailPointServerAliasN Only applicable if the current display is a Point Detail
ame display. Returns the alias of the server on which the
point, whose details are currently displayed, resides.
DetailPointServerNetwor Only applicable if the current display is a Point Detail
kName display. Returns the base network name of the server on
which the point, whose details are currently displayed,
resides.
Dictionary Returns the Dictionary collection.
OBJECTS
EchoSafeBrowseMessage If set to False, prevents a SafeBrowse object from
writing messages to the Message Zone. (Typical
messages include “Web site found” and “downloading”.)
If set to True (the default) Safe Browse messages
appear in the Message Zone.
The property is reset to True when another display is
called up or when a new document is loaded into the
SafeBrowse object.
MessageZoneText Sets or returns the text that appears in the Station’s
Message Zone.
OperatorID Returns the:
• Operator ID if the Station is configured for operator-
based security
• Station number if the Station is configured for
Station-based security
Page Returns the Page object.
PageBackgroundColor Sets or returns the background color of the current
display. The colors are:
0 = Black
1 = Grey
2 = White
3 = Red
4 = Green
5 = Blue
6 = Cyan
7 = Magenta
8 = Yellow
9 = Default
Anything greater than 9 results in a black background
color.
Attention In a multi-window Station, changing the color
will change the background color of all current
and subsequent displays.
Parent Returns the Station object.
151
SecurityLevel Returns the user’s security level. The values are:
0 = View Only
1 = Ack Only
2 = Operator
3 = Supervisor
4 = Engineer
5 = Manager
ServerName Returns the name of the Server to which the Station is
connected.
StationNumber Returns the Station’s server connection number.
Methods
BeginCriticalSection method
Blue method
CancelOperatorCommand method
CreateTimer method
CrossScreenInvocationPending method
EndCriticalSection method
ExecuteOperatorCommand method
GetResponse method
Green method
InvokeMenu method
KillTimer method
MakeColor method
Quit method
Red method
RequestServerLRN method
Shell method
UserObjectNotify method
Events
OnAlarm event
OnAppStartup event
OBJECTS
OnConnect event
OnDisconnect event
OnMenu event
OnMenu2 event
OnOperatorChange event
OnOperatorCommand event
OnPageLoad event
OnPeriodicUpdate event
OnQuit event
OnTimer event
OnUserObjectNotify event
153
AppWindow object
Description
The AppWindow object represents the Station window, and contains the
properties that reflect the current state of the main window.
Station’s functionality. For the updated description, see the “AppWindow
object” topic in the “HMIWeb Object Model reference” section of the
HMIWeb Display Building Guide.
Syntax
Application.AppWindow
Properties
DisplayHWND Returns the “handle” allocated by Windows to the
window that includes the display and its surrounding
border. (See “Mouse coordinates” on page 241.)
Height Sets and returns the height of the Station window.
The range depends on Windows’ screen setting. For
example, if the setting is 1280x1024, the height can be
up to 1024.
HWND Returns the “handle” allocated by Windows to the
Station window.
Left Sets and returns the position of the left edge of the
Station window with reference to the left edge of the
screen.
The range depends on the Windows screen setting.
Parent Returns the Application object.
Title Returns the title that appears in the title bar of the Station
window.
Top Sets and returns the position of the top of the Station
window with reference to the top of the screen.
The range depends on the Windows screen setting.
Width Sets and returns the width of the Station window.
The range depends on the Windows screen setting. For
example, if the screen has a 1280x1024 resolution, the
width can be up to 1280.
OBJECTS
WindowState Sets and returns the state of the Station window. The
values are:
0 = Window is hidden (not visible). Note that this value
should be used with caution because a hidden Station
will not receive any user events, although it will
continue to receive server and timer events.
1 = Window is visible and can be sized by the user
2 = Window is minimized
3 = Window is maximized
Methods
DPToLPX and DPToLPY methods
LPToDPX and LPToDPY methods
Events
None.
155
Dictionary object
Description
The dictionary is a collection of named variables. Each item (named variable) in
the dictionary has a case-sensitive name and a value. The value can be of any
form, such as text or numeric.
Dictionary items can be used by any script, regardless of the object to which it is
attached.
By default, dictionary items remain for the life of Station. It is therefore important
to use the Remove method to remove items if they are no longer required.
Syntax
Application.Dictionary
Properties
Count Returns the number of items in the collection.
Dictionary Item Properties
Name Returns the item’s case-sensitive name.
Value Sets and returns the item’s value.
Methods
Add method
Item method
Remove method
Events
None.
OBJECTS
Example
This example shows how to create a variable called “Volts” and assign it a value:
Application.Dictionary.Add “Volts”, 12.2
Once created, any script can access the value as follows:
BattVolts = Application.Dictionary.Item("Volts").Value
157
Display objects
Description
Display objects represent the graphic elements on the current display, such as
rectangles and pushbuttons.
Syntax
ObjectName
Where ObjectName is the display object’s name, such as “pushbutton3”. (As
shown in Name on the General tab of the Properties Window.)
Properties
Busy Only applicable to a SafeBrowse or ActiveX Document
object. Indicates whether the browser is currently
navigating or downloading.
Document Only applicable to a SafeBrowse or ActiveX Document
object. Returns the active document object. For example,
the HTML document being displayed in a SafeBrowse
window.
The Document property gives a script access to the
document’s Automation object. The properties and
methods available to the document depend on the
document’s type. See “Using the Document property” on
page 249.
DocumentType Only applicable to a SafeBrowse or ActiveX object.
Returns a string specifying the content type (MIME) of
the object’s contents. For example, if an HTML document
is being displayed, the content type is “text/html”.
OBJECTS
FillColor Sets and returns the object’s fill color. The color can be
either the RGB value (24-bit) or one of the following
predefined VBScript colors:
• vbBlack
• vbWhite
• vbRed
• vbYellow
• vbGreen
• vbBlue
• vbCyan
• vbMagenta
FillColorBlink Sets and returns the blinking state of the object’s FillColor.
The values are True and False.
FillColorTransparent Sets and returns the transparency of the object’s FillColor.
Height Sets and returns the object’s height.
The range is between 1 and 4499.
Label Sets and returns the object’s label. Only applicable to
checkbox, pushbutton and text objects. (In the case of a
text object, the Label and Value properties are identical.)
Left Sets and returns the position of the object’s left edge with
reference to the left edge of the Station client window.
LevelFillColor Only applicable to an indicator object. Sets and returns the
level fill color.
LineColor Sets and returns the object’s line color. The color can be
either the RGB value (24-bit) or one of the following
predefined colors:
• vbBlack
• vbWhite
• vbRed
• vbYellow
• vbGreen
• vbBlue
• vbCyan
• vbMagenta
LineColorBlink Sets and returns the blinking state of the object’s
LineColor. The values are True and False.
159
LineColorTransparent Sets and returns the transparency of the object’s Linecolor.
LineStyle Sets and returns the object’s line style. The values are:
0 = Flat
1 = Ridge
2 = Groove
3 = Raised
4 = Lowered
LineWidth Sets and returns the object’s line width. The values are:
0 = None (invisible)
1 = Hairline
2 = Thin
3 = Thick
4 = Thicker
5 = Thickest
ListCount Only applicable to a local Combobox object. (A local
Combobox is one which does not have a link to the
database.) Returns the number of items in the drop-down
list.
LocationName Only applicable to a SafeBrowse object. Returns a string
containing the title of the resource (URL) that the
SafeBrowse is displaying.
Name Returns the object’s name. (Corresponds to the Name,
property on the General tab of the Properties Window.)
Objects Only applicable if the object is a Group or Shapelink.
Returns the object’s collection.
Parent Returns the parent of the object. This is either:
• The Page object
• The Group or Shapelink to which the object belongs
Right Sets and returns the position of the object’s right edge with
reference to the left edge of the Station client window.
RotationAngle The angle through which the object has been rotated,
expressed in degrees. The object is rotated about the point
defined by RotationPointX and RotationPointY.
Not all types of display objects can be rotated—see
“Rotating display objects” on page 42.
OBJECTS
RotationPointX The horizontal and vertical coordinates of the point about
RotationPointY
which the object has been rotated.
The horizontal coordinate is between 0 and 7999 and the
vertical coordinate is between 0 and 4999.
SelectedListIndex Only applicable to a local Combobox object. (A local
Combobox is one which does not have a link to the
database.) Sets and returns the index that identifies an item
in the drop-down list.
The value for the first item is 0, the value for the second
item is 1, and so on. A value of -1 indicates that no item is
selected.
Top Sets and returns the position of the object’s top edge with
reference to the top of the Station client window.
161
Type Returns the object’s type, which is one of the following:
0 = null
1 = Text
2 = Rectangle
3 = RoundRectangle
4 = Oval
5 = FreehandLine
6 = Line
7 = Arc
8 = Wedge
9 = Polyline
10 = Polygon
11 = Alphanumeric
12 = PushButton
13 = Indicator
14 = Checkbox
15 = Chart
16 = Combobox
17 = Multimedia
18 = Scrollbar
19 = Alarm
20 = Bitmap
21 = Metafile
22 = Overview
23 = Group
24 = Shapelink
25 = TGA image
26 = JPG image
28 = Video
29 = SafeBrowse
30 = ActiveXDoc
Value The object’s value, the meaning of which depends on its
type—see “About the Value Property” on page 163.
Note that Value is not applicable to all types of object.
OBJECTS
Visible Sets and returns the object’s visibility. The values are
True and False.
Note that an invisible object does not receive user events,
such as OnClick, but still receives server and timer events.
Width Sets and returns the object’s width.
About the Value Property
Object Type Meaning of the Value property

ActiveX The URL of the currently displayed document.
Alphanumeric The currently displayed text/number.
Note that if you set the value of an alphanumeric linked to the
database, the value will not change until the server has
acknowledged the control. Performing large numbers of such
controls where timing may be a critical factor is not recommended.
Checkbox The value is True if selected (checked) and False if not selected
(unchecked).
Combobox The currently selected item in the list.
SafeBrowse The URL of the currently displayed Web page.
Scrollbar The value is based on the position of the scroll bar and varies
between the values of the scrollbar’s Maximum Value and
Minimum Value properties.
For example, Value would be 65 if:
• Minimum Value is 50
• Maximum Value is 80
• The scroll box is in the middle of the scrollbar
Shapelink The current shape number in the shape sequence. Note that value of
the first shape is 1.
Text The currently displayed text. (Note that a text object’s Label and
Value properties are identical.)
Methods
AddListItem method
CancelChange method
CancelClick method
CancelDoubleClick method
163
CancelNavigate method
Clear method
CreateTimer method
GoHome method
GoBack method
GoSearch method
GoForward method
KillTimer method
Refresh method
RemoveListItem method
SelectText method
SetFocus method
Stop method
Update method
Events
OnBeginNavigate event
OnChange event
OnClick event
OnDoubleClick event
OnDownloadBegin event
OnDownloadComplete event
OnFocus event
OnLoad event
OnMouseEnter event
OnMouseLeave event
OnMouseMove event
OnNavigateComplete event
OnPageComplete event
OnRightClick event
OnTimer event
OnUpdate event
OnUnload event
OBJECTS
Objects collection
Description
The Objects collection for:
• The Page object contains the top-level display objects in the current display.
• A Group or Shapelink contains the display objects within the group or
shapelink.
The Objects collection is used when referencing a display object from another
object’s script.
Syntax
When referencing the collection in the current display:
Page.Objects
When referencing the collection of a group called “Group1”:

Group1.Objects
Properties
Count Returns the number of display objects in the collection.
Parent Returns the parent object.
Methods
Item method
Events
None.
Example
This example shows how to refer to “Rectangle1”.
Page.Objects.Item("Rectangle1")
This example shows how to refer to the second item in the collection.
Page.Objects.Item(2)
This example shows how to use display objects to perform an iterative task. In
this case, change the fill color of all objects in a display.
For i = 1 to Page.Objects.Count
Page.Objects.Item(i).FillColor = vbRed
Next
165
Page object
Description
The Page object represents the current display. The Page object also contains an
Objects collection, whose items are the display objects on the display (the
rectangles, alphanumerics, and so on).
Syntax
Page
Properties
FilePath Returns the full path of the display file.
HelpFile Sets or returns the filename of the help associated with
the display. Used in conjunction with HelpType,
HelpTopicFile and HelpTopicNumber.
The file must be located in a folder defined in Station’s
list of search paths—for example, in the same folder as
the associated display.
HelpTopicFile Only applicable when the HelpType is set to 1. Sets or
returns the internal filename of the help topic.
HelpTopicNumber Only applicable when the HelpType is set to 2. Sets or
returns the topic number of the help topic.
HelpType Sets or returns the type of help associated with the
display. The values are:
0 = Document other than HTML Help (such as a text file
or Microsoft Word document)
1 = Help topic within HTML Help identified by its the
internal filename (specified in HelpTopicFile)
2 = Help topic within HTML Help identified by its topic
number (specified in HelpTopicNumber)
Objects Returns the Objects collection for the display.
Title Returns the display’s title.
OBJECTS
Methods
CreateTimer method
KillTimer method
OpenHelp method
Redraw method
Events
OnLoad event
OnMouseMove event
OnTimer event
OnUnload event
167
Methods
The methods are listed in alphabetical order.
METHODS
Add method
Applicable to
Dictionary object
Description
Adds a new item (named variable) to the Dictionary collection.
Syntax
Add(name,value)
Part Description
name The case-sensitive name of the item.
value The value of the item.
Remarks
• The Dictionary can contain a maximum of 256 items. If you need to add more
items, you must first use the Remove method to remove unused items.
• There is no protection against adding more than one item with the same name.
If this happens, retrieving the item’s value will return the value of the first
item with that name.
Example
This example adds an item “Voltage” to the Dictionary and sets its value to
“12.3”.
Dictionary.Add "Voltage", 12.3
169
AddListItem method
Applicable to
Display objects
Description
Adds an item to a local Combobox. (A local Combobox is one which does not
have a link to the database.) When a user selects a Combobox, the list of items
appears, allowing the user to select the appropriate item.
Syntax
[object.]AddListItem(item[, index])
or
[object.]AddListItem item[, index]
Part Description
object The Combobox to which the entry is being added.
item The item being added.
index The item’s position in the Combobox’s list.
If omitted, the item is added to the end of the list.
If an existing index is specified, existing items are
moved down to make room for the new item.
Remarks
• The index of the first item in the list is 0.
• By default, the first item in the list is selected when the combobox is initially
displayed.
Example
This example adds three items to the Combobox “SetSpeed”.
SetSpeed.AddListItem “Slow”, 0
SetSpeed.AddListItem “Medium”, 1
SetSpeed.AddListItem “Fast”, 2
METHODS
BeginCriticalSection method
Applicable to
Application object
Description
The BeginCriticalSection method disables the script timeout (which is set to
5 seconds).
The BeginCriticalSection and EndCriticalSection methods are usually used to
enclose a block of code that must not be interrupted once started. For example,
you may want to use the method(s) in a script that changes a number of values in
the database and then requests a task which uses the new values.
Syntax
Application.BeginCriticalSection()
Remarks
• You should use the BeginCriticalSection method with caution because it
disables the script timeout for all scripts.
• The EndCriticalSection method immediately re-enables the script timeout.
However, if there is no EndCriticalSection method, the script timeout is
automatically re-enabled when script finishes.
Example
This example shows how the BeginCriticalSection method can be used in the
OnClick event for a pushbutton.
Sub PushButton3_OnClick()
.
.
Application.BeginCriticalSection()
'critical task
.
Application.EndCriticalSection()
End Sub
171
Blue method
Applicable to
Application object
Description
The Blue method is a utility function that can be used in any script. It returns the
blue component of a color value, expressed as a number between 0 (no blue) and
255 (100% blue). Normally used in conjunction with the Red and Green methods.
Syntax
Application.Blue(RGBvalue)
Part Description
RGBvalue The color value from which the blue component is
returned.
Example
This example obtains the blue component of the fill color of “Rect3”.
BlueValue = Application.Blue(Rect3.FillColor)
METHODS
CancelChange method
Applicable to
Display objects
Description
Cancels a change made by a user to the following types of display object:
• Alphanumeric
• Checkbox
• Scrollbar
• Combobox
Syntax
CancelChange
Remarks
• The CancelChange method can only be used within an OnChange event.
Together, they enable the change to be validated before passing it on to the
server.
Example
This example compares the user-entered value with the current limit and cancels
the change if the value is greater than the limit. The OnChange event fires when
the change is made, and passes the user-entered value to the script.
Sub OnChange(vNewValue)
'calculate current limit.
.
.
.
If vNewValue > Limit Then
MsgBox "Value must be below " & CStr(limit) & "."
CancelChange
End If
End Sub
173
CancelClick method
Applicable to
Display objects
Description
Cancels the click when a user clicks a display object.
Syntax
CancelClick
Remarks
• The CancelClick method can only be used within OnClick and OnRightClick
events. Together, they enable the click operation to be validated before
passing it on to the server.
Example
This example, attached to “Pushbutton2”, checks the user’s security level and
cancels the click if the level is below Engineer.
If Application.SecurityLevel < 4 Then
MsgBox "Only an Engineer or Manager can do this"
CancelClick
End If
End Sub
METHODS
CancelDoubleClick method
Applicable to
Display objects
Description
Cancels the double-click when a user double-clicks a display object.
Syntax
CancelDoubleClick
Remarks
• The CancelDoubleClick method can only be used within an OnDoubleClick
event. Together, they enable the double-click operation to be validated before
passing it on to the server.
Example
Sub Circle3_OnDoubleClick()
If ... Then
MsgBox "..."
CancelDoubleClick
End If
End Sub
175
CancelNavigate method
Applicable to
Display objects
Description
Cancels a user’s navigation operation. Only applicable to a SafeBrowse object.
Syntax
CancelNavigate
Remarks
• The CancelNavigate method can only be used within an OnBeginNavigate
event. Together, they can be used to prevent the user from accessing
unauthorized Web sites.
• The OnBeginNavigate event only receives “http://” style addresses.
Consequently, you must ensure that any permitted Web site does not include
links to other types, such as FTP and files, that are inappropriate or unsafe.
Example
This example prevents the user from accessing external Web sites.
Sub OnBeginNavigate(URL)
If NewURL = ... Then
MsgBox "You cannot access external Web sites."
CancelNavigate
End If
End Sub
METHODS
CancelOperatorCommand method
Applicable to
Application object
Description
Cancels the command entered by a user in the Station’s Command Zone.
Syntax
CancelOperatorCommand
Remarks
• The CancelOperatorCommand method can only be used within an
OnOperatorCommand event. Together, they enable the command to be
validated before passing it on to the server.
Example
Sub OnOperatorCommand(bstrCommand)
If bstrCommand = "bye" Then
MsgBox "Log out not permitted"
End If
End Sub
177
Clear method
Applicable to
Display objects
Description
Clears (removes) the text of an Alphanumeric display object.
Syntax
[object.]Clear
Part Description
object The Alphanumeric object whose text is cleared.
Example
This example clears the alphanumeric “Alphanum1” when the user clicks
“Pushbutton1”.
Sub Pushbutton1_OnClick()
Alphanum1.Clear
End Sub
METHODS
CreateTimer method
Applicable to
Application object
Display objects
Page object
Description
Creates a timer for an object, which fires OnTimer events events at regular
intervals.
A timer keeps firing OnTimer events until it is killed by either the KillTimer
method, or when the associated object is killed. For example, displaying a new
display kills all timers associated with the old display and its display objects.
Syntax
Call [object.]CreateTimer(timerID, interval)
or
[object.]CreateTimer timerID, interval
or
variable = [object.]CreateTimer(timerID, interval)
The last syntax returns True if the timer is created and False if it isn’t.
Part Description
object The object for which you are creating the timer.
timerID A unique number that identifies the timer.
interval The interval, in milliseconds, at which the timer fires
timer events.
Remarks
• A maximum of 100 timers can exist at any one time.
• The timer’s interval can be changed by calling the CreateTimer method a
second time, specifying the original TimerID, but a different Interval.
• Timers with intervals of less than 100ms are not recommended for
performance reasons.
179
Example
This example creates a 250ms timer for “Circle3” when it is loaded into the
display.
Sub Circle3_OnLoad()
Call CreateTimer(1, 250)
End Sub
You would then write an appropriate OnTimer event handler for the object.
METHODS
CrossScreenInvocationPending method
Applicable to
Application object
Description
Read only so cannot be set from script. Checks whether the operator has
requested that the next display navigation be passed to the associated Station (as
determined by the Flex Station Configuration Display properties).
Syntax
CrossScreenInvocationPending
Return value
True or False.
181
DPToLPX and DPToLPY methods

Applicable to
AppWindow object
Description
These two methods convert the X- and Y-coordinates, respectively, from
resolution-dependent display coordinates (expressed in pixels) to Display
Builder’s logical coordinates. See “About display coordinates” on page 241.
Syntax
Appwindow.DPToLPX(displaycoordx)
Appwindow.DPToLPY(displaycoordy)
Part Description
displaycoordx The display coordinate that is converted.
displaycoordy
Remarks
• The LPToDPX and LPToDPY methods convert from logical coordinates to
display coordinates.
Example
This example sets the logical coordinates of “Rect1”.
Rect1.Left = AppWindow.DPToLPX(500)
Rect1.Top = AppWindow.DPToLPY(300)
METHODS
EndCriticalSection method
Applicable to
Application object
Description
Re-enables the script timeout after having been disabled by the
BeginCriticalSection method. See “BeginCriticalSection method” on page 171
for further details.
Syntax
EndCriticalSection
183
ExecuteOperatorCommand method
Applicable to
Application object
Description
Executes a user command as if it had been entered into the Command Zone by a
user. (A user command is anything a user would normally type into the Command
Zone.)
Syntax
ExecuteOperatorCommand(command)
Part Description
command The command that is executed.
Remarks
• If you use ExecuteOperatorCommand within an OnOperatorCommand event,
the command specified in ExecuteOperatorCommand will be executed and
the user’s command will be cancelled.
• For the list of operator commands, see the “Command reference” topic in the
“Reference topics” section of the Operator’s Guide.
Example
This example calls up display, whose page number is 80.
ExecuteOperatorCommand("Pag 80")
METHODS
GetResponse method
Applicable to
Application object
Description
Displays the specified prompt in Station’s Message Zone and returns the response
entered by the user in Station’s Command Zone.
Syntax
GetResponse(prompt)
Part Description
prompt The message that appears in the Message Zone.
Remarks
• Station cannot perform any other task while waiting for a response from a
user. You should therefore only use GetResponse within a suitable OnTimer
subroutine, as shown in the following example.
Example
This shows how to use an OnTimer subroutine to check for a response, and if
there is none (indicated by a null string) exit the routine.
Sub CheckResponse_OnTimer(l)
Dim str
str = GetResponse (“Are you sure (Y/N)?”)
If str = ““ then
.
.
Else
.
.
End If
End Sub
185
GoBack method
Applicable to
Display objects (SafeBrowse object only)
Description
Goes back one page in the SafeBrowse’s history list.
Syntax
[SafeBrowse.]GoBack
Part Description
SafeBrowse The SafeBrowse object in which the previous page is
displayed.
Example
Browser1.GoBack
End Sub
METHODS
GoForward method
Applicable to
Description
Displays the next page in the SafeBrowse object’s history list.
Syntax
[SafeBrowse.]GoForward
Part Description
SafeBrowse The SafeBrowse object in which the next page is
displayed.
Example
Browser1.GoForward
End Sub
187
GoHome method
Applicable to
Description
Displays the SafeBrowse object’s home page.
Syntax
[SafeBrowse.]GoHome
Part Description
SafeBrowse The SafeBrowse object in which the home page is
displayed.
Remarks
• The home page for all SafeBrowse objects is specified in the Station setup.
Example
Browser1.GoHome
End Sub
METHODS
GoSearch method
Applicable to
Description
Displays the SafeBrowse object’s search page.
Syntax
[SafeBrowse.]GoSearch
Part Description
SafeBrowse The SafeBrowse object in which the search page is
displayed.
Remarks
• The search page for all SafeBrowse objects is specified in the Station setup.
Example
Browser1.GoSearch
End Sub
189
Green method
Applicable to
Application object
Description
The Green method is a utility function that can be used in any script. It returns the
green component of a color value expressed as a number between 0 (no green)
and 255 (100% green). Normally used in conjunction with the Blue and Red
methods.
Syntax
Application.Green(RGBvalue)
Part Description
RGBvalue The color value from which the green component is
returned.
Example
This example obtains the green component of the fill color of “Rect3”.
GreenValue = Application.Green(Rect3.FillColor)
METHODS
InvokeMenu method
Applicable to
Application object
Description
Superseded by the InvokeMenu2 method, however, the InvokeMenu method is
still supported for legacy scripts on DSP displays.
Invokes the selected menu item as if it had been selected by a user.
Syntax
InvokeMenu(menuitem)
191
Part Description
menuitem The menu item:
1000 = Create a new Station connection
1001 = Open a new Station connection
1002 = Save the current Station connection
1003 = Save the current Station connection as
1004 = Setup the current Station connection
1005 = Print the current display
1006 = Quit Station
1007 = Show the full display
Attention Applicable to single-window Station only—
resizes the Station's main window—not
applicable for multi-window Station.
1008 = Zoom out
1009 = Zoom in
1030 = Show Station’s About dialog box
1034 = Login
1036 = Scroll right
1037 = Scroll left
1038 = Scroll up
1039 = Scroll down
1054 = Show the print page setup
1055 = Call up the startup display
1056 = Search for a Web page
1057 = Stop loading a Web page
1058 = Refresh a Web page
1061 = Open the Print dialog box
2111 = Call up next display
Example
This example shows how to print the current display.
InvokeMenu(1005)
METHODS
Item method
Applicable to
Dictionary object
Objects collection
Description
Returns the specified item from the Dictionary or Objects collection.
Syntax
Item(index|name)
Part Description
index Returns the item with the specified index (sequence
number within the list of items).
name Returns the item with the specified case-sensitive name.
Remarks
• The method returns the collection if neither index nor name are specified.
• Index numbering starts at 1.
Example
This example returns the value of a Dictionary item using its index.
SavedValue = Application.Dictionary.Item(1).Value
This example returns the value of a Dictionary item using its name.
SavedValue = Application.Dictionary.Item("Volts").Value
This example changes the fill-color of all display objects on the display.
For i = 1 to Page.Objects.Count
Page.Objects.Item(i).FillColor = vbRed
Next
193
KillTimer method
Applicable to
Application object
Display objects
Page object
Description
Kills the specified timer. (Timers are created by the CreateTimer method.)
Syntax
[object.]KillTimer(timer)
Part Description
object Optional.The object whose timer is being killed.
timer The ID of the timer that is killed.
Example
This example kills a timer, with an ID of “2”, belonging to “Rectangle1” when the
user clicks “Pushbutton1”.
Sub Pushbutton1_OnClick
Rectangle1.KillTimer(2)
End Sub
METHODS
LPToDPX and LPToDPY methods

Applicable to
AppWindow object
Description
These two methods convert the X- and Y-coordinates, respectively, from Display
Builder’s logical coordinates to the resolution-dependent display coordinates
(expressed in pixels). See “About display coordinates” on page 241.
Syntax
Appwindow.LPToDPX(logicalcoordx)
Appwindow.LPToDPY(logicalcoordy)
Part Description
logicalcoordx The logical coordinate that is converted.
logicalcoordy
Remarks
• The DPToLPX and DPToLPY methods convert from display coordinates to
logical coordinates.
Example
This example obtains the display coordinates of “Rect1”.
Xcoord = AppWindow.LPToDPX(Rect1.Left)
Ycoord = AppWindow.LPToDPY(Rect1.Top)
195
MakeColor method
Applicable to
Application object
Description
The MakeColor method is a utility function that can be used in any script. It
returns a color value, expressed in RGB format. The value is packed into the
lower 24 bits of a long integer.
Syntax
Application.MakeColor(red, green, blue)
Part Description
red The red component, with a value between 0 (no red) and
255 (maximum red).
green The green component, with a value between 0 (no green)
and 255 (maximum green).
blue The blue component, with a value between 0 (no blue)
and 255 (maximum blue).
Example
This example changes the fill color of “Rect3” to white.
Rect3.FillColor = Application.MakeColor(255,255,255)
METHODS
OpenHelp method
Applicable to
Page object
Description
Opens the help associated with the display. The help details are specified in Page
object properties.
Syntax
OpenHelp()
Example
This example sets the help to “help.txt”, and opens the help.
Page.HelpType = 0
Page.HelpFile = "help.txt"
Page.OpenHelp
End Sub
197
Quit method
Applicable to
Application object
Description
Terminates Station. Equivalent to the user selecting File > Exit.
Syntax
Application.Quit
Remarks
• The method does not prompt for user confirmation.
Example
This example performs shut-down tasks and terminates the Station when the user
clicks the “Quit” button, providing the user confirms the message.
Sub QuitButton_OnClick()
If MsgBox("Are you sure you want to Exit Station?",_
vbYesNo) = vbYes Then
'Perform shut-down tasks.
.
.
Application.Quit
Else
CancelClick()
End If
End Sub
METHODS
Red method
Applicable to
Application object
Description
The Red method is a utility function that can be used in any script. It returns the
red component of a color value, expressed as a number between 0 (no red) and
255 (100% red). Normally used in conjunction with the Blue and Green methods.
Syntax
Application.Red(RGBvalue)
Part Description
RGBvalue The color value from which the red component is
returned.
Example
This example obtains the red component of the fill color of “Rect3”.
RedValue = Application.Red(Rect3.FillColor)
199
Redraw method
Applicable to
Page object
Description
Immediately redraws the current display.
Syntax
Redraw
Example
This example redraws the page.
Sub ...
.
.
Page.Redraw
End Sub
METHODS
Refresh method
Applicable to
Description
Reloads the current Web page in the SafeBrowse object.
Syntax
[SafeBrowse.]Refresh
Part Description
SafeBrowse The SafeBrowse object which is reloaded.
Example
Browser2.Refresh
End Sub
201
Remove method
Applicable to
Dictionary object
Description
Removes an item from the Dictionary collection.
Syntax
Remove(index|name)
Part Description
index Required if name is not specified. The sequence number
of the item that is removed.
name Required if index is not specified. The case-sensitive
name of the item that is removed.
Remarks
• Index numbering starts at 1.
Example
This example removes “Voltage” (the name of the item) from the Dictionary.
Application.Dictionary.Remove("Voltage")
This example removes the third item from the Dictionary.
Application.Dictionary.Remove(3)
METHODS
RemoveListItem method
Applicable to
Display objects (Local Combobox only)
Description
Removes an item from a local Combobox. (A local Combobox is one which does
not have a link to the database.)
Syntax
[object.]RemoveListItem(index)
Part Description
object The Combobox from which the entry is removed.
index The sequence number of the removed item. Note that the
first item has an index of 0.
Example
This example removes the second item from the combobox.
Combobox1.RemoveListItem(1)
203
RequestServerLRN method
Applicable to
Application object
Description
Requests the specified LRN (Logical Resource Number) on the server.
Syntax
RequestServerLRN(LRN[, param1, param2])
Part Description
LRN The requested LRN.
param1 param2 The parameter(s) passed to the LRN.
Example
This example uses the Server Display Program (LRN 21) to call up page 11.
Application.RequestServerLRN 21, 1, 11
METHODS
SelectText method
Applicable to
Display objects (Alphanumeric only)
Description
Selects the text of an Alphanumeric display.
Syntax
[object.]SelectText
Part Description
object The Alphanumeric object whose text is selected.
Example
Alphanum1.SelectText
End Sub
205
SetFocus method
Applicable to
Display objects
Description
Selects the dynamic display object. (A dynamic display object is one that can
have focus.) Some display objects, such as checkboxes and alphanumerics, are
intrinsically dynamic; however, objects that are normally static, such as
rectangles and lines, are also dynamic if they are linked to the database.
Syntax
[object.]SetFocus
Part Description
object The object that is selected.
Example
Pushbutton1.SetFocus
METHODS
Shell method
Applicable to
Application object
Description
Executes a command as an operating system command.
Syntax
Call Application.Shell(command, state)
or
Application.Shell command, state
Part Description
command The operating system command.
state Sets the state of the window in which the command runs.
The values are:
0 = Window is hidden (not visible).
1 = Standard Window
2 = Window is minimized
3 = Window is maximized
Example
This example starts Windows Notepad and displays a text file.
Application.Shell "notepad c:\documents\readme.txt",1
207
Stop method
Applicable to
Description
Stops the current navigation operation in the SafeBrowse object.
Syntax
[SafeBrowse.]Stop
Part Description
SafeBrowse The SafeBrowse object in which navigation is stopped.
Example
Browser1.Stop
End Sub
METHODS
Update method
Applicable to
Display objects
Description
Fires an OnUpdate event for a display object, even though it was not updated by
the server. (Normally, OnUpdate events only fire when the object is updated by
the server.)
Syntax
[object.]Update()
Part Description
object The display object that is updated.
Example
Combobox1.Update
End Sub
209
Applicable to
Application object
Page object
Description
Fires an OnUserNotify event for the Application or Page object. This method is
used by automation objects that may require significant processing time, thereby
avoiding script timeouts.
Syntax
[object.]UserObjectNotify(lID, vParam)
Part Description
object The display object for which the event fires.
lID The ID that identifies the object using the method.
vParam The variant used to return data to the script.
EVENTS
Events
The events are listed in alphabetical order.
211
OnAlarm event
Applicable to
Application object
Description
Fires when a new alarm appears in the Station’s Alarm Zone.
Syntax
OnAlarm()
Example
This example sets the background color to red when an alarm occurs.
Sub Application_OnAlarm()
PageBackgroundColor = 3
End Sub
EVENTS
OnAppStartup event
Applicable to
Application object
Description
Fires as soon as Station is started and all its objects have been created.
Syntax
OnAppStartup()
Remarks
• The event does not fire when the Station script is reloaded, for example, when
a user chooses Station > Connect.
Example
This example sets the background color to white when Station starts.
Sub Application_OnAppStartup()
PageBackgroundColor = 2
End Sub
213
OnBeginNavigate event
Applicable to
Description
Fires when a user enters a new URL in a SafeBrowse object.
Syntax
OnBeginNavigate(URL)
Part Description
URL The Web address (Universal Resource Locator)
Remarks
• The URL is not passed immediately to the SafeBrowse object when the
OnBeginNavigate event fires. This allows the event to be used in conjunction
with the CancelNavigate method to check the URL before sending it to the
SafeBrowse object.
• The OnBeginNavigate event only receives “http://” style addresses.
Consequently, you must ensure that any permitted Web site does not include
links to other types, such as FTP and files, that are inappropriate or unsafe.
• An OnNavigateComplete event fires when the SafeBrowse object completes
navigation to the URL.
Example
This example cancels the navigation if the new URL is outside the
ourwebsite.com domain.
Sub Browser1_OnBeginNavigate(URL)
const domain = "ourwebsite.com"
newDomain = right(URL,Len(domain))
If newDomain <> domain Then
CancelNavigate
End If
End Sub
EVENTS
OnChange event
Applicable to
Display objects
Description
Fires when a user changes the value of a display object. It does not fire when the
server or a script changes the value.
Only applies to the following types of display objects:
• Alphanumeric
• Checkbox
• Scrollbar
• Combobox
Syntax
OnChange(value)
Part Description
value The new value supplied by the user.
Remarks
• The object retains its old value when the OnChange event fires. This allows
the event to be used in conjunction with the CancelChange method to validate
the change before sending it to the server.
• An OnUpdate event fires when the server actually changes the object’s value.
• Do not use the OnChange event to create message boxes, input boxes or
dialog boxes for a scrollbar. Doing so will result in unpredictable object
behavior.
Example
This example displays a warning message when a user tries to change the state of
a point.
Sub Combobox1_OnChange(vNewValue)
If MsgBox("Do you want to change the point", vbYesNo)_
= vbNo Then
CancelChange()
End If
End Sub
215
OnClick event
Applicable to
Display objects
Description
Fires when a user clicks a display object.
Syntax
OnClick()
Remarks
• The OnClick event fires before the click action is processed. This allows the
event to be used in conjunction with the CancelClick method to validate the
action before sending it to the server.
Example
This example, attached to “Pushbutton2”, checks the user’s security level and
cancels the click if the level is below Engineer.
If Application.SecurityLevel < 4 Then
CancelClick
End If
End Sub
EVENTS
OnConnect event
Applicable to
Application object
Description
Fires when Station connects to a server.
Syntax
OnConnect()
Example
This example adds the named variable myKey to the Application Dictionary, with
value 10.
Sub Application_OnConnect()
Application.Dictionary.Add "myKey", 10
End Sub
217
OnDisconnect event
Applicable to
Application object
Description
Fires when Station disconnects from a server.
Syntax
OnDisconnect()
Example
This example removes the named variable myKey from the Application
Dictionary.
Sub Application_OnDisconnect()
Application.Dictionary.Remove("myKey")
End Sub
EVENTS
OnDoubleClick event
Applicable to
Display objects
Description
Fires when a user double-clicks a display object.
Syntax
OnDoubleClick()
Remarks
• The OnDoubleClick event fires before the double-click action is processed.
This allows the event to be used in conjunction with the CancelDoubleClick
method to validate the action before sending it to the server.
Example
Sub Pushbutton1_OnDoubleClick()
.
.
.
End Sub
219
OnDownloadBegin event
Applicable to
Display objects (SafeBrowse objects only)
Description
Fires before a SafeBrowse object begins a download operation.
Syntax
OnDownloadBegin()
Example
This example sets the color of “Oval1” to red when downloading begins.
Sub SafeBrowse1_OnDownloadBegin()
Oval1.FillColor = vbRed
End Sub
EVENTS
OnDownloadComplete event
Applicable to
Display objects (SafeBrowse only)
Description
Fires after a SafeBrowse object is downloaded.
If the object is a HTML page that contains frames, the event fires as each frame is
downloaded, as well as when the page is downloaded. By contrast, the
OnPageComplete event is only fires after the page, and all its frames, have
downloaded.
Syntax
OnDownloadComplete()
Example
This example sets the color of “Oval1” to green after downloading has finished.
Sub SafeBrowse1_OnDownloadComplete()
Oval1.FillColor = vbGreen
End Sub
221
OnFocus event
Applicable to
Display objects
Description
Fires when a dynamic display object gets focus. (A dynamic display object is one
that can have focus.) Some display objects, such as checkboxes and
alphanumerics, are intrinsically dynamic; however, objects that are normally
static, such as rectangles and lines, are also dynamic if they are linked to the
database.
Syntax
OnFocus()
Example
This example sets a text object’s text when the checkbox receives focus.
Sub Checkbox1_OnFocus()
Text1.Value = "Checkbox1 Focus"
End Sub
EVENTS
OnLoad event
Applicable to
Display objects
Page object
Description
In the case of a display, the event fires when the display is first displayed.
In the case of a display object, the event fires when the display object is loaded
into the display.
Syntax
OnLoad()
Remarks
• An OnLoad script for an object may fail if it references another object that has
not yet been loaded.
Example
This example creates a 2-second timer for “Circle3” when it is loaded. (You
would then use the object’s OnTimer event to run another script.)
Sub Circle3_OnLoad()
CreateTimer(1, 2000)
End Sub
223
OnMenu event
Applicable to
Application object
Description
Superseded by the “OnMenu2 event” on page 225, however, is still supported for
scripts on DSP displays that use “InvokeMenu method” on page 191.
Used to assign custom additional script to the event.
Syntax
OnMenu(item)
Part Description
item The ID of the selected menu item.
Example
Assume the InvokeMenu method has been used with menu item 2113 (alarm
acknowledge). This fires an OnMenu event, which returns 2113.
The following script displays a message if the menu item is 2113.
Sub Application_OnMenu(lMenuTag)
If cint(lMenuTag) = 2113 Then
Application.MessageZoneText = "Notice: Alarm acknowledge"
End If
End Sub
EVENTS
OnMenu2 event
Applicable to
Application object
Description
Fires when a user selects a menu item and returns the menu item name. OnMenu2
is more flexible than the OnMenu event, taking a single string which indicates the
menu item name.
Syntax
OnMenu2(command)
Part Description
command The string identifying the name of the command. This is
the name of the command specified in the Station menu
and toolbar customization dialog box.
Example
This example displays a warning when a user selects the Acknowledge/Silence
menu item. In this example the name of the Acknowledge/Silence command is
“Acknowledge Alarm”. The script is:
Sub Application_OnMenu2(strMenuItem)
If (strMenuItem) = "Acknowledge Alarm" Then
MsgBox "WARNING: Alarm acknowledged"
End If
End Sub
225
OnMouseEnter event
Applicable to
Display objects
Description
Fires when the mouse enters the bounding rectangle of a display object.
Applies to all types of display object, except Lines, FreeHandLines and Polylines.
Syntax
OnMouseEnter()
Remarks
• The processing load increases significantly as the number of mouse events
being monitored increases.
• OnMouseEnter events should not be used for critical scripts because they are
given a low priority and are often discarded by the operating system.
Example
This example uses the OnMouseEnter and OnMouseLeave events to display an
explanatory message in the Station’s Message Zone whenever the mouse pointer
is on top of the display object, “MainValve”. The OnMouseEnter event displays
the description.
Sub MainValve_OnMouseEnter()
Application.MessageZoneText = "Main Valve"
End Sub
And the corresponding OnMouseLeave event clears the description when the
pointer leaves the object.
Sub MainValve_OnMouseLeave()
‘reset the message zone text
Application.MessageZoneText = ""
End Sub
EVENTS
OnMouseLeave event
Applicable to
Display objects
Description
Fires when the mouse leaves the bounding rectangle of a display object.
Applies to all types of display object, except Lines, FreeHand lines and
PolyLines.
Syntax
OnMouseLeave()
Remarks
• OnMouseLeave events should not be used for critical scripts because they are
Example
This example uses the OnMouseEnter and OnMouseLeave events to display an
explanatory message in the Station’s Message Zone whenever the mouse pointer
is on top of display object, “MainValve”. The OnMouseEnter event displays the
description.
Sub MainValve_OnMouseEnter()
Application.MessageZoneText = "Main Valve"
End Sub
And the corresponding OnMouseLeave event clears the description when the
pointer leaves the object.
Sub MainValve_OnMouseLeave()
‘reset the message zone text
End Sub
227
OnMouseMove event
Applicable to
Display objects
Page object
Description
In the case of the current display, the event fires when a user moves the mouse
over the display.
In the case of a display object, the event fires when a user moves the mouse over
the display object (excluding a SafeBrowse object).
Syntax
OnMouseMove(x, y)
Part Description
x Returns the horizontal coordinate of the mouse.
y Returns the vertical coordinate of the mouse.
Remarks
• OnMouseMove events should not be used for critical scripts because they are
• The mouse coordinates range from -266, -122 to 8257, 4568 if a user moves
the pointer over the border around the display. See “Mouse coordinates” on
page 241.
Example
This shows the current mouse coordinates in two text objects named “TextX” and
“TextY”.
Sub Page_OnMouseMove(lx,ly)
TextX.Value = lx
TextY.Value = ly
End Sub
EVENTS
OnNavigateComplete event
Applicable to
Description
Fires when a SafeBrowse object completes navigation to a URL.
Syntax
OnNavigateComplete()
Example
This example changes an object’s fill-color to green when navigation is complete.
Sub SafeBrowse1_OnNavigateComplete()
End Sub
229
OnOperatorChange event
Applicable to
Application object
Description
Fires when a user logs on, or when the user changes security levels.
Syntax
OnOperatorChange()
Example
This example shows how to display the appropriate “home page” when a user
logs on. Each display would display information appropriate to a particular
security level.
Sub OnOperatorChange()
If SecurityLevel = 2 Then
CurrentPage = "MainMenuOperator"
End If
CurrentPage = "http://www.../overview.htm"
End If
CurrentPage = 303
End If
CurrentPage = 304
End If
End Sub
EVENTS
OnOperatorCommand event
Applicable to
Application object
Description
Fires when a user issues a command from Station’s Command Zone.
Syntax
OnOperatorCommand(command)
Part Description
command The command entered by the user.
Remarks
• The OnOperatorCommand event fires before the command is processed. This
allows the event to be used in conjunction with the CancelOperatorCommand
method to validate the command before sending it to the server.
Example
This example checks the user’s security level and cancels the command if the
level is below Engineer (level 4 security).
Sub Application_OnOperatorCommand(bstrCommand)
If SecurityLevel < 4 Then
End If
End Sub
231
OnPageComplete event
Applicable to
Display objects (SafeBrowse only)
Description
Fires after a SafeBrowse object that includes a HTML page is downloaded.
Syntax
OnPageComplete()
Remarks
• OnPageComplete is equivalent to the OnDownloadComplete event if the
HTML page does not contain any frames.
Example
This example sets the color of “Oval1” to green after downloading has finished.
Sub SafeBrowse1_OnPageComplete()
End Sub
EVENTS
OnPageLoad event
Applicable to
Application object
Description
Fires when a new display is loaded, or when the current display is refreshed.
Syntax
OnPageLoad()
Remarks
• The equivalent events for the Page object is the OnLoad event.
Example
This example shows the current page name in the Message Zone.
Sub Application_OnPageLoad()
MessageZoneText = Page.CurrentPage
End Sub
233
Applicable to
Application object
Display objects
Page object
Description
Fires when Station receives a periodic update from the server. Periodic updates
occur whenever the server updates the system time in Station’s Status Line, and
OnPeriodicUpdate events fire for all display objects in the current display.
Syntax
OnPeriodicUpdate()
Example
This example animates a shapelink, stepping to the next shape on each periodic
update.
Sub Shapelink1_OnPeriodicUpdate()
Nextvalue = Nextvalue + 1
If Nextvalue > 4 Then
Nextvalue = 1
End If
End Sub
EVENTS
OnQuit event
Applicable to
Application object
Description
Fires when a user selects Station > Exit.
Syntax
OnQuit()
Example
This example changes an alphanumeric value when a user exits Station.
Sub Application_OnQuit()
MsgBox "Have a nice day!"
End Sub
235
OnRightClick event
Applicable to
Display objects
Description
Fires when a user right-clicks a display object.
Syntax
OnRightClick()
Remarks
• By default, right-clicking in Station gives focus to the next object in the tab
sequence. You can prevent the change in focus by including a CancelClick
method at the end of the script, as shown in the following example.
• The OnRightClick event fires before the right-click action is processed. This
allows the event to be used in conjunction with the CancelClick method to
validate the action before sending it to the server.
Example
This example, attached to “Pushbutton1”, displays a list of options when it is
right-clicked. CancelClick at the end of the script prevents focus changing to the
next object in the tab sequence.
Sub Pushbutton1_OnRightClick()
'display list of options
.
.
CancelClick
End Sub
EVENTS
OnTimer event
Applicable to
Application object
Display objects
Page object
Description
Fires at regular intervals, as determined by the associated timer. (Timers are
created using the CreateTimer method.)
Syntax
OnTimer(timer)
Part Description
timer Returns the ID of the timer.
Example
This example shows how an OnTimer event handler can perform several tasks for
an object that has several timers. In this case, “Tank2” has two timers.
Sub Tank2_OnTimer(lTimerID)
If lTimerID = 1 Then
.
.
.
ElseIf lTimerID = 2 Then
.
.
.
End If
End Sub
237
OnUnload event
Applicable to
Display objects
Page object
Description
OnUnload events fire for the current display and each of its display objects when
Station unloads the display (in preparation for displaying another display or
exiting Station).
Syntax
[object.]OnUnload()
Part Description
object The object being unloaded.
Remarks
• Scripts executed as the result of an OnUnload event must not contain any
message boxes, input boxes or dialog boxes.
Example
Sub Page_OnUnload()
.
.
.
End Sub
EVENTS
OnUpdate event
Applicable to
Display objects
Description
Fires when a display object is updated by the server, or because its Update
method was called.
Syntax
OnUpdate()
Example
Sub Alphanum1_OnUpdate()
Text1.Value = 2 * Alphanum1.Value
End Sub
239
Applicable to
Application object
Page object
Description
Fires when an automation object calls the UserObjectNotify method. (The
method is used by automation objects that may require significant processing
time, thereby avoiding script timeouts.) See “UserObjectNotify method” on
page 210.
Syntax
OnUserObjectNotify(lID, vParam)
Part Description
lID ID that identifies the object that fired the event.
vParam The variant used to return data to the script.
ABOUT DISPLAY COORDINATES
About display coordinates

Display Builder uses logical coordinates, which are independent of screen
resolution. The logical coordinates for a display range from 0, 0 (top, left) to
4499, 7999 (bottom, right).
Mouse coordinates
When a user views a display in Station, it is surrounded by a small border region,
as shown in gray in the following figure. This region is used, for example, by
scrollbars where the display is larger than the screen.
Inside the display, the mouse coordinates range from 0, 0 to 4499, 7999.
However, if a user moves the pointer over the border region, the coordinates
range from -122, -266, to 4568, 8257.
Figure 54 Mouse coordinate ranges
-122, -266
0, 0
4499, 7999
4568, 8257
Converting between logical and display coordinates

When a display is called up on a particular Station, the computer uses the
resolution-dependent display coordinates (expressed in pixels). To convert from:
• Logical to display coordinates, use the LPToDPX and LPToDPY methods
• Display to logical coordinates, use the DPToLPX and DPToLPY methods
241
Examples
The following examples demonstrate how scripts can be used.
The \dspbld\examples folder contains a number of example displays, such as
xsmscript.dsp (a numbered display, whose number is 801) which contains an
ActiveX script.
EXAMPLES
Animation using a shape sequence

This example shows how to use scripts and a shape sequence to create an
animation. The following figure shows part of a display that contains a shapelink
for the fan and two control buttons, Start and Stop.
Figure 55 A simple animation
When inserting the shapelink for the fan, you don’t have to specify how many
shapes you want to use—this is controlled by your scripts.
The following shape sequence is used to represent the two states of the fan. The
first (left-hand) shape represents the “off” state, whereas the other four shapes are
used for the “on” animation.
Figure 56 The shape sequence used in the animation
These shapes are bitmap images that were created in a drawing program and then
pasted into the shape file. Creating the shapes this way made it easier to produce a
more realistic effect.
Start button scripts

The Start button has scripts for the OnClick and OnTimer events.
The OnClick script creates a 200ms timer, which controls the speed of the
animation. (Obviously, the pushbutton is configured to start the actual fan.)
Sub StartBtn_OnClick()
Call CreateTimer(1, 200)
End Sub
243
The OnTimer script steps through the four “on” shapes. (Values 2 to 5.)
Sub StartBtn_OnTimer(lTimerID)
If Fan.Value = 5 Then
Fan.Value = 2
Else
Fan.Value = Fan.Value +1
End If
End Sub
Stop button script

The Stop button has an OnClick script that stops the animation and selects the
“off” shape. (Again, the pushbutton is also configured to stop the fan.)
Sub StopBtn_OnClick()
StartBtn.KillTimer(1)
Fan.Value = 1
End Sub
EXAMPLES
Color animation
You want to change the color of the heat exchanger plates as the temperature
varies. The plates are grey rectangles, which are grouped to form one object,
“Plates”.
The OnPeriodicUpdate event for Plates iterates over the rectangles, changing the
surface color in line with the temperature, which is stored in an alphanumeric
object called “alphanum1”.
Figure 57 A color animation
Sub OnPeriodicUpdate()
Dim Temp
Dim RedComp
Dim BlueComp
Dim GreenComp
Temp = alphanum1.value
‘work out the values of the color components
RedComp = 126.0 + ((300.0 - Temp) / (300.00 - 20.0) * 255.0)/2
BlueComp = 126.0 - ((300.0 - Temp) / (300.00 - 20.0) * 255.0)/
2
GreenComp = 126.0 - ((300.0 - Temp) / (300.00 - 20.0) *
255.0)/2
For Each rect in Objects
rect.FillColor = Application.MakeColor(RedComp,
BlueComp, GreenComp)
Next rect
End Sub
245
Adding tool tips

To help new users learn about the system, you may want to provide a simple
description for each object which operates in a similar manner to Tool Tips—a
feature found on many Windows-based applications.
You create the Tool Tips feature using two events, OnMouseEnter and
OnMouseLeave. This example is for an object called “Gauge1”.
You use the OnMouseEnter event to display the description whenever a user
moves the pointer over an object.
Sub Gauge1_OnMouseEnter()
Application.MessageZoneText = "Main compressor temperature"
End Sub
And you use the OnMouseLeave event to clear the description when the pointer
leaves the object.
Sub Gauge1_OnMouseLeave()
‘clear the message zone text
End Sub
EXAMPLES
Controlling Station from another application

You have decided to create a training support tool, written in Visual Basic, that
presents trainee operators with a series of interactive flow charts they must work
through. To improve usability, the support tool instructs Station to display the
appropriate display at various stages in a procedure.
The support tool needs to create an instance of Station as an Automation
component during its initialization using the following command:
Set stationApp = CreateObject("Station.Application")
Whenever the support tool needs Station to display a particular display (such as
“301”), it uses the following command to instruct Station to display that display.
stationApp.CurrentPage = 301
247
Controlling another application from Station

You want to delete custom displays that are not being used by anybody. So you
decide to monitor display usage for several weeks and then delete displays that
were not used during that period.
You create a Visual Basic Automation component that exposes the following
method:
Public Sub RecordDisplayUsage(page As Integer, station As
Integer)
The implementation details of this method are unimportant, but could include
using an Access database to record how many times each display is called up.
The Visual Basic Automation component is registered in the system registry as
“DisplayMonitor.Application”.
In the Station’s scripts

In the Station’s General section you declare a variable that is used to store a
reference to the DisplayMonitor application.
Dim DisplayMonitor
In the Station’s OnAppStartUp event handler you create an instance of the
DisplayMonitor application.
Sub OnAppStartup()
Set DisplayMonitor =
CreateObject("DisplayMonitor.Application")
End Sub
In the Station’s OnPageChange event handler you pass the display number to the
DisplayMonitor’s RecordDisplayUsage method.
Sub OnPageChange()
DisplayMonitor.RecordDisplayUsage(CurrentPage, StationNumber)
End Sub
EXAMPLES
Using the Document property

The Document property of SafeBrowse and ActiveX Document objects gives a
script access to the automation object of the active document (if any) that is being
shown in the Web Browser. This allows scripts to both read and change elements
in a Dynamic HTML page, and to have full access to the automation object of an
application that the Web Browser is hosting.
The properties and methods available in the document object returned depend on
the document type. An error (property or method not supported) is returned if a
property or method that does not exist is called.
The following example illustrates how the Document property can be used for a
SafeBrowse object displaying an Excel worksheet. The script queries the name of
the current application and then sets a value in the spreadsheet. Two methods of
accessing the document property are shown, the first via a variable and the second
directly. It is important to release the reference to Excel in the appExcel variable
so that Excel shuts down when leaving the page.
Dim appExcel
' Set the variable to the Doc's App object (Excel)
Set appExcel = safebrowse1.Document.Application
' Display the name in a message box
MsgBox appExcel.Name
' Now free the reference to the application

Set appExcel = Nothing
' Now reference the doc and set value of the current cell
safebrowse1.Document.Application.ActiveCell.Value = 12
249
Guidelines for creating user-
friendly displays 6
The aim of this chapter is to help you create well designed and user-friendly
displays.
When designing displays it is important to keep the following principles in mind:
• Involve users and try to see the system from their perspective. It is a good idea
to involve users throughout the design and testing process. This helps you
focus on the design of the displays, and the tasks users need to perform.
• Use design elements consistently throughout all displays. Users will then
know how to interpret a display even if they have never seen it before or use it
infrequently.
• When providing users with options, use check boxes and combo boxes (lists
of valid choices), rather than forcing them to enter an obscure code or number.
• Avoid creating displays that are cluttered or have a haphazard layout. Well
designed displays are easier to understand and easier to use.
251
6 – GUIDELINES FOR CREATING USER-FRIENDLY DISPLAYS
General standards
The following general standards apply to all system displays and can be used to
help you create consistent custom displays. You may use them as the basis for
creating your own style guide.
Using title bars

Every display includes a display title bar.
Using color
You need to design displays that are legible on any user selectable background
color. (The system displays use an embedded background graphic that overrides
the user selected background.)
Limit the use of color to either special conditions such as alarms and indicators,
or to show relatedness (on trend displays for example) by color keying. Do not
use color in an arbitrary manner. Too many colors or activity on a display leads to
confusion.
Color is very effective in indicating different states. However, do not rely on color
alone to indicate a state. Use color as a separate indicator showing redundant
information. For example, you could use a text box beside an LED style dynamic.
Using animation
The principles that apply to color also apply to animation. Too much activity on a
display can lead to confusion. Use animation sparingly for the most effective
results.
Using navigation aids

Use multiple navigation paths to cater for different user experience, preference
and input devices. Navigation aids include menus, accelerator keys (sometimes
known as shortcut keys), menu displays, and toolbars.
Use menus and menu displays for navigation to each subsystem at a summary
level. Use navigation buttons for navigation within a subsystem.
Use toolbar buttons only as a quick, redundant path to displays of system-wide
importance.
Keep the depth of any hierarchy to three levels or less, including cascading
menus.
GENERAL STANDARDS
Keeping to the text standards

Use mixed case capitalization for headings and labels. Use lower case for
extended bodies of text. Avoid acronyms and abbreviations.
Keep your message simple and direct by:
• Concentrating on user tasks rather than how Station and the server uses the
information.
• Avoiding assumed knowledge of the database structure.
• Avoiding colloquial language.
• Being conscious of international users and translation issues.
Designing layouts
In general, favor an asymmetric layout. Make use of blank regions to provide
balance and promote legibility.
Use similar layouts for similar displays or groups of information. For example,
make all report detail similar.
Align display components in a visually intelligible manner, based on an
underlying grid.
Use existing displays as templates for any new displays.
Layering
Layer displays so that the display title bar (and its elements) is displayed first,
followed by other display components from the top left to the bottom right in
order.
253
Title bar
The title bar describes the contents or purpose of the display.
As a minimum, a title bar should show the (static) title and, if appropriate, an icon
for visual reinforcement. If the display contains a dynamic item or view (for
example, point detail displays show one specific point at a time), show the current
item or view as an additional dynamic title. Other dynamic objects such as combo
boxes or data entry boxes that define the display view can also be shown.
Locate navigation push buttons that call up related displays, but which do not
indicate the display contents, on the right of the display title bar. In this way the
right hand side of the title bar can be used like a display-specific toolbar,
removing clutter and distraction from the display and reinforcing the function of
buttons in this position.
Figure 58 Typical title bars
GENERAL STANDARDS
Alphanumeric data boxes and labels

Alphanumeric data boxes present dynamic information. These boxes are always
selectable but may or may not be editable. Labels are static text that identify these
alphanumeric boxes.
Distinguish editable alphanumerics by using an indented border style. (Omit the
border for non-editable alphanumerics.)
Acronyms and abbreviations

Try to avoid using acronyms and abbreviations unless they aid legibility.
Sizing and alignment

The size of data boxes depends to some extent on the type of data being
presented, however try to make the boxes a uniform size. Align boxes on the
display. Left-align groups of labels.
Editable versus non-editable boxes

Indent editable boxes so that users can distinguish them from non-editable boxes.
If you do use a border for non-editable boxes, use a grooved border, so that the
box remains on the same plane as the background.
Figure 59 Editable boxes
255
Pushbuttons and hyperlinks

Pushbuttons are used for navigation and task activation. Use a similar style for all
pushbuttons. The button contents can be blank or consist of a text label, a graphic
or both. Hyperlinks are made by positioning an invisible button over blue
underlined text.
Make sure that text is simple but descriptive/explanatory. If this is difficult, it may
be because the information needs to be reorganized so that it can be described
more easily.
Do not use labels on repeated pushbuttons; instead use a label to identify all the
pushbuttons.
Graphic pushbuttons
You can use graphics on pushbuttons:
• To save space when the item is redundant anyway (for example, display title
pushbuttons). The experienced user can use these buttons when the graphics
become familiar.
• To reinforce the text description and make it quick and easy to recognize (for
example, menu displays).
• To be used in conjunction with icons that are associated with the titles of the
displays being called up (for example, menu displays) so that the icon is
reinforced.
To create a graphic pushbutton:

1 Start with a light gray rectangle as the background (ensure you send it to the
back).
2 Draw a pushbutton of the same size with a light gray line style, and
transparent background (a background with no fill), and bring it to the front.
3 Delete the pushbutton’s default text.
4 Place the graphic on top.
Keep the graphic/icon simple.
Figure 60 Graphic pushbuttons
Text pushbutton Graphic pushbutton Graphic and text pushbutton
GENERAL STANDARDS
Comboboxes
Comboboxes are used for selecting one item from a list, which appears when the
combobox is selected. The currently active choice will appear in the combo box.
Use a white background and black text.
Figure 61 An example combo box with a selected item
Figure 62 An example combo box with list displayed
257
Checkboxes
Checkboxes are used for toggling the state of an item. The checkbox is checked
when the item is enabled and is white when disabled.
Only use a checkbox when a user can manually change the state (at some security
level). Otherwise, use “LED indicators”.
Use a white background and black text.
Figure 63 Typical checkboxes
GENERAL STANDARDS
Group headings
You can use group headings to organize the information on your display so that it
is easier to comprehend.
As a general rule, use no more than eight group headings (or other items mixed
with group headings) on a display. If the display becomes cluttered, either
reorganize the information into different frame headings or use more than one
display.
Figure 64 Examples of group headings
259
Tables
Tables can include alphanumeric data boxes, combo boxes, push buttons and
check boxes. Large tables can use a scroll bar.
A table consists of a “table heading” and body of the table. The scroll bar is
optional.
The “table heading” identifies each column of the data. Each table row is
uniquely identified by one (or more) index fields that form part of the tabular
data. These index fields can be thought of as the “independent variable(s)” in the
table.
Add a scroll bar to a table if there are more rows than can be shown on the
display.
Attention Application Programmers, ensure data that you want to be able to scroll is
laid out so that you can use record or field indexing to each line in the
table. The advantages of using a table with scroll bar are substantial, as:
• No extra displays are required
• The display is not redrawn as you scroll—only the records change
• The scroll box indicates what view of the total data you are seeing
• You can scroll by individual records or by pages of records
Figure 65 A typical table
GENERAL STANDARDS
Icons
Icons are used to reinforce display titles and also for navigation. An icon should
be a simple graphic symbol rather than a “real” picture.
When associated with display titles, icons help the user identify the display as
belonging to a certain subsystem or relevant to a particular subject. You can
reinforce this by using icons on menu pages and their push buttons. When these
buttons are pressed a display containing that icon is called up. For the experienced
user then, iconic push buttons on the toolbar and display title bar provide a quick
means of navigation.
When creating icons, keep the following points in mind:
• Simple icons are easier to remember and are less likely to appear
unprofessional.
• Limit the number of icons to fairly broad categories of the application.
• Re-use the icons in as many related areas as possible. The more frequently an
icon appears, the more likely it will be remembered. For example, you could
use a magnifying glass icon for all point detail displays.
• Reinforce icons with text (where space permits) to assist in the learning
process.
Consider using icons in the following locations:
• Preceding the display title
• Navigation push buttons on the right hand side of the display title bar
• Menu displays associated with text
Figure 66 Icons on a toolbar
261
Faceplates and LEDs

Faceplates and LEDs appear on displays that emulate control panel
instrumentation. LEDs are used redundantly as state indicators.
Faceplates and LEDs are not intended to be photo-realistic, but are there to
reinforce a mental model of the system.
Keep the design as simple as possible. The aim is to suggest a real-world device,
not reproduce it. Too much detail is superfluous. Use a similar layout and style for
similar types of faceplates. Use existing faceplates as a basis.
Figure 67 Typical faceplates
FURTHER READING
Further reading
The following references contain more material on human-computer interface
design:
Laurel. B., Ed. (1990) The Art of Human-Computer Interface Design. Wellesley,
MA: Addison-Wesley.
Articles and essays by leaders in HCI. Easy to read with lots of interesting history
and information.
Norman, D. (1988). The Design of Everyday Things. New York: Basic Books.
Great information about designing for usability from a wide range of fields.
Shneiderman, B. (1992). Designing the User Interface: Strategies for Effective
Human-Computer Interaction. Reading, MA: Addison-Wesley.
A synthesis of computer science and psychology. Deals with the human factors
aspects of several types of system.
Tognazzini, B. (1992). Tog on Interface. Reading, MA: Addison-Wesley.
A good expose on the Apple Macintosh user interface.
263
Tutorial
7
This tutorial shows you how to create the simple display shown below.
In this tutorial you learn how to:
• Draw and group display objects
• Link display objects to the database
• Animate display objects
• Link to another display using a push button
• Save the display so that it can be called up in Station
Figure 68 The display you create in the tutorial
265
7 – TUTORIAL
Setting up the drawing window

When you start Display Builder, a blank drawing and several toolbars appear. If
the layout is not ideal, you can move and resize the drawing, and move the
toolbars to suit your particular needs.
Figure 69 Setting up the drawing window
Setting the background color

In this tutorial, the background color is light-grey.
To set the display’s background color:

1 Choose View > Options to open the Options dialog box.
2 Select light-grey from the Page background color property.
3 Click OK.
Activating snap-to-grid
The snap-to-grid function makes it much easier to align display objects.
To activate snap-to-grid:
1 Click the Snap-to-Grid tool— —on the Arrange toolbar. Note that you can
turn off the function by clicking the tool a second time.
You can display the names of tools by moving the pointer slowly over the tools.
DRAWING THE OBJECTS
Drawing the objects
Drawing the title

You are about to draw the display’s title, “Tank Level”, in 18 point Times New
Roman.
To draw the title:

1 Select Times New Roman from the Font tool.
2 Select 18 from the Font Size tool.
Selecting the font and size while no text is selected changes the default font
and size. From now on, 18 point Times New Roman will be used whenever
you create a new object that contains text.
3 Click the Text tool on the Toolbox toolbar.
4 In the display, click where you want the title to start. A flashing bar-shaped
cursor marks the position of the first character.
5 Type Tank Level. If you make a mistake you can press BACKSPACE to
delete unwanted characters.
Figure 70 Drawing the title
267
7 – TUTORIAL
Drawing the pump

You are about to draw a red pump, comprising a circle and a rectangle that are
grouped together.
To draw the circle:

1 Click the Oval tool on the Toolbox toolbar. When you move the pointer to the
display, it changes to a cross-hair to help you draw the circle accurately.
2 Hold down SHIFT and drag the pointer diagonally across the drawing. As you
drag a dotted circle appears.
Holding down SHIFT forces Display Builder to draw a circle. If you want to
draw an oval, don’t hold down SHIFT.
3 Release the mouse button when the circle is an appropriate size.
Figure 71 Drawing the circle for the pump
To draw the rectangle:

1 Click the Rectangle tool on the Toolbox toolbar.
2 Starting at the top of the circle, drag diagonally down and to the right.
3 Release the mouse button when the rectangle is the correct size.
DRAWING THE OBJECTS
Figure 72 Drawing the rectangle for the pump
You can now group the circle and rectangle:

1 Click the Pointer tool on the Toolbox toolbar.
2 Starting above and to the left of the two objects, drag diagonally across them.
As you drag, a dotted rectangle appears.
3 Release the mouse button when both objects are entirely within the dotted
rectangle. When you release the mouse button both objects are selected, as
indicated by their selection handles.
4 Click the Group tool on the Arrange toolbar. The two objects are now, in
effect, one object.
You can now change the pump’s fill and line colors:
1 Click the Fill Color tool on the Format toolbar and select red from its color
palette.
2 Click the Line Color tool and select “X” (which represents transparent) from
its color palette.
Changing the color (or any other property) of a selected object only changes that
object’s color—it does not change the default color.
Moving and resizing the pump

Now that you have drawn the pump, you may want to move or resize it.
Because you activated the snap-to-grid function at the start of this tutorial,
moving and resizing an object are “jerky” operations. If you want fine control,
269
7 – TUTORIAL
disable the snap-to-grid function by clicking the Snap-to-Grid tool on the

Arrange toolbar.
To move the pump:

1 Click the pump to select it.
2 While the pointer is over the pump, drag it as required.
To resize the pump:

1 Click the pump to select it.
2 Hold down SHIFT and drag on one of the corner handles until the pump is the
correct size.
DRAWING THE OBJECTS
Drawing the tank

You are about to draw a tank, which consists of a “U” shaped polyline object. The
object has a raised line style to give a 3D effect.
To draw the tank:

1 Click the Polyline tool on the Toolbox toolbar.
2 Mark the first two vertices of the tank by clicking.
3 Mark the third vertex by double-clicking. (Double-clicking indicates that this
is the object’s last vertex.)
Figure 73 Drawing the tank
Setting the tank’s colors and line style
To set the tank’s colors and line style:

1 Click the tank to select it.
2 Select from the Line Color tool on the Format toolbar. This sets the line
color to the page background color.
3 Choose Format > Line Style > 4 pixels to set the line’s thickness.
4 Choose > Format > Effects > Ridged to produce a suitable “3-D” effect.
5 Select black from the Fill Color tool to set the color of the tank’s surface to
black. Note that this does not have any visible effect at the moment—
however, you will see the effect shortly.
271
7 – TUTORIAL
Drawing the pipe

You are now about to draw the pipe which connects the pump to the tank. A
polyline object with a ridge-shading line style is used to draw the pipe.
To draw the pipe:

1 Click the Polyline tool on the Toolbox toolbar.
2 Click to mark the start of the pipe, below and to the left of the pump.
3 Click to mark the vertex immediately below the pump.
4 Click to mark the vertex inside the pump.
5 Double-click to mark the end of the pipe.
Figure 74 Drawing the pipe
Setting the pipe’s line style and color
To set the pipe’s line style and color:

1 Click the pipe to select it.
2 Select from the Line Color tool on the Format toolbar. This sets the line
color to the page background color.
3 Choose Format > Line Style > 4 pixels.
4 Choose Format > Effects > Raised.
DRAWING THE OBJECTS
Putting the pipe behind the pump

At the moment, your display looks odd because the pipe is “on top of” the pump.
You are now going to fix this by putting the pipe behind the pump.
To put the pipe behind the pump:

1 While the pipe is still selected, click the Send To Back tool on the Arrange
toolbar. This moves the selected object to the bottom of a stack of objects.
Figure 75 Putting the pipe behind the pump
273
7 – TUTORIAL
Drawing and configuring the alphanumeric

You are about to draw an alphanumeric, link it to a point and set its display
characteristics.
To draw and configure the alphanumeric:

1 Click the Alphanumeric tool on the Toolbox toolbar.
2 Drag diagonally under the tank and release the mouse button when the
rectangle is an appropriate size. The alphanumeric, containing “9999.99”,
appears. You may need to resize the alphanumeric so that it is deep and wide
enough to display real values.
3 Select the alphanumeric.
4 Click the Properties Window tool on the View toolbar. The Properties
Window appears, showing the alphanumeric’s current properties.
If necessary, you can move the Properties Window so that it doesn’t obscure
the display.
Figure 76 Configuring the alphanumeric
5 Click the Data tab and select Point/Parameter from the Type of database
link property.
6 Type tanklevel (this is a point’s ID) in the Point property.
If you are creating the display on the server, Point will contain a list of all
database points. So, rather than typing the point ID, you simply select it from
the list.
DRAWING THE OBJECTS
7 Select PV from the Parameter property.

8 Click the Details tab and select Numeric from the Display as property.
9 Clear the Floating decimal point check box and type 2 in the
Number of Decimals box.
275
7 – TUTORIAL
Drawing and configuring the push button

You are about to draw a push button, labelled “Overview”, and configure it so
that, when pressed, it calls up another display called “summary.dsp”.
To draw and configure the push button:

1 Click the Push button tool on the Toolbox toolbar.
2 Drag out a rectangle for the push button.
3 Select the push button.
4 Select light gray from the Fill Color tool on the Format toolbar.
Figure 77 Adding the push button
The Properties Window always shows the properties of the selected object(s).
Consequently, it now shows the push button’s properties.
5 Click the Details tab on the Properties Window.
6 Type Overview in the Label property.
7 Select Callup Page from the Action property and type Summary in the Page
property. (Note that you do not have to add the filename’s extension.)
DRAWING THE OBJECTS
Animating the pump

You are now about to configure the pump so that its color changes when the point
pumpsts changes state. The pump is to be red when the state is 0 and green when
the state is 1.
To animate the pump:

1 Select the pump. Note how the Properties Window now displays the pump’s
properties.
link property.
3 Type pumpsts in the Point property.
5 Click the Animation tab.
6 Select Color breakpoints from the Type of animation property.
7 Select Discrete from the Type of breakpoint property.
8 Select Red from the Color box for State 0, and Green from the Color box for
State 1.
277
7 – TUTORIAL
Animating the tank with level fill

You are about to configure the tank so that it appears to fill (or empty) as the value
of the analog point, tanklevel, changes.
To configure the tank:

1 Select the tank. The Properties Window now displays the tank’s properties.
link property.
3 Type tanklevel in the Point property.
5 Click the Animation tab.
6 Select Level fill from the Type of animation property.
7 Select Continuous from the Type of breakpoint property.
8 Click the 0 to 100 (top-left) color box and select cyan from the color palette.
(With this selection, the color remains the same regardless of the fill level.
However, you could specify up to nine colors, each of which represents a
particular fill range. For example, you could select red for levels between 0%
and 10%, orange for levels between 11% and 20% and so on.)
Figure 78 Animating the tank with level fill
SAVING THE DISPLAY
Saving the display

You are about to give the display a title and save it as “tutorial.dsp”. (The title
appears on the Display Summary in Station.)
To give the display a title and close it:

1 Click a blank part of the display (away from any object). The Properties
Window now shows the display’s properties.
2 Click the General tab and type Tutorial Display in the Title property.
3 Choose File > Close. A prompt appears.
4 Click the prompt’s Yes button. The Save As dialog box appears.
5 Type tutorial.dsp in the File Name box and then click Save to close the
dialog box.
279
7 – TUTORIAL
Reference information
8
For information about: Go to:
Keyboard shortcuts page 282
The shortcut menu, which appears when you right-click page 283
Point detail displays page 284
Using Display Builder’s command-line commands page 287
DisplayInfo, a command-line information extraction tool page 288
281
8 – REFERENCE INFORMATION
Keyboard shortcuts
Command Shortcut
Arrange > Align > Bottom> CTRL+Y
Arrange > Align > Center CTRL+W
Arrange > Align > Left CTRL+Q
Arrange > Align > Middle CTRL+T
Arrange > Align > Right CTRL+E
Arrange > Align > Top CTRL+R
Arrange > Bring to Front CTRL+L
Arrange > Group CTRL+G
Arrange > Send to Back CTRL+K
Arrange > Ungroup CTRL+F
Edit > Copy CTRL+C
Edit > Cut CTRL+X
Edit > Delete DELETE
Edit > Duplicate CTRL+D
Edit > Paste CTRL+V
Edit > Select All CTRL+A
Edit > Undo CTRL+Z
File > New > Display CTRL+N
File > Open CTRL+O
File > Print CTRL+P
File > Save CTRL+S
USING THE SHORTCUT MENU
Using the shortcut menu

If you right-click (press the right mouse button), the shortcut menu appears next
to the pointer.
Figure 79 Shortcut menu
Select this: To:

Cut Cut the selected object to the clipboard.
Copy Copy the selected object to the clipboard.
Paste Paste the contents of the clipboard near the center of the
display.
If Paste is gray, it means the clipboard is empty.
Delete Deletes the selected object(s).
Align Select an alignment option for the selected objects.
Group Group the selected objects.
Break Group Ungroup the selected object(s).
Properties Open/close the Properties Window.
Script Open the Script Editor window.
283
Creating a point detail display

A point detail display is used to display point information for all points of a
particular type. For example, there is one point detail display for status points,
another for analog points and so on.
Each time you create a new type of container, process or flexible point, you must
create a corresponding point detail display. You then add an appropriate display
object—such as an alphanumeric or indicator—for each parameter you want
users to see.
The following procedure summarizes the special steps required when creating a
template display.
To create a point detail display:

1 Open a new display.
2 Select View > Properties Window to open the Properties Window.
3 Set Type to Point Detail.
4 Give the display an appropriate Title. For example, make it the same as the
name of the point type.
5 Add an appropriate display object for each parameter you want users to see.
6 Configure the Data tab properties for each of these display objects, specifying
the address details using the corresponding format:
• Container point format
• Flexible point format
• Process point format
Container point format
Type of database link Select Point/Parameter.
Point Leave blank.
CREATING A POINT DETAIL DISPLAY
Parameter The syntax is: Alias.Parameter
Where:
• Alias is the name you defined in Quick Builder for
the “contained” (child) point
• Parameter is parameter name.
For example, if you wanted to display the PV of a
contained point whose alias is “HoursRun”, you would
type: HoursRun.PV
If you allow data entry, select the minimum Security
Level required to change the value.
Flexible point format
Point Leave blank.
Parameter The parameter name.
Process point format
Point The name of the control module.
Parameter The syntax is: ContainedObject.Parameter
Where:
• ContainedObject is the contained CM within the
point, or a basic block (for example, a PID)
• Parameter is the name of the parameter within the
contained block
285
USING DISPLAY BUILDER’S COMMAND-LINE PARAMETERS
Using Display Builder’s command-Line parameters

You can invoke Display Builder from the command line to open or export any
display (system or custom).
Syntax
To open a display:
dspbld displayname.dsp
To export a display:
dspbld -e|-es displayname.dsp [-out outfilename]
Part Description
-e Exports the display, and displays a warning message if
any display object references a non-existent point ID.
-es Exports the display, but suppresses any warning
messages.
displayname.dsp The display that is exported.
-out outfilename Display Builder writes any warning messages to this
file.
Notes
If you use -e or -es:
• Both Display Builder and the display must be on the server.
• Display Builder is not invoked interactively, which means that you cannot
modify the display.
287
Using DisplayInfo
DisplayInfo is a command-line utility that allows you to examine various display
details.
Syntax
displayinfo [options] displayfile
Part Description
options The options, which can be any order:
-d Provides details about the display objects.
-l Provides a shapelink summary.
-p Provides details about points referenced in the
display.
-s Lists scripts.
-v Generates a verbose (detailed) output.
displayfile The name of the display.
Example
The following example shows the results if you use DisplayInfo without any
options:
DisplayInfo r### ...
Filename : MainBoiler.dsp
Type : Standard display
Title : Boiler Statuses
Last saved : Tue Aug 14 21:35:24 1998
File version : r###.# (0x22)
Total objects : 53
Total scripted objects : 16
Total dependent shapelinks : 3
Glossary
acronym
An acronym is a text string that is used to represent a state or value of a point in a
display. From an operator’s point of view, it much easier to understand the
significance of an acronym such as “Stopped”, compared with an abstract value
such as “0”.
ActiveX component
An ActiveX component is a type of program designed to be called up from other
applications, rather than being executed independently. An example of an
ActiveX component is a custom dialog box, which works in conjunction with
scripts, to facilitate operator input into Station.
alarm
An indication—visual and/or audible—that alerts an operator at a Station of an
abnormal or critical condition. Alarms can be assigned either to individual points
or for system-wide conditions, such as a controller communications failure.
algorithm
See point algorithm.
analog point
A point type that is used to represent continuous values that are either real or
integer. Continuous values in a process could be: pressure, flow, fill levels, or
temperature.
application program
A user-written program integrated into Experion using the Application
Programming Interface (API).
asset
(Previously called area.) A representation of entities such as plant equipment,
facilities, buildings. Operators or Stations can be assigned access to particular
assets only.
bad value
A parameter value, (for example, PV), that is indeterminate, and is the result of
conditions such as unavailable input.
289
GLOSSARY
Client software
An umbrella term covering Experion, Quick Builder, Station, and Display Builder
software.
collection
A collection is a set of named values or display objects that are used in scripts.
default
The value that an application automatically selects if the user does not explicitly
select another value.
display
Station uses displays to present Experion information to operators in a manner
that they can understand. The style and complexity of displays varies according to
the type of information being presented.
Displays are created in Display Builder.
display object
A display object is a graphic element, such as an alphanumeric, a push button or a
rectangle, in a display.
Display objects that represent point information (such as an alphanumeric) or
issue commands (such as a push button) are called “dynamic” display objects.
event
Can have either of two meanings:
• Within the context of the system, an event is a significant change in the status
of an element, such as a point or piece of hardware. Some events have a low,
high, or urgent priority, in which case they are further classified as alarms.
Events can be viewed on an operator Station display and included in reports.
• Within the context of scripts, an event is a change in system status or an
operator-initiated action that causes a script to run.
export
The process of registering a numbered display with the server so that it can be
called up in Station.
group
A group of up to eight related points whose main parameter values appear in the
same group display.
GLOSSARY
history
Point values stored to enable tracking and observation of long-term trends.
Analog, status, and accumulator point PVs can be defined to have history
collected for them.Three types of history collection are available:
• Standard
• Extended, and
• Fast
local display object
A dynamic display object that displays information or issues a command, but
which is not linked to the server. Such display objects are used in conjunction
with scripts.
method
A programmatic means of controlling or interrogating the Station Automation
object model. A method is equivalent to the terms “function” or “command” used
in some programming languages.
Mode
A point parameter which determines whether or not the operator can control the
point value. For example, in a status point, the mode determines whether the
operator can control the output value
operator ID
A unique identification assigned to each operator. If operator-based security is
enabled, the operator must use this ID and a password to sign on to a Station.
operator password
A character string (not echoed on screen) used with the operator ID to sign on to
an operator Station.
operator security level
Experion has six security levels defined for performing operations. An operator is
assigned a security level and may perform functions at or below that security
level.
operator-based security
An operator-based security comprises an operator ID and password, which must
be entered at an operator Station in order to access Experion functions.
291
GLOSSARY
Output
A point parameter used to issue control values. The output (OP) is often related to
the mode (MD) parameter and can be changed by an operator only if the mode is
manual.
point
A data structure in the server database, usually containing information about a
field entity. A point can contain one or more parameters.
point algorithm
A prescribed set of well-defined rules used to enhance a point’s functionality. The
point algorithm accomplishes this by operating on the point data either before or
after normal point processing.
There are two types of point algorithms, PV (processed every time the point
parameter is scanned) and Action (processed only when a point parameter value
changes).
Point Detail display
A display that shows the current point information. Each point has a Point Detail
display.
process variable
An actual value in a process: a temperature, flow, pressure, and so on. Process
variables may be sourced from another parameter and may also be calculated
from two or more measured or calculated variables using algorithms.
property
In Display Builder a property is attribute or characteristic of an object within the
Station Automation object model. For example, a display object has properties
that define its height, width and color.
PV algorithm
One of two types of algorithm you can assign to a point in order to perform
additional processing to change point parameter values. A PV algorithm changes
the value of the point process value (PV) input only. Contrast with Action
algorithm.
report
Information collected by the server database that is formatted for viewing. There
are several pre-formatted reports, or the user can customize a report. Reports may
be generated on demand or at scheduled intervals. Reports can be printed or
displayed on an operator Station.
GLOSSARY
SafeBrowse object
A SafeBrowse object is a Web browser specifically designed for use with Station.
SafeBrowse includes appropriate security features that prevent users from
displaying unauthorized Web pages or other documents in Station.
script
A script is a mini-program that performs a specific task. Scripts use the Station
Automation object model to control and interrogate Station and its displays.
security level
Access to Experion functions is limited by the security level of the operator.
Experion has six security levels.
server
The computer on which the Experion database software runs.
Server software
An umbrella term used to refer to the database software and server utilities
installed on the Experion server computer.
server Station
A computer running both the Experion database (server) software and the Station
software. This computer can also be used as an operator Station.
setpoint
The desired value of a process variable. Setpoint is an analog point parameter, and
the value is entered by the operator. The setpoint can be changed any number of
times during a single process. The setpoint is represented in engineering units.
shape
A shape is a special type of display object that can be used in numerous displays.
Shapes can be used as “clip-art” or as shape sequences.
shapelink
A shapelink is, in effect, a “window” which always displays one shape of a shape
sequence. For example, a shapelink representing a point’s status displays the
shape that corresponds to the current status.
shape sequence
A shape sequence is a set of related shapes that are used in conjunction with
shapelinks. A shape sequences can be used to:
• Represent the status of a point. (Each shape represents a particular status.)
• Create an animation. (Each shape is one “frame” in the animation.)
293
GLOSSARY
softkey
A softkey is a function key which, when pressed, performs the action specified by
the current display.
Station
The main operator interface to Experion. Stations may run on either a remote
computer through a serial or LAN link, or on the server computer.
When Station is running on the Experion server computer, it is often referred to as
a server Station. When it is running on a machine other than the server, it is often
referred to as an operator Station.
Station Automation object model
The Station Automation object model provides the programming interface
through which scripts control Station and its displays.
status point
A point type used to represent discrete or digital field values.
Output values can be used to control up to two consecutive discrete locations in a
controller. Output values can be automatic or operator-defined.
Mode values apply to output values and determine whether or not the output
value is operator-defined or automatic.
task
A task is any of the standard server programs or an application program that can
be invoked from a display.
timer
A timer is a programming mechanism for running scripts at regular intervals in
Station.
URL
Uniform Resource Locator. For example, a Web address.
utility
Experion programs run from a command line to perform configuration and
maintenance functions; for example, the lisscn utility.
Index
Symbols tool 22
Animation tab, Properties window 76
17 Appearance tab, Properties window 78
Application object
A described 146
reference 149
accelerator keys 282 AppWindow object
acronyms described 146
adding custom acronym display to menu 115 reference 154
creating a custom acronym display 114 Arc tool 22
creating a custom acronym file 114 Arrange toolbar
custom 114, 115 Display Builder 24
default 112 arranging
defining custom 115 display objects
described 112 (DSP) Display Builder 24
selecting 113, 115
assigning
system 112
actions to keys (DSP displays) 122
user 112
document
actions to a display (DSP) 128
assigning to keys (configuring DSP help
displays) 122 to a display (DSP) 126
ActiveX Documents Automation object model 146
described 22
Automation, scope 145
properties 87
tool 22
Add method 169 B
AddListItem method 170
BeginCriticalSection method 171
Alarm Line
properties 88 Blue method 172
tool 22 Bold tool 26
Align tools bring display object to front 36
Bottom (of page) 24 Bring To Front tool 24
Center (a display object) 24
Left (a display object) 24
Middle (of page) 24
C
Page Center 24 callup task for a display (DSP) 123
Right (a display object) 24 callup task tab
Top (of page) 24 display properties
aligning display objects 33 DSP 123
alphanumeric CancelChange method 173
properties 89 CancelClick method 174
295
INDEX
CancelDoubleClick method 175 DSP 17

CancelNavigate method 176 Custom XY Plot tab, Properties window 79
charts Cut tool 20
Custom XY tab 79
Details tab 91
Options tab, Properties window 106 D
tool 22 Data tab, Properties window 80
XY Plot tab 111 defaults, setting 29
checkbox deleting a display object 40
properties 92 deselecting display objects 31
tool 22
details tab
Clear method 178 display properties
collections DSP 119
Dictionary 146, 156 Details tab, Properties window 86
Objects 165
Dictionary objects
colors described 146
restrictions for objects linked to the reference 156
database 44 using 138
selecting 44
Display Builder
system defined 77
display properties 117
combobox callup task tab 123
properties 93 details tab 119
tool 22 general tab 118
commands (command-line) help tab 125
displayinfo 288 keys tab 122
dspbld 287 periodic task tab 124
configuring formatting text 26
display objects starting 18
DSP 47 toolbars 19
displays Arrange 24
assigning actions to keys (DSP) 122 displaying 19
DSP 17 Format 26
help (DSP) 125 hiding 19
coordinates Standard 20
converting between logical and display 241 Toolbox 21
display 241 View 23
logical 241 display objects
Copy tool 20 aligning 33
CreateTimer method 179 arranging
creating (DSP) Display Builder 24
display objects 30 bringing to front 36
display objects (DSP) 21 color restrictions when linked to database 44
displays 66 creating 30
dynamic shape 55 creating (DSP) 21
shape sequence 53 deleting 40
CrossScreenInvocationPending method (Station deselecting 31
scripting) 181 distributing 34
custom displays duplicating 39
configuring dynamic 206
INDEX
editing 41 help tab (DSP) 125

editing (DSP) 21 keys tab (DSP) 122
flipping 35 periodic task tab (DSP) 124
grouping 37 restricting access to 121
handles when selected 31 saving 67
linking to the database 50, 80 template (point detail) 284
local 85 viewing details 288
locking 32 working with several 69
moving 43 distributing
nudging 43 display objects 34
object model 147 files 70
properties 75 DPToLPX method 182
configuring (DSP) 47 DPToLPY method 182
resizing 38 drawing
rotating 42 (DSP) Display Builder 28
script reference 158
DSP displays
scripting object 147
assigning
scripting reference 158
callup task to 123
selecting 31
details to 119
sending to back 36
help document to 128
types of 162
help topic to 126
ungrouping 37
keys to 122
Display tool 20 periodic task to 124
DisplayInfo, described 288 properties to 118
displays configuring 17
assigning help (DSP) 125 document assignment 128
checking point IDs in remotely-built help assignment 126
display 71 Duplicate tool 20
configuring duplicating a display object 39
DSP 17
Dynamic Shape tool 20
coordinates 241
creating 66 dynamic shapes
custom creating 55
configuring (DSP) 17 described 55
defining properties 66 inserting into a display 55
DSP 17
exporting 287 E
exporting numbered 73
file formats 68 editing
linking via hypertext 61 display objects (DSP) 21
named versus numbered 67 editing display objects 41
object model 147 EndCriticalSection method 183
opening 69 Even Horizontal Spacing tool 25
options 64 Even Vertical Spacing tool 25
point detail 284 events
properties described 147
callup task tab (DSP) 123 handlers 134
details tab (DSP) 119 handling within groups and shapelinks 140
DSP 117 OnAlarm 212
general tab (DSP) 118 OnAppStartup 213
297
INDEX
OnBeginNavigate 214 Font

OnChange 215 tab, Properties window 104
OnClick 216 tool 26
OnConnect 217 Font Size tool 26
OnDisconnect 218 Format toolbar
OnDoubleClick 219 Display Builder 26
OnDownloadBegin 220 formats, display 68
OnDownloadComplete 221 formatting text
OnFocus 222 (DSP) Display Builder 26
OnLoad 223
Freehand Line tool 21
OnMenu 224
OnMenu2 225
OnMouseEnter 226 G
OnMouseLeave 227
OnMouseMove 228 general scripts
OnNavigateComplete 229 described 135
OnOperatorChange 230 visibility 137
OnOperatorCommand 231 general tab
OnPageComplete 232 display properties
OnPageLoad 233 DSP 118
OnPeriodicUpdate 234 General tab, Properties window 105
OnQuit 235 GetResponse method 185
OnRightClick 236 GoBack method 186
OnTimer 237 GoForward method 187
OnUnload 238 GoHome method 188
OnUpdate 239 GoSearch method 189
OnUserObjectNotify 240
graphics
validating 134
formats supported 62
ExecuteOperatorCommand method 184 inserting 62
exporting Green method 190
numbered displays 73
Grid tool 23
single displays 287
groups
creating 37
F referencing objects within 136
tool 24
files guidelines for creating displays 251
display 66
properties (DSP) 117
distributing 70 H
formats for earlier releases/products 68
shape 51 handles of selected display object 31
shapes help
properties (DSP) 117 assigning to a display (DSP) 125
Fill Color tool 26 documents
Find tool 20 assigning to a display (DSP) 128
Help tool 20
Flip tools
topics
Horizontal 25
assigning to a display (DSP) 126
Vertical 25
help tab
flipping display objects 35
display properties
INDEX
DSP 125 linking display objects to the database

HTML defining 80
document described 50
assigning to a display (DSP) 128 local display object, described 85
help Lock Objects Toggle tool 25
assigning to a display (DSP) 126 locking display objects 32
HTML page, linking to displays 61 LPToDPX method 195
hypertext link to displays 61 LPToDPY method 195
LRN
I callup task for a display (DSP) 123
periodic task for a display (DSP) 124
indicator
properties 95
tool 22 M
inserting MakeColor method 196
dynamic shape 55 menu, shortcut 283
graphic 62 methods
shape sequence 53 Add 169
text 63 AddListItem 170
InvokeMenu method 191 BeginCriticalSection 171
Italics tool 26 Blue 172
Item method 193 CancelChange 173
CancelClick 174
CancelDoubleClick 175
J CancelNavigate 176
Justify tools CancelOperatorCommand 177
Center (text) 26 Clear 178
Left (text) 26 CreateTimer 179
Right (text) 26 described 147
DPToLPX 182
DPToLPY 182
K EndCriticalSection 183
keys ExecuteOperatorCommand 184
assigning action to (configuring DSP GetResponse 185
displays) 122 GoBack 186
shortcut 282 GoForward 187
GoHome 188
keys tab
GoSearch 189
display properties
Green 190
DSP 122
InvokeMenu 191
KillTimer method 194 Item 193
KillTimer 194
L LPToDPX 195
LPToDPY 195
library, shapes MakeColor 196
registering 58 OpenHelp 197
supplied 59 Quit 198
Line Color tool 26 Red 199
Line tool 21 Redraw 200
299
INDEX
Refresh 201 OnAppStartup event 213

Remove 202 OnBeginNavigate event 214
RemoveListItem 203 OnChange event 215
RequestServerLRN 204 OnClick event 216
SelectText 205 OnConnect event 217
SetFocus 206
OnDisconnect event 218
Shell 207
Station scripting OnDoubleClick event 219
CrossScreenInvocationPending (read OnDownloadBegin event 220
only) 181 OnDownloadComplete event 221
Stop 208 OnFocus event 222
Update 209 OnLoad event 223
UserObjectNotify 210 OnMenu event 224
using 137 OnMenu2 event 225
using another object’s 137 OnMouseEnter event 226
mouse coordinates 241 OnMouseLeave event 227
moving display objects 43 OnMouseMove event 228
OnNavigateComplete event 229
N OnOperatorChange event 230
OnOperatorCommand event 231
named display, described 67 OnPageComplete event 232
nudging display objects 43 OnPageLoad event 233
number of an object within a collection 137 OnPeriodicUpdate event 234
numbered display, described 67 OnQuit event 235
OnRightClick event 236
O OnTimer event 237
OnUnload event 238
object model
OnUpdate event 239
Application 146
AppWindow 146 OnUserObjectNotify event 240
described 146 Open tool 20
Dictionary 146 OpenHelp method 197
events 147 opening a file 69
methods 147 options, display 64
Page 146 Oval tool 21
properties 147
objects
Application 149 P
AppWindow 154 Page object
Dictionary 156 described 146
Display Objects 158 object model 147
number within a collection 137 reference 166
Objects collection 165 pasting
Page 166 graphic 62
referencing 136 text 63
tools for creating 21 tool 20
Objects collection 165 periodic task for a display (DSP) 124
offset, controlling with a scrollbar 100 periodic task tab
OnAlarm event 212 display properties
INDEX
DSP 124 referencing

periodic update events 141 Application object 137
point detail displays 284 attached object 136
Pointer tool 21 objects by number 136
points objects within a display 137
checking ID on remotely-built display 71 objects within groups or shapes 136
linking to a display object 81 other objects 136
rules for 136
Polygon tool 22
shapes and shapelinks 139
Polyline tool 22
Refresh method 201
Print tool 20
registering shape folders 58
properties
remotely-built displays, checking 71
described 147
display Remove method 202
callup task tab (DSP) 123 RemoveListItem method 203
details tab (DSP) 119 repeat properties of a display object 108
DSP 117 Repeats tab, Properties window 108
general tab (DSP) 118 RequestServerLRN method 204
help tab (DSP) 125 resizing display objects 38
keys tab (DSP) 122 Rotate tools
periodic task tab (DSP) 124 Left 25
display object 75 Right 25
objects (DSP) rotating display objects 42
configuring 47 Rotator tool 21
scripts 147
Rounded Rectangle tool 21
shape
DSP 117 Rulers tool 23
shape file 129
Properties Window 47 S
display object properties 75
displays SafeBrowse
DSP 117 described 60
DSP 47 properties 98
shapes tool 22
DSP 117 URL formats 60
Properties window Save tool 20
tool 23 saving a display 67
pushbutton SCAN 2000, display format 68
properties 96 Script Editor
tool 22 tool 23
using 142
scripting
Q methods
Quit method 198 Station CrossScreenInvocationPending
(read only) 181
scripts
R Automation object model 146
Rectangle tool 21 display-based 143
examples 242
Red method 199
general 135
Redraw method 200
301
INDEX
introduction to 132 Shell method 207

shape file-based 143 shortcut keys 282
Station-based 144 shortcut menus 283
writing 131 Snap-to-Grid tool 23
scrollbars Standard toolbar
controlling offset with 100 Display Builder 20
introduction to 99 starting
properties 99 Display Builder 18
range 102
Station
setting a value with 100
Automation object model 146
tool 22
controlled by another application 247
selecting controlling another application 248
display objects 31 help
shapes for display 139 configuring (DSP) 125
SelectText method 205 scripts 144
send display object to back 36 Station Scripting Object (SSO) 144
Send To Back tool 24 Stop method 208
SetFocus method 206
setting defaults 29
shape files T
defining properties 66 tab, Properties window
properties 129 Animation 76
Shape Gallery Appearance 78
described 57 Custom XY Plot 79
tool 23 Data 80
Shape Sequence tool 20 Details 86
shape sequences Font 104
animation 52 General 105
creating 53 Options 106
described 52 Repeats 108
inserting into a display 53 XY Plot 111
status indicator 52 tabs
shapelinks callup task
described 51 display properties (DSP) 123
script 139 details
shapes display properties (DSP) 119
described 51 general
dynamic, described 55 display properties (DSP) 118
file 51 help
folders, registering 58 display properties (DSP) 125
library, supplied 59 key
properties display properties (DSP) 122
DSP 117 periodic task
referencing 136 display properties (DSP) 124
scripts 139 task request
selecting for display 139 specifying on display callup (DSP) 123
sequence, described 52 specifying periodic (DSP) 124
Shape Gallery 57 template displays (point detail) 284
viewing 57 text
INDEX
inserting from another application 63 Even Vertical Spacing 25

properties 103 Fill Color 26
tool 21 Find 20
text formatting Flip Horizontal 25
(DSP) Display Builder 26 Flip Vertical 25
timers Font 26
described 141 Font Size 26
periodic update 141 Freehand Line 21
toolbars Grid 23
Arrange Group 24
Display Builder 24 Help 20
Display Builder 19 Indicator 22
displaying 19 Italics 26
hiding 19 Justify Center (text) 26
Format Justify Left (text) 26
Display Builder 26 Justify Right (text) 26
Standard Line 21
Display Builder 20 Line Color 26
Toolbox Lock Objects Toggle 25
Display Builder 21 Open 20
View Oval 21
Display Builder 23 Paste 20
Toolbox toolbar Pointer 21
Display Builder 21 Polygon 22
Polyline 22
tools
Print 20
ActiveX Document 22
Properties Window 23
Alarm Line 22
Pushbutton 22
Align Bottom 24
Rectangle 21
Align Center (a display object) 24
Rotate Left 25
Align Left (display object) 24
Rotate Right 25
Align Middle 24
Rotator 21
Align Right (display object) 24
Rounded Rectangle 21
Align to Page Center 24
Rulers 23
Align to Page Middle 24
SafeBrowse 22
Align Top 24
Save 20
Alphanumeric 22
Script Editor 23
Arc 22
Scrollbar 22
Bold 26
Send To Back 24
Bring To Front 24
Shape Gallery 23
Chart 22
Shape Sequence 20
Checkbox 22
Snap-to-Grid 23
Combobox 22
Text 21
Copy 20
Underline 26
Cut 20
Undo 20
Display 20
Ungroup 24
Display Builder
Video 22
starting 18
Wedge 22
Duplicate 20
Zoomer 21
Dynamic Shape 20
Even Horizontal Spacing 25 tutorial 265
303
INDEX
types of display object 162
U
Underline tool 26
Undo tool 20
undoing the previous action 46
Ungroup tool 24
Update method 209
URL formats 60
user file, linking a display object to 83
UserObjectNotify method 210
V
validating events 134
validating point IDs in remotely-built display 71
Video tool 22
View toolbar
Display Builder 23
W
Web browser
SafeBrowse 60
tool 22
Wedge tool 22
Windows
Properties Window
DSP 47
windows
Shape Gallery 57
working with files 69
writing scripts 131
X
XFI, display format 68
XSM, display format 68
XY Plot tab, Properties window 111
Z
Zoomer tool 21
Honeywell Process Solutions
1860 W. Rose Garden Lane
Phoenix AZ 85027
USA EP-DSXX36
April 2010
www.honeywell.com © 2010 Honeywell International Sàrl

Display Building Guide EP-DSXX36

Загружено:

Сведения о документе

Оригинальное название

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

Display Building Guide EP-DSXX36

Загружено:

Авторское право:

Доступные форматы

Experion

Display Building Guide

United States and Canada

Contact Honeywell Solution Support Center

Europe, Middle East, and Africa (EMEA)

Contact Honeywell TAC-EMEA

Contact Honeywell Global TAC - Pacific

Contact Honeywell Global TAC - India

Contact Honeywell Global TAC - Korea

People’s Republic of China

Contact Honeywell Global TAC - China

Contact Honeywell Global TAC - South East Asia

Contact Honeywell Global TAC - Taiwan

Contact Honeywell Global TAC - Japan

World Wide Web

1 About this guide 13

2 Getting started with (DSP) Display Builder 17

3 Defining display object properties 75

4 Defining display and shape properties (DSP) 117

5 Scripting reference 131

CreateTimer method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

OnMouseLeave event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

6 Guidelines for creating user-friendly displays 251

Drawing and configuring the push button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

8 Reference information 281

Before reading this guide

How to use this guide

Starting display builder

Figure 1 Layout of Display Builder

Using the toolbars

To display (or hide) a toolbar:

Figure 2 Toolbars menu

A tick opposite a toolbar indicates that it is already visible.

Figure 3 Standard toolbar

Shape Sequence. Creates a new shape sequence. See “Using shapes” on

Save. Saves the display.

Paste. Pastes the clipboard’s contents into the display.

Duplicate. Makes duplicates of the selected object(s).

Help. Displays the Help for Display Builder.

Figure 4 Toolbox toolbar

Zoomer. Zooms in and of your display. To zoom in on a part of your

Object creation buttons

Line. Creates a straight line.

Rounded Rectangle. Creates a rectangle or square with rounded

Wedge. Creates a segment (quarter) of an oval or a circle.

Video. Creates a “window” for viewing video information.

Figure 5 View toolbar

Figure 6 Arrange toolbar

Figure 7 Format toolbar

Bold, Italic and Underline. Change the text’s appearance.

Arrows. Sets the line-end style, such as arrows.

Basic drawing techniques

Setting the defaults

Figure 8 The color palette

3 Click the red box.

Creating a display object

Selecting display objects

Figure 9 A selected display object

Deselecting display objects

Locking display objects

Figure 10 The selection handles of a locked object

Aligning display objects

Distributing display objects