2017 - InTouch - Visualization
2017 - InTouch - Visualization
© 2019 AVEVA Group plc and its subsidiaries. All rights reserved.
No part of this documentation shall be reproduced, stored in a ret rieval system, or transmitted by any
means, electronic, mechanical, photocopying, rec ording, or otherwise, without the prior written
permission of AVEVA. No liability is assumed with respect to the use of the information contained herein.
Although precaution has been taken in the preparation of this documentation, AVEVA assumes no
responsibility for errors or omissions. The information in this documentation is subject to change without
notice and does not represent a commitment on the part of AVEVA. The soft ware described in this
documentation is furnished under a license agreement. This soft ware may be used or copied only in
accordance with the terms of such license agreement.
ArchestrA, Aquis, Avantis, Citect, DYNSIM, eDNA, EYESIM, InBatch, InduSoft, InStep, Int elaTrac,
InTouch, OASyS, PIPEPHASE, PRiSM, PRO/II, PROV ISION, ROMeo, SIM4ME, Si mCentral, SimSci,
Skelta, SmartGlance, Spiral Software, Termis, WindowMaker, WindowViewer, and Wonderware are
trademarks of AVEVA and/or its subsidiaries. An extensive listing of AVEVA trademarks can be found at:
https://sw.aveva.com/legal. All other brands may be trademarks of their respective owners.
Publication date: Thursday, March 7, 2019
Contact Information
AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 0HB. UK
https://sw.aveva.com/
For information on how to cont act sales, customer training, and technical support, see
https://sw.aveva.com/contact.
InTouch HMI Visualization Guide
Contents
Chapter 1 WindowMaker: Your Development Environment ........................................... 9
About Your Development Environment ....................................................................................... 9
Setting Your WindowMaker Preferenc es................................................................................... 10
Using the Screen Grid and Ruler.............................................................................................. 12
Snapping Objects to the Grid ............................................................................................. 12
Using The Ruler ................................................................................................................ 12
Panning and Zooming ............................................................................................................. 13
Using the Thumbnail Window to Pan and Zoom .................................................................. 13
Using the Mouse Wheel to Zoom and Pan .......................................................................... 14
Pan and Zoom Limitations ................................................................................................. 14
Managing Toolbars ................................................................................................................. 15
Using the Application Explorer ................................................................................................. 16
Navigating in the Application Explorer ................................................................................. 16
Adding Applications to the Application Explorer ................................................................... 17
Using Color Palettes ............................................................................................................... 17
Opening the Color Palette.................................................................................................. 17
Creating Custom Colors..................................................................................................... 18
Importing and Exporting Custom Colors .............................................................................. 19
Setting Font Defaults ............................................................................................................... 19
Using Full Screen Mode .......................................................................................................... 20
Windows Dialog Box Features ................................................................................................. 20
Mouse Short Cuts ................................................................................................................... 20
Moving Objects with the Arrow Keys ........................................................................................ 21
3
Contents InTouch HMI Visualization Guide
4
Contents InTouch HMI Visualization Guide
5
Contents InTouch HMI Visualization Guide
6
Contents InTouch HMI Visualization Guide
7
InTouch HMI Visualization Guide
C HAPTER 1
WindowMaker: Your Development
Environment
In This Chapter
About Your Development Environment ............................................................................................. 9
Setting Your WindowMaker Preferenc es ........................................................................................ 10
Using the Screen Grid and Ruler ................................................................................................... 12
Panning and Zooming ................................................................................................................... 13
Managing Toolbars ....................................................................................................................... 15
Using the Application Explorer ....................................................................................................... 16
Using Color Palettes ..................................................................................................................... 17
Setting Font Defaults .................................................................................................................... 19
Using Full Screen Mode ................................................................................................................ 20
Windows Dialog Box Features ....................................................................................................... 20
Mouse Short Cuts ......................................................................................................................... 20
Moving Objects with the Arrow Keys .............................................................................................. 21
9
WindowMaker: Your Development Environment InTouch HMI Visualization Guide
10
WindowMaker: Your Development Environment InTouch HMI Visualization Guide
2. In the WindowMaker Title Bar area, configure the appearance of the title bar. Do any of the
following:
o In the Title Bar Text box, type the text to appear in the title bar during design time.
o Select the Show Application Directory check box to include the path to the application folder in
the title bar.
3. In the Grid Configuration area, configure the background grid. Do any of the following:
o In the Spacing box, type the number of pixels bet ween the grid coordinates.
o Select the Show Grid check box to show the grid.
4. Configure miscellaneous window properties. Do any of the following:
o Select the Show Tag Count check box to show the number of tagnames in your Tagname
Dictionary in the menu bar. If you have a lot of tags, showing the tag count can impact the
Tagname Dictionary performance.
This is useful if you are creating an application with a limited Tagname Dictionary size. The
tagname count does not include remote tagname references or system tags. Click Update Use
Counts on the Special menu to find out your remote tagname reference usage.
o Select the Close on Transfer to WindowViewer check box to close WindowMaker
automatically when you start WindowViewer.
The purpose of this option is to conserve limited memory. If memory is not an issue and you are
moving often between WindowViewer and WindowMaker, do not select this option.
When you select Close on Transfer to WindowViewer, the reciprocal command, Close
WindowViewer, on the General Properties tab in the WindowViewer Properties dialog box is
also selected.
o Select the Pick Through Hollow Objects check box to select objects that are behind hollow
objects.
This enables you to select an object within a frame without having to send the frame to the
background.
11
WindowMaker: Your Development Environment InTouch HMI Visualization Guide
o Select the Enable Fast Switch check box to use the "fast switch" to toggle between
WindowMaker and WindowViewer.
The fast switch is the word Runtime that appears in the upper right corner of WindowMaker. In
WindowViewer, it is the word Development.
When you use the fast switch, WindowMaker automatically saves all changes made to all open
windows before switching to WindowViewer.
o In the Line Selection Precision box, type the number of pixels your cursor can be away from a
line and still be able to select it.
In most cases, the default setting of 4 works well.
o In the Level s of Undo box, type the number of Undo and Redo levels to maintain.
You can have up to 25 levels. If you type zero, the undo/redo function is turned off.
One level represents one action. The Undo and Redo stacks are empty when you create a new
window or open an existing window. Both stacks are emptied when you close a window.
5. In the Configure Fonts area, click either Text or Button to set the default text font or button font.
Select the font default, and then click OK.
You can override these defaults in any window by using the Font toolbar.
6. Click OK.
7. Restart WindowMaker to apply any changes you made.
12
WindowMaker: Your Development Environment InTouch HMI Visualization Guide
13
WindowMaker: Your Development Environment InTouch HMI Visualization Guide
The thumbnail view shows a white rectangle for objects that you cannot zoom in on, such as an ActiveX
control.
If you have specified an application target resolution that is different from your screen resolution, the
boundary canvas outlining your specified target resolution dimensions will also appear in the thumbnail
view.
Note: Application windows exceeding t he dimensions of the target resolution boundary will still appear in
the thumbnail view as seen in the example above.
14
WindowMaker: Your Development Environment InTouch HMI Visualization Guide
Managing Toolbars
You can show or hide any of the toolbars from the View menu.
You can move any toolbar from its default docked position to any other location within the development
window. Floating toolbars have title bars and they allow you to change their size.
When you start WindowMaker, all toolbars are shown.
You can float or dock a toolbar by dragging it. When you show a docked toolbar that was hi dden, it
reappears in its last docked location in the window.
To show or hide a toolbar
On the View menu, click the toolbar name.
To change the size of a floating toolbar
1. Move the cursor over any edge of the toolbar. The cursor changes to a double -ended arrow.
2. Drag the edge of the toolbar to move and resize the toolbar.
As you move the cursor, a box appears to indicate the size the toolbar when you release the mouse
button.
To hide all toolbars at once
On the View menu, click Hide All.
15
WindowMaker: Your Development Environment InTouch HMI Visualization Guide
These views give you access to all application windows, scripts, configuration menus, the Tagname
Dictionary, and wizards.
Do not add WindowViewer (view.exe) to the Application Explorer. The proper way to start
WindowViewer is by clicking WindowViewer on the File menu, or by clicking the Runtime fast switch in
the toolbar.
16
WindowMaker: Your Development Environment InTouch HMI Visualization Guide
17
WindowMaker: Your Development Environment InTouch HMI Visualization Guide
18
WindowMaker: Your Development Environment InTouch HMI Visualization Guide
Tip:You can override these defaults in any window by using the toolbar to customize window or button
text.
19
WindowMaker: Your Development Environment InTouch HMI Visualization Guide
Tip:Click Details to change from the list view to the details view. The details view includes any
Comments you made for the window in the Window Properties dialog box.
20
WindowMaker: Your Development Environment InTouch HMI Visualization Guide
21
InTouch HMI Visualization Guide
C HAPTER 2
Application Windows
In This Chapter
About Application Windows ........................................................................................................... 23
Creating Application Windows ....................................................................................................... 24
Importing and Exporting Windows .................................................................................................. 27
Setting Windows to Appear at Run Time ........................................................................................ 27
Modifying Application Windows ...................................................................................................... 27
Opening, Saving, and Closing Windows ......................................................................................... 27
Viewing a Thumbnail Preview of a Window..................................................................................... 28
Duplicating Windows ..................................................................................................................... 29
Deleting Windows ......................................................................................................................... 29
Printing Information about InTouch Windows .................................................................................. 30
Printing Windows Information from a Command Prompt .................................................................. 31
Working with Frame Windows........................................................................................................ 32
You can create any number of windows and you can define window properties such as background
color, screen position, window title, and so on.
23
Application Windows InTouch HMI Visualization Guide
Note: If you have specified an application target resolution that is different than your screen resolution,
your application windows can exceed the canvas boundary. However, only windows within the target
resolution canvas boundary will display at Run Time.
24
Application Windows InTouch HMI Visualization Guide
5. Select the Size Control s check box to enable users to resize a window in WindowMaker.
6. Select the Title Bar check box to include a title bar.
7. Select the Close Button check box to include a button on the title bar to close a window at design
time or run time. Windows retain the close window button even after they are exported to other
applications.
8. In the Dimensions area, specify the window location and dimensions. Do the following:
o In the X Location box, type the number of pixels bet ween the left edge of the design area and
the left edge of the window being defined.
o In the Y Location box, type the number of pixels bet ween the top edge of the design area and
the top edge of the window being defined.
o In the Window Width and Window Height boxes, type the window width and height in pixels.
9. Click OK.
3. Click OK.
The window now appears in the Template Windows folder under the Windows & Scripts pane. It is
also available in the Template Windows Browser.
Note: You can change a template window back to an application window by unchecking the Template
checkbox in the Window Properties dialog box. You can also drag and drop windows between the
Templat e Windows folders to change this property.
Note: Only windows with the Template property selected will be a vailable in the Template Windows
Browser. See Setting an Application Window as a Template Window on page 25 for the detailed
procedure.
Note: Each template window is shown in thumbnail view by default. The window thumbnails are shown
proportional to the actual window location in design time with respect to the whole application.
3. Click OK.
26
Application Windows InTouch HMI Visualization Guide
The Window Properties dialog box will appear again. All of the template window pro perties will be
populated except the window name.
4. Click OK.
Note: The windows that you want to import are specified in the batch file (wm.bat).
<CloseButton>True</CloseButton>
If your XML file contains this script, the window you import will have the close window button on the title
bar.
27
Application Windows InTouch HMI Visualization Guide
Opening a Window
To open a window
1. On the File menu, click Open Window. The Windows to Open dialog box appears listing the names
of all windows in your application.
2. Do either of the following:
To open a single window, double-click the window name.
To open multiple windows, select the check boxes for the windows to open and then click OK.
When you save a window, all graphics, QuickScripts, properties, and so on associated with the window
are also saved.
Saving a Window
To save a window
1. On the File menu, click Save Window. The Windows to Save dialog box appears, listing the names of
all windows.
2. Select the windows that need to be saved.
3. Click OK.
When you close a window that has been modified, you are prompted to save your changes .
Closing a Window
To close a window
1. On the File menu, click Close Window. The Windows to Close dialog box appears listing the names
of all currently open windows.
2. Select the check box next to the window name.
3. Click OK.
Note: You can also update the thumbnail of a particular window by right -clicking the window, and then
clicking Update Thumbnail.
2. Click Continue. The thumbnail of all windows in the InTouch application is updated.
Note: The system will open and close all windows to update the thumbnail.
28
Application Windows InTouch HMI Visualization Guide
Duplicating Windows
When you have very similar proc esses to simulate and control, you may want to duplicate a window and
then customize it for a secondary process or unit.
You can duplicate windows with all graphics, QuickScripts, properties, and so on, associated with the
window.
Before you start, the window that you want to duplicate must be open and saved at least one time. You
can only duplicate one window at a time.
To duplicate a window
1. On the File menu, click Save Window As. The Window to save under new name dialog box
appears, listing the names of all currently open windows.
2. Select the check box next to the window name.
3. In the New Name box, type a name for the new window.
4. Click OK.
Deleting Windows
To conserve computer storage space, or if the list of windows in the Application Explorer becomes too
long to manage, you can delete unused windows.
Caution: Make sure you delete the correct window. You cannot restore a delet ed window with Undo.
29
Application Windows InTouch HMI Visualization Guide
To delete a window
1. On the File menu, click Delete Window. A dialog box appears listing the names of all windows.
2. Select the window name you want to delet e and click OK. When the message appears, click Yes.
3. Click OK.
3. Select Windows.
30
Application Windows InTouch HMI Visualization Guide
31
Application Windows InTouch HMI Visualization Guide
For example:
If you use Microsoft Excel to create the file, there should be one row, with the name of each window in
each column cell of the row.
You cannot use the backslash character (\ ) in a window name.
You must use a comma and not any other separator.
32
Application Windows InTouch HMI Visualization Guide
2. Select Frame.
3. Configure other frame properties and click OK.
33
Application Windows InTouch HMI Visualization Guide
The ArchestrA Graphic Toolbox and the Properties Grid appear to the right of the canvas by default. You
can dock the Graphic Toolbox or the Properties Grid to the left side of the canvas. To restore
WindowMaker to the default, click View, Restore Layout.
Note: Application window properties will not populate in the Propertie s Grid.
Frame windows support the same properties as application windows, with three additional properties.
They are described below.
See Creating Application Windows on page 24 for a full description of each window property.
MaximizeButton Enables the Maximize button in the upper right of the frame.
Default is False.
MinimizeButton Enables the Minimize button in the upper right of the frame.
Default is False.
WindowState Displays the initial state of the window: Normal, Minimized or
Maximized.
Default is Normal.
Changes to the frame properties will immediately reflect in the frame, with the exception of the
FrameStyle property. To configure this property, the SizeControl and TitleBar properties must first be
set to False.
The FrameStyle dropdown menu will become enabled.
34
Application Windows InTouch HMI Visualization Guide
select Embed ArchestrA Graphic toolbar button and brows e for a graphic
embed graphics using the context menu from the frame window
You can aut omatically fit a frame to an embedded ArchestrA symbol. To fit the frame to the embedded
symbol, right click the window select Fit to Symbol.
The frame will resize to fit the symbol:
Note: Undo is not supported for Fit to Symbol. If you manually change the dimensions of the frame
window or changes the Size property, you need to perform the Fit to Symbol action again.
When you embed an ArchestrA symbol in the frame, the symbol will populat e in the Propertie s Grid
dropdown menu as shown below:
You can toggle between the frame window and symbol properties. Do any of the following:
Select the symbol or frame window name from the dropdown menu
Right -click on the window frame and select Window Properties.
Click the title bar or frame border to display frame window properties in the grid
Click on the embedded symbol to display the symbol properties.
You must configure the symbol properties to enable pan and zoom functionality using keyboard, mouse
and touch gestures. The configurable symbol properties are listed below.
35
Application Windows InTouch HMI Visualization Guide
MaintainAspectRatio Maintains the symbol's aspect ratio when the modern frame is
resized. Default is True.
SymbolName Sets the symbol name being hosted by the modern frame
InteractionMode Sets the interaction mode. Options are:
o None: disables Pan and Zoom
o PanZoom: default, enables Pan and Zoom
ShowZoom Control Shows the symbol and Zoom control. Options are:
o Auto: control is shown as required
o Visible: control is always shown
For details on using pan and zoom capabilities at run time, see the InTouch HMI Application
Management and Extension Guide.
36
InTouch HMI Visualization Guide
C HAPTER 3
WindowMaker Objects
In This Chapter
About WindowMaker Objects......................................................................................................... 37
Simple Objects ............................................................................................................................. 37
Complex Objects .......................................................................................................................... 39
Common Manipulations ................................................................................................................. 41
Special Manipulations for All Objects ............................................................................................. 47
Special Manipulations for Special Objects ...................................................................................... 48
As you build your applications, you create simple objects, combine simple objects to make more complex
objects, and use some pre-defined complex objects.
You can use ArchestrA Symbols created with the ArchestrA Symbol Editor in your managed or
Advanced InTouch applications. You can also add ArchestrA symbols directly from WindowMaker’s
ArchestrA Graphic Toolbox. For more information about working wit h ArchestrA and Situational
Awareness Level symbols, see the Creating and Managing ArchestrA Graphics User’s Guide or
WindowMaker help.
Simple Objects
You can create the following types of simple objects:
Lines
Shapes
Text
Buttons
Each simple object has attributes that control how it appears:
Line color and weight
37
WindowMaker Objects InTouch HMI Visualization Guide
Fill color
Height
Width
Orientation
Creating Buttons
You can use buttons to create points of int eraction with your application. The process is very similar to
creating simple drawing objects.
For information about creating polygons, see Creating Polylines and Polygons on page 38.
To create a button
38
WindowMaker Objects InTouch HMI Visualization Guide
Creating Text
You can use text to label vis ual items in your application.
When you create text, the text formatting settings match those set in the WindowMaker Propertie s
dialog box. You can change the appearance of selected text. For more information, see Changing Text
Appearance on page 45.
When you type multiple lines of text, they become objects which can be moved and edit ed
independently. You can also combine text objects into a symbol and edit them as a group.
To create text
1. On the Drawing toolbar, click the Text button.
2. Click the place for the text to start.
3. Type your text and press ENTE R. A new line of text appears.
Complex Objects
Complex objects provide more functionality than simple objects. The following table describes the
different types of complex objects.
Cell A group of two or more objects, including symbols or other cells, that are
joined together to form a single unit. You can use cells to create virtual
devic es such as slide controllers.
Cells are useful for creating multiple devices to be associated with
different tags.
Symbol A group of simple objects, such as lines, shapes, and text, that joined
together and treated as a single object. Any attribute change applied to a
symbol affects all the component objects of a symbol. Symbols cannot
contain bitmaps, buttons, cells, wizards, or trends.
SmartSymbol An InTouch cell that has been converted into a reusable graphic
template. You can place one or more instances of a SmartSymbol
template in your application windows. Any change to a template
propagates to the instances. For more information, see About
SmartSymbols in the InTouch® HMI SmartSymbols Guide.
Arche strA S ymbol A highly versatile graphic created using the Symbol Editor in the
ArchestrA Int egrated Development Environment (IDE). For more
information, see About InTouch HMI and ArchestrA Integration in the
InTouch® HMI and ArchestrA® Integration Guide.
Bitmap Container Objects that enable you to import images such as photographs,
drawings, and screen shots.
You can rotate a bitmap and you can give it a transparent background.
For more information, see Work ing with Bitmap Containers on page 49.
39
WindowMaker Objects InTouch HMI Visualization Guide
Trend Objects Charts of real -time or historical data value changes of multiple tags over
time. For more information, see Trend Objects on page 93.
Wizard Pre-built object that you only need to select, place, and configure for your
application.
For more information, see Wizards on page 89.
Acti veX Control Software component that runs within your application. WindowMaker
supports both Wonderware and third-party ActiveX controls. For more
information, see Using ActiveX Controls on page 120.
About Cells
Use a cell to combine and maintain a fixed spatial relationship among multiple elements. You can also
use a cell to move multiple elements around and align wit h other graphic al elements.
To change the elements of a cell, you must break the cell, change the elements, and then combine the
elements into a cell again.
You can animate elements of a cell but you cannot animate a cell. You also cannot resize a cell.
About Symbols
You can animate a symbol and simple objects. You can also use a symbol to animate parts of a complex
graphic.
You cannot make a symbol if more than one of the selected objects has links.
If you combine two symbols into a new symbol, the original symbol structure is lost. If you break the new
symbol, it is broken into the individual components of each original symbol. The two original symbols are
lost.
40
WindowMaker Objects InTouch HMI Visualization Guide
To break a cell
1. Select the cell.
2. On the Arrange menu, click Break Cell.
Common Manipulations
Right -click an object to see a menu showing the valid commands or actions you can apply to that object.
You can:
Selecting Objects
You must select an object before you can modify it. When you select an object, handles appear on the
perimeter of the object. You can use these handles to resize and/or reshape the object.
41
WindowMaker Objects InTouch HMI Visualization Guide
Moving Objects
You can move objects by:
Dragging them.
Using the arrow keys on your keyboard.
Typing window coordinates in boxes in the status bar.
When you are moving an object, notice how the coordinates in the status bar change.
To move an object by dragging
Select the object and drag it.
When moving objects with the arrow keys, how far an object moves depends upon whether or not the
grid is showing.
When the grid is showing, how many pix els an object moves depends upon the grid spacing, which is set
on the WindowMaker properties dialog. The default setting is ten pixels between grid points.
When the grid is showing,
Pressing an arrow key moves the object one grid point.
Pressing SHIFT + an arrow key moves the object two grid points.
Pressing CTRL + an arrow key moves the object four grid points.
When the grid is not showing,
Pressing an arrow key moves the object one pixel.
Pressing SHIFT + an arrow key moves the object ten pixels.
Pressing CTRL + an arrow key moves the object 50 pix els.
To move an object with the Arrow keys
Select an object and
o press an arrow key.
o SHIFT + press an arrow key.
42
WindowMaker Objects InTouch HMI Visualization Guide
Aligning Objects
You can align objects by their left or right edges, centers, center points, tops, middles, or bottoms.
Using the menu commands or the buttons, you can align in several ways.
Align Left Align left edges of the objects with the left edge of the
object farthest to the left.
Align Center Align objects with the vertical center line of the group.
Align Right Align right edges of objects with the right edge of the object
that is farthest to the right.
Align Tops Align top edges with the top edge of the highest object.
Align Middle Align horizontal cent ers with the middle of the group.
Align Bottom Align bottom edges with the bottom edge of the lowest
object.
Align Center points Align center points with the center point of the group.
To align objects
1. Select multiple objects.
2. On the Arrange menu, point to Align and click the appropriate align command.
Layering Objects
You can position objects in front of or behind ot hers.
To position an object behind another object
1. Select the objects(s).
2. On the Arrange menu, click Send to Back.
To position an object in front of another object
1. Select the objects(s).
2. Do one of the following:
o On the Arrange toolbar, click Bring to Front.
43
WindowMaker Objects InTouch HMI Visualization Guide
When you flip cells, they are not mirrored. Only the position of the cell in the group of objects is mirrored.
Compare the location of the cells before and after they are flipped. The position is flipped, not the
contents.
To flip an object or a cell
1. Select the object(s).
Resizing Objects
You can resize an object using two met hods. You can drag it or specify an exact width and height.
If snap to grid is turned on, the object snaps to the grid during the proportional resizing operation. The
result is a slight deviation in the ratio between vertical to horizont al size. To avoid this deviation, turn off
the snap to grid.
To resize an object by dragging
1. Select the object and then position the point of the arrow cursor in the center of a handle.
2. Drag the handle to resize the object.
To resize an object by proportional resizing
Select the object and SHIFT+drag.
44
WindowMaker Objects InTouch HMI Visualization Guide
2. Type the width and height dimensions in the W, H boxes on the status bar.
Rotating Objects
You can rotate most objects including symbols, text, and bitmaps. You cannot rotate cells.
You can rotate objects clockwise or counter clockwise 360 degrees in 90 degree increments.
Rotating objects in WindowMak er has nothing to do with dynamically rot ating objects at run time or in
WindowViewer. You rotate objects in WindowViewer by linking them to an orientation animation.
To rotate an object
1. Select the object(s).
2. On the Arrange toolbar, click Rotate Clockwise or click Rotate Counter Clockwi se.
To Click Button
45
WindowMaker Objects InTouch HMI Visualization Guide
Changing Fill
Filled shapes include shape surrounded by a line. Examples of filled shapes are rectangles, rounded
rectangles, circles, ellipses, and polygons.
To change the fill color of an object
1. Select the object.
2. On the Format toolbar, click the Fill Color tool.
3. Select a color.
To set the default color for filled shapes
1. Click a blank space on the window.
2. On the Format toolbar, click the Fill Color tool.
3. Select a color.
Deleting Objects
You can delete one or more objects.
46
WindowMaker Objects InTouch HMI Visualization Guide
To delete an object
Do either of the following:
o Right -click the object and click Erase.
o Select the object and then press Delete.
Undoing Changes
WindowMaker records your editing and formatting changes for each window. By default, WindowMaker
supports 10 levels of undo/redo, where one level represents one action. You can set WindowMaker to
retain up to 25 levels of actions. You can also turn off undo/redo by setting the undo/redo level to zero.
If you close the window, all recorded actions are cleared.
To undo a command
On the Edit menu, click Undo.
To redo a command
On the Edit menu, click Redo.
To set the number of undo/redo levels
1. On the Special menu, point to Configure, and then click WindowMaker. The WindowMaker
Properties dialog box appears.
2. In the Level s of Undo box, type the number of levels.
47
WindowMaker Objects InTouch HMI Visualization Guide
Duplicating Objects
Duplicating objects is similar to copying objects and their animation links, but has the advantage of also
duplicating the offset distance and direction when the objects are duplicated more than onc e.
When you move a duplicat ed object without un-selecting it, then duplicate it again, the third iteration is
offset the same distance and direction bet ween the first two iterations.
You can repeat this procedure as many times as necessary.
To duplicate an object
1. Right -click the object and click Duplicate. The object is copied and pasted to an offset position from
the original object.
3. Again, without un-selecting the duplicated object, right click the object and click Duplicate again.
The third iteration of the object appears in the same relative position as the first two.
49
WindowMaker Objects InTouch HMI Visualization Guide
Using WindowMaker, you are able to place more bitmaps into a window than can load in WindowViewer.
If you need to place a large number of bitmaps in a window, be sure to test the window in WindowViewer
before releasing the application.
To import a bitmap image
1. On the Drawing toolbar, click the Bitmap tool. The cursor turns into a cross-hair.
2. Drag the cursor to draw a bitmap cont ainer.
3. On the Edit menu, click Import Image. The Select Image File dialog box appears.
4. Select the image filename and click OK.
To make the bitmap its original size
1. Select the image.
2. On the Edit menu, click Bitmap - Original Size.
To paste a bitmap image
1. Copy the graphic to the Windows Clipboard.
2. Click the Bitmap tool and draw a bitmap container in your window.
3. Right -click the bitmap container and click Paste Bitmap.
To edit a bitmap
1. Select the bitmap.
2. On the Edit menu click Edit Bitmap. Microsoft Paint opens showing the bitmap.
3. Edit the bitmap in MS Paint.
4. Save and close MS Paint.
50
WindowMaker Objects InTouch HMI Visualization Guide
51
WindowMaker Objects InTouch HMI Visualization Guide
52
WindowMaker Objects InTouch HMI Visualization Guide
Note: Printing all windows of an application to an XPS file can cause WindowMaker to stop responding if
the windows contain many graphics or large graphics that exceed the available memory of the computer
hosting WindowMaker. You should print these windows one at a time to avoid problems caused by
memory shortages.
o Selected prints only the images/graphics for specific windows. The Windows to Print dialog
box appears. Select the windows in your application you want to print and click OK.
o Batch prints only the information for windows specified in a .cs v file.
For details on the .csv format, see .CSV Format for Printing Windows on page 31.
4. Select the Image/Graphics check box.
5. Click Next. The Select Output De stination dialog box appears.
6. Do one of the following
o Click Send output to Printer to print the information.
o Click Send output to HTML File to create a summary .html file, a single .html file, and .png file
for each window you specified. If .html and .png files exist, they are automatically overwritten.
7. Click Print.
53
InTouch HMI Visualization Guide
C HAPTER 4
Animating Objects
In This Chapter
About Animating Objects ............................................................................................................... 55
Two Types of Animation Links ....................................................................................................... 55
Data Display Animations ............................................................................................................... 55
Data Entry Animations .................................................................................................................. 69
Common Animation Tasks............................................................................................................. 79
55
Animating Objects InTouch HMI Visualization Guide
Value Shows
Di splay
Type
You can use up to 1023 characters in an expression. If you need a larger expression, create a
QuickFunction and call it in your expression.
Messages appear in the loc ation of the original text object using the font, size, color, alignment, and
linked attributes set for t hat object. The original c ontents of the field have no effect on the message at run
time.
To create a discrete value display link
1. Right -click the text object and click Animation Links. The Animation Links dialog box appears.
2. In the Value Display area, click Discrete. The Output -> Discrete Expression dialog box appears.
3. In the Expre ssion box, type the name of a discret e tag or an expression that equat es to a discrete
value. For ex ample:
Cooling_Pump
4. In the On Message box, type the message to appear when the value of the expression equals 1,
true, on, or yes. For example:
Pump is ON
5. In the Off Me ssage box, type the message to appear when the value of the expression equals 0,
false, off, or no. For example:
Pump is OFF
6. Click OK.
To create an analog value display link
1. Right -click the text object and click Animation Links. The Animation Links dialog box appears.
56
Animating Objects InTouch HMI Visualization Guide
2. In the Value Display area, click Analog. The Output -> Analog Expressi on dialog box appears.
3. In the Expre ssion box, type an analog (integer or real) tagname or an expression that equates to an
analog value. For example:
Tank_CV*0.06
4. In the Formatting area, in the list, click each data type for which you want to configure run time
advanced formatting. The Fixed Width check box, Precision box, and Bits From and To boxes
become available based on the data type you select. For information on configuring these options,
see Advanced Formatting for Text on page 84.
Note: During run time, the analog value input link field can be resized by clicking and dragging wit h the
pointer and mouse.
5. Click OK.
To create a string value display link
1. Right -click the text object and click Animation Links. The Animation Links dialog box appears.
2. In the Value Display area, click String. The Output -> String Expre ssion dialog box appears.
3. In the Expressi on box, type the name of a message tag or an expression that uses a message tag.
For example:
"The Tank Level is:" + Text(TankLevel,"#")
4. Click OK.
Note: During run time, the string value input link field can be resized by clicking and dragging with the
pointer and mouse.
Creating Movement
You make objects move at run time by using location links. You can make an object move horizontall y,
vertically, or both, as the value of an analog tag or expression changes. For example, as a tank level
increases and decreases, an indicator moves up and down.
To create horizontal movement
1. Place the object on the screen in the starting location.
2. Right -click the object and then select Animation Links. The Animation Links dialog box appears.
57
Animating Objects InTouch HMI Visualization Guide
3. In the Location area, click Horizontal. The Horizontal Location dialog box appears.
4. In the Expre ssion box, type an analog tag name or an expression that equates to an analog value.
5. In the Properties area, configure how far the object moves. Do the following:
a. In the At Left End box, type the value of the analog tag when the object should be at its farthest
left position.
b. In the At Right End box, type the value of the analog tag when the object should be at its
farthest right position.
c. In the To Left box, type the number of pixels the object should move to the left of its starting
position.
d. In the To Right box, type the number of pixels the object should move to the right of its starting
position.
6. Click OK.
To create vertical movement
1. Place the object on the screen in the starting location.
2. Right -click the object and then select Animation Links. The Animation Links dialog box appears.
3. In the Location area, click Vertical. The Vertical Location dialog box appears.
4. In the Expre ssion box, type an analog tag name or an expression that equates to an analog value.
5. In the Properties area, do the following:
a. In the At Top box, type the value of the analog tag when the object should be at the top position.
b. In the At Bottom box, type the value of the analog tag when the object should be at the bottom
position.
c. In the Up box, type the number of pixels the object should move up from the starting position.
d. In the Down box, type the number of pixels the object should move down from the starting
position.
6. Click OK.
Creating Rotation
You can make an object move around a center point as the value of an analog tag changes by using
orientation links. For example, as pressure increas es or decreases, a pointer can move around a dial.
58
Animating Objects InTouch HMI Visualization Guide
The orientation link uses the center of the object or symbol as the default center of rotation. You can
offset the center of rotation.
Orientation links are not support ed for ArchestrA graphics.
Tip: Draw a temporary rectangle from the center of the object to the rotation center point. Now you can
read the X and Y offset dimensions in pixels from the W, H boxes in the status bar.
3. In the Expre ssion box, type the name of an analog tag or an expression that equates to an analog
value.
4. In the Properties area, do the following:
a. In the Value at Max CCW box, type the value the expression must be for the object to rotate to
the maximum counter-clockwise position.
b. In the Value at Max CW box, type the value the expression must be for the object to rotate to its
maximum clockwise position.
c. In the CCW Rotation box, type the degrees the object rotates count er-clockwis e when the
Value at Max CCW is reached.
d. In the CW Rotation box, type the degrees the object rotates clockwise when the Value at Max
CW is reached.
5. In the Center of Rotation Offse t from Object Centerpoint area, do the following:
a. In the X Position box, type the horizontal offs et of the rotation centerpoint. Enter the offset in
pixels from the centerpoint of the object.
b. In the Y Position box, type the vertical offset of the rotation centerpoint. Enter the offset in pixels
from the centerpoint of the object.
6. Click OK.
Animating Sizes
You can vary the height and/or widt h of an object according to the value of an analog tag or expression
by using object size links.
For example, a pressure indicator can become larger as pressure increases, or an object on a conveyor
can appear to move toward the viewer by bec oming larger.
Object size links not only control the size of an object, but the direction in which the object changes size
through the use of an anchor for the animation.
59
Animating Objects InTouch HMI Visualization Guide
3. In the Expre ssion box, type the name of an analog tag or an expression that equates to an analog
value.
4. In the Properties area, do the following:
a. In the Value at Max Height box, type the value of the tag or expression when the object reaches
maximum height.
b. In the Value at Min Height box, type the value of the tag or expression when the object reaches
minimum height.
c. In the Max % Height box, type the percent age of its original height that the object will be when
the tagname or expression reaches the value set in the Value at Max Height box. The percent
figures are expressed as a percentage of the drawn size of the object. The drawn size is always
the 100% size.
d. In the Min % Height box, type the percent age of its original height that the object will be when
the tagname or expression reaches the value set in the Value at Min Height box. The percent
figures are expressed as a percentage of the drawn size of the object. The drawn size is always
the 100% size.
5. Select the Anchor point from whic h the object enlarges.
o Select Top for the object to enlarge from its top downward.
o Select Middle for the object to enlarge from its centerpoint outwards in bot h directions.
o Select Bottom for the object to enlarge from its bottom upwards.
6. Click OK.
To create a object size width link
1. Right -click the object and click Animation Links. The Animation Links dialog box appears.
2. In the Object Size area, click Width. The Object Width -> Analog Value dialog box appears.
60
Animating Objects InTouch HMI Visualization Guide
3. In the Expre ssion box, type the name of an analog tag or an expression that equates to an analog
value.
4. In the Properties area, do the following:
a. In the Value at Max Width box, type the value of the tag or expression when the object reaches
maximum width.
b. In the Value at Min Width box, type the value of the tag or expression when the object reaches
minimum width.
c. In the Max % Width box, type the percent age of its original width that the object will be when the
tagname or expression reaches the value set in the Value at Max Width box. The perc ent
figures are expressed as a percentage of the drawn size of the object. The drawn size is always
the 100% size.
d. In the Min % Width box, type the percentage of its original width that the object will be when the
tagname or expression reaches the value set in the Value at Min Width box. The perc ent
figures are expressed as a percentage of the drawn size of the object. The drawn size is always
the 100% size.
5. Select the Anchor point from whic h the object enlarges in width.
o Select Left for the object to enlarge from its left side.
o Select Center for the object to enlarge from its centerpoint outwards in both directions.
o Select Right for the object to enlarge from its right side.
6. Click OK.
Animating Colors
You can animate color changes to any object by using color links. Changes can be based on the value of
an analog or discret e tag, the value of an analog or discret e expression, or a discret e or analog alarm
status.
You can use three kinds of color links to animate objects:
Line Color
Fill Color
Text Color
For each of these three kinds of color links, four types of expressions can control color changes.
Analog The value of an analog tag or expression. You can define ten colors to
represent differing values.
Discrete Alarm The alarm state of a tag, Alarm Group, or Group Variable.
Analog Alarm The alarm state of an analog tag, Alarm Group, or Group Variable. You
can define five colors to represent five alarm conditions.
WARNI NG! Objects do not go into an alarm state when using an analog alarm link if the link is to
a remote tag from an unconverted application created before InTouch version 7.11.
61
Animating Objects InTouch HMI Visualization Guide
All discrete color links are created in the s ame way. The following proc edure describes creating a fill color
link.
To create a discrete fill color link
1. Right -click the object and click Animation Links. The Animation Links dialog box appears.
2. In the Fill Color area, click Discrete. The Fill Color -> Di screte Expression dialog box appears.
3. In the Expre ssion box, type the name of a discrete tag or a discrete expression that equates to true
or false.
Discrete ex pressions can contain analog tags. For example, TankLevel >= 75. In t his example, when
the value of the variable "TankLevel" is greater than or equal to 75, the fill color of the object
changes.
4. In the Colors area, click each color box to open the color palette. Select the color to use for each
state.
5. Click OK.
To create an analog expression color link
1. Right -click the object and then select Animation Links. The Animation Links dialog box appears.
2. In the Fill Color area, click Analog. The Fill Color -> Analog Expre ssion dialog box appears.
3. In the Expre ssion box, type the name of an analog tag or an expression that equates to an analog
value.
4. In the Break Points area, do the following.
o Specify the breakpoint values where the object changes color.
Tip:You do not have to use ten different colors. For example, if you only want the object to change color
three times, type three values and use the same color for the remaining values. If you need a more
versatile range, review the analog fill capabilities of ArchestrA symbols. For more information see, About
InTouch HMI and ArchestrA Int egrationin the InTouch® HMI and ArchestrA® Integration Guide.
62
Animating Objects InTouch HMI Visualization Guide
2. In the Fill Color area, click Discrete Alarm. The Fill Color -> Di screte Tagname Alarm Status
dialog box appears.
3. In the Tagname box, type the name of the discrete tag to associate with the object.
4. In the Colors area, select a color for each alarm state.
5. Click OK.
To create an analog alarm status color link
1. Right -click the object and then select Animation Links. The Animation Links dialog box appears.
2. In the Fill Color area, click Analog Alarm. The Fill Color -> Analog Tagname Alarm Status dialog
box appears.
3. In the Tagname box, type the name of an analog tag to associated with the object.
In the Alarm Type area, select from one of the three types of alarms to associate with the object.
Alarm Type Use up to
ROC (Rate of Change) Two colors to show the status of a rate -of change alarm.
63
Animating Objects InTouch HMI Visualization Guide
o Click Vertical, the Vertical Fill -> Analog Value dialog box appears.
o Click Horizontal, the Horizontal Fill -> Analog Value dialog box appears.
3. In the Expre ssion box, type the name of an analog tag or an expression that equates to an analog
value.
4. In the Properties area, do the following:
a. In the Value at Max Fill box, type the value of the expression that will result in the object being
filled to its maximum level.
b. In the Value at Min Fill box, type the value of the expression that will result in the object being
filled to its minimum level.
c. In the Max % Fill box, type the percentage (0-100) that the object will be filled when the
expression reac hes the level set in the Value at Max Fill box.
d. In the Min % Fill box, type the percentage (0-100) that the object will be filled when the
expression reac hes the level set in the Value at Min Fill box.
5. In the Direction area, click the direction to fill from.
6. In the Background Color box, select the color of the unfilled portion of the object.
o The actual fill color is the color that you select for the object when you draw it.
o If you link both vertical percent fill and horizontal percent fill links to the same object, the last
color you select is the background color.
7. Click OK.
64
Animating Objects InTouch HMI Visualization Guide
Tip: Discrete expressions can contain analog tagnames. For example, TankLevel > 75. In this example,
when the value of the TankLevel tag is greater than 75, the object begins blinking.
3. In the Expre ssion - Blink When box, type the name of a discrete tag or an expression that equates
to a discrete value.
4. In the Blinked Attribute s area, do the following:
o Click Blink Invisible to set the object to blink by disappearing and reappearing in the window.
o Click Blink visible with these attribute s to set the object to remain visible, but change color
when activat ed.
o Click the TextColor, Line Color or Fill Color boxes to select colors for those parts of the object.
The color palette appears.
Note: If you select a fill blink color that is the same as the object's fill color, the object does not appear to
blink.
5. In the Blink Speed area, set the blinking speed of the object. Click either Slow, Medium, or Fast.
6. Click OK.
To set the blink frequency for WindowMaker
1. On the Special menu, point to Configure and then click WindowViewer. The WindowViewer
Properties dialog box appears.
2. In the Blink Frequency area, type the number of milliseconds to use for the three speeds.
Note: Changes you make to these settings are global and affect all blink speeds in your application.
3. Click OK.
Enabling Visibility
You can create links to hide objects based on the values of various tags by using visibility links. Using
visibility links, you can:
Create the impression that moving objects only move in one direction, by hiding them when they
move in the wrong direction.
Create the impression that a moving object has stopped.
Caus e an object such as an alarm or error message to become visible only when it is activated.
65
Animating Objects InTouch HMI Visualization Guide
Tip: Discrete expressions can cont ain analog tags, for example,
TankLevel >= 75. In this example, when the value of the tag, TankLevel is greater than or equal to 75, the
object becomes visible in the window.
3. In the Expre ssion box, type the name of a discret e tag or an expression that equat es to a discrete
value.
4. Select the Visible State for the object. If you select Off, the object is invisible when the value of the
expression is true. If you select On, the object is visible when the value of the expression is true.
5. Click OK.
Disabling Objects
You can impose a level of security on your application wit h disable links. For example, you can disable
touch sensitive objects based on operator access level or name. Or you can secure a button from
tampering if no one is logged on.
A disabled state of ON means the touch functionality of the object or button is turned off and is not active
as long as the expression is true.
Tip:Discrete expressions can contain analog tagnames. For example, TankLevel >= 75. In t his example,
when the value of the variable " TankLevel" is greater than or equal to 75, the object is disabled.
3. In the Expre ssion box, type the name of a discret e tag or ex pression that equates to a discrete
value.
4. In the Di sabled State area, do one of the following:
o Select On to set the disabled state so that the object does not activate while the discret e tag or
expression is true.
o Select Off to remove the disabled state and enable t he object to function while the discrete tag or
expression is true.
66
Animating Objects InTouch HMI Visualization Guide
5. Click OK.
Configuring ToolTips
You can create ToolTips to give users information about an object on the screen by using tooltip links.
ToolTips appear when the pointer moves over the object, and disappears when the pointer is moved
away. The duration of time the tooltip appears and the positioning of the tooltip are determined by the
operating system.
You can set either an expression or static text for your tooltips.
Create a static tooltip to show the same message every time the tooltip appears.
Create an expression tooltip so that every time the tooltip appears, the expression is evaluated and
shown as the tooltip text.
For the following example expression, the text appears as the current value of the msgTooltipTag01
message tag.
msgTooltipTag01
For this example, the literal string appears followed by the current value of the iTemp tag and the result
appears as the tooltip text:
"Current temp. is " + StringFromIntg (iTemp,10)
The width of the Tooltip window can be changed in Windows 7 and later versions of Windows. You can
edit the InTouch.INI file to add an entry for Tooltip width.
Examples:
Tooltipwidth=200
A value of -1 (Tooltipwidth=-1) shows tooltip text on a single line without a line break
If no tooltip width is specified, the default width of the tooltip window is 88.
To create a tooltip link
1. Right -click the object and then select Animation Links. The Animation Links dialog box opens.
2. In the Mi scellaneous area, click Tooltip. The Object Tooltip -> String Tagname dialog box
appears.
67
Animating Objects InTouch HMI Visualization Guide
Use the script functions ShowAt() or ShowTopLeftAt() with the system read only tags $ObjHor and
$ObjVer to locate the window relative to the object. You can also use fixed positions in these functions.
If the Windows Di splay Properties is set to the Windows XP theme, this functionality is erratic under
certain circumstances.
The syntax looks like this:
ShowTopLeftAt (windowname, $ObjHor, $ObjVer);
where
windowname: the name of the window to be opened.
$ObjHor: the horizontal position of the center of the object selected.
$ObjVer: the vertical position of the center of the object selected.
The new window appears with its top left corner at the center of the selected object.
A similar script function opens the window with its center at the center of the selected object. The syntax
looks like this:
ShowAt (windowname, $ObjHor, $ObjVer);
To open a window at the selected object
1. Design, name, and create the window to appear.
2. Right -click the object to trigger the window, and click Animation Links. The Animation Links dialog
box appears.
3. In the Touch Pushbuttons area, select Action. The Touch -> Action Script dialog box appears.
68
Animating Objects InTouch HMI Visualization Guide
Category
system
Usage
$ObjHor
Data Type
Integer (read only)
See Also
$ObjVer
69
Animating Objects InTouch HMI Visualization Guide
Sliders Vertical
Horiz ontal
When a text field is used for input, text appears on the screen as the keys are pressed.
If you don't want text to appear as you type it, select the Input Only option in the configuration panel for
the link.
70
Animating Objects InTouch HMI Visualization Guide
Using References for the Minimum and Maximum Limits of an Analog Input
Animation
Constant analog values and references are support ed for the minimum and maximum limits of an analog
user input animation. You configure these limits using the Input -> Analog Tagname dialog box.
A reference can either be a remote analog tag or a local analog tag like a mem ory tag or an I/O tag.
71
Animating Objects InTouch HMI Visualization Guide
When InTouch I/O tags are used for the minimum and maximum values, only the InTouch I/O tags
are evaluated. If the I/O tag refers to a remote tag reference that is assigned a string value, then the
I/O tag value is evaluated as 0.
When remote tag references are used for the minimum and maximum values, the references are
internally evaluated as strings. If the remote references are assigned with string values that fail to get
converted to analog values, a warning message appears in t he Logger. The Minimum and
Maximum boxes show values bas ed on the data type of the referenc e to which user input is
configured.
When the user input in the Minimum or Maximum field contains the letter ‘e’, the input is either a
string or an exponential value. When the user input contains numbers followed by the letter ‘e’,
followed by numbers (±N e ±N format, where N is a number), the user input is considered as an
exponential value. When the user input containing ‘e’ contains any other alphabet (even anothe r ‘e’),
the user input is considered as a reference name.
If a reference goes into bad quality at run time, the following occurs.
For the reference in the Minimum box:
If the primary reference of the animation is an InTouch tag, the tag’s configured minim um value is
retrieved from the tag database and us ed for the minimum value.
If the primary reference of t he animation is an external reference, the minimum value of t he data type
is used. If the configured data point is a string, the last known value is us ed to determine the data
type.
o If the last known value contains a decimal point, the data type is real.
o If the last known value does not contain a decimal point, the data type is an integer.
o If there is no last known value, then integer is used.
For the reference in the Maximum box:
If the primary reference of the animation is an InTouch tag, the tag’s configured maximum value is
retrieved from the tag database and us ed for the maximum value.
If the primary reference of the animation is an external refere nce, the maximum value of the data
type is used. If the configured data point is a string, the last known value is used to determine the
data type.
o If the last known value contains a decimal point, the data type is real.
o If the last known value does not contain a decimal point, the data type is an integer.
o If there is no last known value, then integer is used.
72
Animating Objects InTouch HMI Visualization Guide
2. In the Touch Links area, under User Inputs, select String. The Input -> String Tagname dialog
box appears.
Important: Password encryption only works within the cont ext of the InTouch HMI. Do not encry pt the
string if you want to pass it to an external security system, such as the operating system or a SQL Server
database. The external security system cannot read the encrypted password string and access will fail.
6. Select the InputOnly check box to prevent the input from appearing in a text field associated with the
object.
7. Click OK.
Enabling Sliders
You can create objects that users can drag back and forth through the use of slider touch links. As the
user moves the object, it alters the value of the tag linked to it. You can link an object to a horizontal or a
vertical slider.
When you make an object into a slider, you set the reference location, which is the point on the object the
cursor uses to lock onto it.
You can use both horizontal and vertical links on a single object, so that the value of two analog tags are
altered simultaneously.
To create a horizontal slider link
1. Right -click the object and click Animation Links. The Animation Link selection dialog box appears.
73
Animating Objects InTouch HMI Visualization Guide
2. In the Slider area, click Horizontal. The HorizontalSlider dialog box appears.
74
Animating Objects InTouch HMI Visualization Guide
Action scripts can set tags to specific values, start and control other applications, execute functions and
so on.
To create a discrete value touch link
1. Right -click the object and then select Animation Links. The Animation Links dialog box appears.
2. In the Touch Pushbutton area, click Discrete Value. The Pushbutton -> Di screte Value dialog
box appears.
3. In the Condition Type list, select a script type. For more information on the types of action scripts,
see Script Triggers in the InTouch® HMI Scripting and Logic Guide
75
Animating Objects InTouch HMI Visualization Guide
Note: If you assign a key equivalent link to an action push button and to the same key is used for a key
script, the key equivalent link you assign takes precedence over the key script.
4. In the Script Editor window, type the script to execute when the object is activated.
5. Click OK.
76
Animating Objects InTouch HMI Visualization Guide
3. If you select the re-sizeable keyboard, click Options to select font, location, and dimension
properties of the keyboard.
4. Click OK.
To make an on screen keyboard appear
1. Configure the on-screen keyboard type.
2. Right -click on a text object and select Animation Links. The Animation Links dialog box appears.
3. In the Touch Links area, under User Inputs, select String. The Input->String Tagname dialog box
appears.
DialogStringEntry() Function
Shows an alphanumeric keyboard on the screen, enabling the operat or to change the current string
value of a message tag in the Tagname Dictionary.
Category
misc
Syntax
[Result=]DialogStringEntry(MessageTag_Text, UserPrompt_Text);
Parameters
MessageTag_Text
The name of the message tag to be modified. This value is a string value. Specify the tagname within
quotes or use the .Name dotfield without quotes. You can also use a message tag as a pointer.
UserP rompt _Text
The user message to show at the top of the keyboard.
77
Animating Objects InTouch HMI Visualization Guide
Return Value
Returns one of the following int eger values:
0 = Cancel was pressed.
1 = OK was pressed.
-1 = Internal error.
-2 = Could not initiate.
-3 = Tagname not defined.
-4 = Tagname is not a Message type.
-5 = Unable to write.
Remarks
This function is used primarily in applications containing touch screens.
Example
Errmsg=DialogStringEntry(MyMessageTag.Name, "Enter a new string...");
Errmsg=DialogStringEntry("MyMessageTag","Enter a new string...");
For example, the following script opens an alphanumeric keyboard, allowing modification of
MyMessageTag while showing the message "Enter a new string..." at the top of the key board:
MessageTagX="MyMessageTag"; {assign the string MyMessageTag (which is actually
the tagname to be modified) to the Memory Message tagname MessageTagX}
MessageDisplay="Enter a new string..."; {assign the new message string to the
Memory Message tagname MessageDisplay}
Errmsg=DialogStringEntry(MessageTagX, MessageDisplay); {quotes are not
required because MessageTagX was defined as a Message tagname}
See Also
DialogValueEntry ()
DialogValueEntry() Function
Shows the numeric keypad on the screen, enabling the user to change the current value of a discrete,
integer or real tag.
Category
misc
Syntax
[Result=] DialogValueEntry(ValueTag_Text, LowLimit, HighLimit,
UserPrompt_Text);
Parameters
ValueTag_Text
The name of the discret e, integer, or real tag to modify. This value is a string value. Specify the
tagname within quot es or use the .Name field without quotes. You can also use a message tag as a
pointer.
LowLimit
The minimum value of the tag. (This should be >= the tagname's definition for minimum value,
minimum raw or minimum engineering unit, as applicable).
HighLimit
The maximum value of the tag. (This should be <= the tagname's definition for maximum value,
maximum raw or maximum engineering unit, as applicable).
78
Animating Objects InTouch HMI Visualization Guide
79
Animating Objects InTouch HMI Visualization Guide
2. In the Tag Source list, click the name for the tag source or click the browse button to define a new
tag source to use.
For more information on defining tag sources, see Data Access with I/Oin the InTouch® HMI Data
Management Guide
3. In the Filter list, click a filter to reduce the number of tagnames shown in the window. To define a
filter, click the ellipsis button. For more information, see Creating a Tag Filter on page 81.
4. Select a tagname in the window.
You can change the way the tagnames are shown in Select Tag dialog box. For more information,
see Changing the View in the Select Tag Dialog Box on page 82.
5. In the Dot Field list, click a dotfield to append to the selected tagname.
Dotfields can access, monitor and modify tag properties. If you do not select a dotfield, the .Value
dotfield is used. Click OK.
80
Animating Objects InTouch HMI Visualization Guide
2. In the Tag Source list, click the name of the tag source that uses the Galaxy or click the browse
button to define a new tag source to use. The Galaxy Browser dialog box appears.
3. Use the Galaxy Browser to find and select an ArchestrA object attribute. For more information, see
the Application Server documentation.
4. Click OK to close the Galaxy Browser. The attribute referenc e appears in the text box that requires
a tag name.
Note:To return to the Select Tag dialog box from the Galaxy Browser, click the Back button in the
bottom right corner of the Galaxy Browser.
81
Animating Objects InTouch HMI Visualization Guide
List view List view button Small icons appear next to the
tagnames according to the type of each
tagname.
Details view Details view You see the same small icons and
button tagnames, plus Tag Types, Access
Name, Alarm Group, and Comments.
Sort the list by clicking the column
headers.
82
Animating Objects InTouch HMI Visualization Guide
Tree View Tree view icon The Tree View displays the tagnames in
two views.
You can access the member tagnames
in any SuperTag template.
Note: If any object or action push button in the active window is assigned to the same key used for a key
action script, the key equivalent link on the key in the active window takes precedence over the execution
of the key action script.
The animation links that support key equivalents appears the Key Equivalent area in their link dialog
boxes.
Key links are only available for function keys 1 -16. If y ou are using a custom keyboard that has more t han
16 function keys, get a device driver from your manufacturer to access the extended function keys on
your system.
To assign a key to a link
1. Open the Animation Links dialog box for the type of link you are configuring.
2. Select Ctrl and/or Shift if you want the operator to hold down either or both of thes e keys when
pressing the key equivalent.
3. Click Key. The Choose key dialog box appears.
4. Click the key to assign to the link. The Animation Link dialog box reappears with the name of the
selected key next to the Key button.
5. Click OK.
83
Animating Objects InTouch HMI Visualization Guide
o If you double-click a tag in the New Name box, its definition in the Tagname Dictionary appears.
o If you erase the tagname then double-click the blank box, the Select Tag dialog box appears.
4. Click OK. The tag associated with the object is automatically changed.
d Discrete
i Integer
m Message
r Real
Note: Remot e tag references are not shown as placeholders but as remote tag references such as:
PLC2:Temperature.
You can use several methods in the Substitute Tagnames dialog box to convert placeholder tags to
local tags. For more information, see Exporting and Importing Tag Definitions, Windows, and Scriptsin
the InTouch® HMI Application Management and Extension Guide.
Tip:If you manually convert tagnames and you no longer need the original tag defined in the original
Tagname Dictionary, you can update the tagname use counts and then delete the unused tag.
By importing a window or QuickScript from another applicatio n, and converting all of the tagnames
associated with the animation links or QuickScript(s) to remote tagname references, you can create an
application that instantly receives data from hundreds of remote tagnames without defining a single tag
in your local Tagname Dictionary.
84
Animating Objects InTouch HMI Visualization Guide
You can either use text string or enable the advanced formatting options on an individual animation
basis. When you migrate an animation from an earlier InTouc h version, or create an animation for the
first time, text string is set as the default setting.
The advanced formatting configuration options are:
Text string, which uses the existing InTouch formatting.
Real, which is formatted as the real value bas ed on the size of the value at run time. The global
decimal precision configuration is used to det ermine the number of decimal places.
Fixed decimal point, of which the formatting depends on the type of values:
o Real values: The value is formatted with the user-specified number of decimal places configured
using the Preci sion control.
o Integer values: The value is formatted as an integer without a decimal point and is indented on
the right to accommodat e for where the decimal places would have been.
o Discrete values: The value is formatted as a 0 or 1 without a decimal point and is indented on the
right to accommodate for where the decimal places would have been.
Integer, which is always formatted as an integer without a decimal point.
Exponential, which is always formatted as an exponent taking int o consideration the fixed decimal
point.
Hex, which is displayed in hexadecimal format based on the configured Boolean range.
Binary, which is always formatted as a binary string taking into consideration the configured Boolean
range.
In the Fixed Width box, you can increase the text size specified in design time. This option is not
available if Text String formatting is selected for the formatting style.
At design time, if you have selected the Fixed Width check box in the animation configuration, then the
value rendered at run time does not exceed the length of the text field. If the value exceeds the length of
the text field, the globally configured "Fixed Field Width Too Large Character" takes the length of the text
field. Formatting with fix ed width stops the text element from expanding horizontally at run time to
accommodate a value size.
If you do not specify any text for the text field at design time, the fixed width setting is ignored and the full
value is shown. For instance, if you enter "" (no text) at design time, it is equivalent to 0 for the text field
width. This does not allow any text to be rendered if the Fixed Width option is enabled. In this situation,
the Fixed Field Width setting is set to "None" as default at run time.
If you click Clear, the advanced formatting options are reset to the following:
Text String is selected for the Formatting option.
The Fixed Field Width option is cleared and subsequently disabled since this option is not available
when Text String formatting is selected.
The following values are set by default:
0 is set for the Fixed Decimal precision control.
0 is set for the Exponential precision control.
0 and 31 are set for the Hex bit range controls.
0 and 31 are set for the Binary bit range controls.
Format Control s:
85
Animating Objects InTouch HMI Visualization Guide
The Precision control accepts an integer value and is only enabled if you have selected the Fixed
Dec. Point or Exponential options. The valid range of integer values for this control is from 0
through 8, wit h 0 being the default value. The bit range consists of two spin controls, each of which
takes integers as inputs. These controls are only available if you have selected either the Hex or the
Binary option. For these two controls, you need to specify the bit value, ranging from 0 through 31.
You can specify the bit range in the forward or reverse order. You can also specify a single bit, using
the same bit specification for the range. The default numeric range for the bit specification is 0
through 31. The range is zero based to stay consistent with other places in InTouch where bits are
specified.
For versions of InTouch earlier than 3.5 that contain configured analog user input animations or analog
value display animations, the migrated animation is set to Text String formatting and advanced
formatting is off.
For later versions, the advanced formatting options are migrated forward.
Character Description
Other text format properties like font, size, and color apply to numeric values shown in the string.
Temp = # C 124 C
Displays the temperature as an integer. Only one # needs to be
entered in the text object.
86
Animating Objects InTouch HMI Visualization Guide
87
InTouch HMI Visualization Guide
C HAPTER 5
Wizards
In This Chapter
About Wizards .............................................................................................................................. 89
Working with Wizards.................................................................................................................... 89
Trend Objects............................................................................................................................... 93
Windows Controls Wizards ............................................................................................................ 93
Scripting Windows Controls ........................................................................................................... 98
About Wizards
Wizards are pre-designed, pre-built, and pre-programmed objects you only need to select, place and
configure for your application.
89
Wizards InTouch HMI Visualization Guide
You can also develop your own complex wizards to provide behind the scenes types of operations.
These operations can include creating complete display windows, creating or converting a database,
importing an Aut oCA D drawing, and configuring other applications.
Before creating your own wizards, you should investigate ArchestrA symbols, which offer wizard
functionality, but do not require programming.
Types of Wizards
Categories of wizards are shown in the Wizard Selection dialog box.
Trend Objects and Windows Controls Wizards are special wizards with unique parameters. For more
information, see Trend Objects on page 93 and Windows Controls Wizards on page 93.
90
Wizards InTouch HMI Visualization Guide
Configuring Wizards
After you place a wizard in your application, double -click it to configure its properties. A properties dialog
box appears that is custom to the selected wizard.
For more information on each particular type of wizard, see the wizard Help, if available.
91
Wizards InTouch HMI Visualization Guide
To install a wizard
1. On the Special menu, point to Configure and then click Wizard/ActiveX Installation. The
Wizard/ActiveX Installation dialog box appears.
2. In the Installed Wizards list, select the wizard to remove and then click Remove. A message box
appears asking you to confirm the deletion.
3. Click Yes to remove the wizard. The wizard appears in the Li st of Uninstalled Wizards list.
92
Wizards InTouch HMI Visualization Guide
Trend Objects
Trend objects are wizards that chart the values of tags over time.
There are three main types of trend objects:
Real-time trends chart up to four tags in real time.
Historical trends chart up to eight tags over a past time period.
16 Pen trends chart real -time and historical data for up to sixteen tags.
There is no limit to the number of trend objects, real-time or historical, you can place in a window.
Configure trend objects with the following items:
Time span
Value range
Grid resolution
Location of time and value stamps
Pens and colors
Before you can use a trend wizard, you must enable logging for each tag to track, and also enable
logging within the InTouch application.
To enable logging for tags
1. From the Tagname Dictionary, select a tag and then select Log Data.
2. If you have not done so previously, enable logging in the InTouch application.
a. On the Special menu, point to Configure, and then click Historical Logging. The Hi storical
Logging Properties dialog box appears.
b. Select the Enable Historical Logging check box and click OK.
For more information on configuring and using trend objects, see Trending Tag Datain t he InTouch® HMI
Data Management Guide.
93
Wizards InTouch HMI Visualization Guide
For example, if the .Visible property of a windows control is equal to 0, the control is not visible in the
window. As with InTouch tags, .Value is the default property for Windows Control Wizards.
Note: A more robust and flexible set of .NE T based Windows controls is available if you use ArchestrA
Symbols.
Tip: Paste Windows Controls Wizards into your windows just like other wizards. To achieve the best
readability, select a gray background for your windo ws controls. If your background color cannot be gray,
place a gray Panel Wizard behind the Windows Control Wizards.
For each Windows Controls Wizard, you must specify an alphanumeric control name, where the first
character is a letter. Underscores are allo wed, but other special characters are not. For ex ample,
"Checkbox_1" is allowed, but "Checkbox#1" is not.
You can configure Windows Control Wizards using InTouch QuickScripts.
94
Wizards InTouch HMI Visualization Guide
95
Wizards InTouch HMI Visualization Guide
b. Type a memory message tag name, such as LB1_Value, in the Tagname box.
c. In the Properties area, configure how the cont rol appears and functions.
4. Click OK.
96
Wizards InTouch HMI Visualization Guide
97
Wizards InTouch HMI Visualization Guide
c. Click a location in the application window to place the wizard. The Radio Group control wiz ard
appears with three radio buttons.
98
Wizards InTouch HMI Visualization Guide
.Value Dotfield
Default property for all InTouch windows control wizards. Changes made to this property are
synchronized in the InTouch tagname and the windows control wizards.
Category
windows cont rol
Usage
The M, I and D are for the Memory, Integer and Discrete versions of the GetProperty and SetProperty
functions.
[ErrorNumber=]GetPropertyM("ControlName[.Value]", Tagname);
[ErrorNumber=]SetPropertyM("ControlName[.Value]", Value);
[ErrorNumber=]GetPropertyI("ControlName[.Value]", Tagname);
[ErrorNumber=]SetPropertyI("ControlName[.Value]", Value);
[ErrorNumber=]GetPropertyD("ControlName[.Value]", Tagname);
[ErrorNumber=]SetPropertyD("ControlName[.Value]", Value);
Parameters
Cont rolName
Name of the windows control, e.g., ChkBox_4.
Tagname
The tagname to which the value of the property is written.
[.Value]
This property is optional. If not specified, the function always assumes the .Value property is being
used.
Value
The actual value to be written or a valid InTouch tagname (of the same type as the property to be
written to) that holds the property value to be written when the function is processed.
Remarks
The initial value of tagnames assigned to either a list box or combo box cannot be used to initialize the
value of the list box or combo box.
This dotfield is read/writ e during development and run time. If the .Value dot field is accessed by
associating a t agname t o either a list box or a combo box, it is read -only. If t he .Value dotfield is assigned
to a check box, radio button, or text box, it is read/write. The value you specify at development serves as
the default for run time.
Data Type
Message (read/write) for text boxes, list boxes and combo boxes.
Integer (read/ write) for radio buttons.
Discrete (read/write) for check boxes.
Applies To
Text boxes, list boxes, combo boxes, check boxes and radio buttons.
Example(s)
The following statement sets the .Value dot field of the radio button object "RadioB utton_1" to a value of
4:
SetPropertyI( "RadioButton_1.Value", 4 );
99
Wizards InTouch HMI Visualization Guide
See Also
GetPropertyM(), SetPropertyM(), GetPropertyI(), SetPropertyI(), GetPropertyD(), SetPropertyD()
.Enabled Dotfield
Determines whet her the control object can res pond to user -generated events.
Category
windows cont rol
Usage
[ErrorNumber=] GetPropertyD("ControlName.Enabled",
Tagname);
[ErrorNumber=] SetPropertyD("ControlName.Enabled",
Discrete);
Parameters
Cont rolName
Name of the windows control. For example, ChkBox_4.
Tagname
A discrete tagname that holds the property requested.
Discrete
A discrete value or a discrete tagname that holds the value to be written when the function is
processed. For a discret e value:
0 = Control is disabled.
1 = Control is enabled.
Remarks
This property is read/write during both development and run time.
Data Type
Discrete (read/write)
Applies To
Text boxes, list boxes, combo boxes, check boxes and radio buttons.
Example(s)
The following statement disables the list box object named "ListBox_1".
SetPropertyD("ListBox_1.Enabled", 0);
See Also
GetPropertyD(), SetPropertyD()
100
Wizards InTouch HMI Visualization Guide
.Visible Dotfield
Determines whet her the windows control is visible in the window.
Category
windows cont rol
Usage
[ErrorNumber=]GetPropertyD("ControlName.Visible", Tagname);
[ErrorNumber=]SetPropertyD("ControlName.Visible", Number);
Parameters
Cont rolName
Name of the windows control. For example, ListBox_1.
Tagname
A tagname (of the same type to be returned) that holds the property value when the function is
processed.
Number
A discrete value or a discrete tagname that holds the value to be written when the function is
processed. For a discret e value:
0 = Control is invisible.
1 = Control is visible.
Remarks
This property is read/write in both development and run time.
Data Type
Discrete (read/write)
Valid Values
Applies To
Text boxes, list boxes, combo boxes, check boxes and radio buttons.
Example(s)
The following statement hides the text box named "TextBox_1".
SetPropertyD("TextBox_1.Visible",0);
See Also
GetPropertyD(), SetPropertyD()
wcAddItem() Adds an item to the end of the list of a list box or combo box. If
sorting is enabled, the list is sorted aft er the item is added.
wcIns ertItem() Adds an item at a specified position in the list of a list box or combo
box.
101
Wizards InTouch HMI Visualization Guide
wcDeleteItem() Delet es an item from a specified position in the list of a list box or
combo box.
wcDeleteSelection() Delet es the currently selected item from the list or combo box.
wcAddItem() Function
Adds an item to the end of the list of a list box or combo box. If sorting is enabled, the list is sorted after
the item is added.
Category
windows cont rol
Syntax
[ErrorNumber=]wcAddItem("ControlName", "MessageTag");
Parameters
Cont rolName
The name of the windows control object. For example, ListBox_1. Actual string or message
tagname.
MessageTag
The message string to be shown. Actual string or message tagname.
Remarks
For a list of returned error numbers, see Understanding Windows Controls Error Messages on page 115.
Applies To
List boxes and combo boxes.
Example(s)
The following statement adds the contents of the message string to the list box when the window (using
On Show Window QuickScript) containing the list box is opened:
wcAddItem("ListBox_1", "Chocolate");
wcAddItem("ListBox_1", "Vanilla");
wcAddItem("ListBox_1", "Strawberry");
See Also
wcIns ertItem()
wcInsertItem() Function
Inserts the specified string into the list of a list box or combo box at the specified position. Unlike the
wcAddItem() function, the wc InsertItem() function does not sort a list, even if it is created as a sorted list
box or combo box.
Category
windows cont rol
102
Wizards InTouch HMI Visualization Guide
Syntax
[ErrorNumber=]wcInsertItem("ControlName", ItemPosition, "Message");
Parameters
Cont rolName
The name of the windows control object. For example, ListBox_1. Actual string or message
tagname.
ItemPosition
A number corresponding to the position of the item to be added. If this parameter is -1, the string is
added to the end of the list. Any number or Integer tagname.
Message
Cont ains the string to insert at the position indicated by It emPosition. Actual string or message
tagname.
Remarks
For a list of returned error numbers, see Understanding Windows Controls Error Messages on page 115.
Applies To
List boxes and combo boxes.
Example(s)
The following statement inserts a new item c alled "Blueberry" into a list box at fourth position from the top
when an action script runs.
wcInsertItem("ListBox_1", 4, "Blueberry");
See Also
wcAddItem()
wcDeleteItem() Function
Delet es the item at a specified position from the list of either a list box or combo box.
Category
windows cont rol
Syntax
[ErrorNumber=]wcDeleteItem("ControlName", ItemPosition);
Parameters
Cont rolName
The name of the windows control object. For example, ListBox_1. Actual string or message
tagname.
ItemPosition
A number corresponding to the position of the item. Any number or Integer tagname.
Remarks
For a list of returned error numbers, see Understanding Windows Controls Error Messages on page 115.
Applies To
List boxes and combo boxes.
Example(s)
The following statement deletes the third item in a list when an action script runs:
wcDeleteItem("ListBox_1", 3);
103
Wizards InTouch HMI Visualization Guide
wcDeleteSelection() Function
Delet es the currently selected item from the list.
Category
windows cont rol
Syntax
[ErrorNumber =]wcDeleteSelection("ControlName");
Parameter
Cont rolName
The name of the windows control object. For example, ListBox_1. Actual string or message
tagname.
Remarks
For a list of returned error numbers, see Understanding Windows Controls Error Messages on page 115.
Applies To
List boxes and combo boxes.
Example(s)
The following statement deletes the currently selected item in a list box list when an action script runs:
wcDeleteSelection("ListBox_1");
wcClear() Function
Removes all items from the list box or combo box.
Category
windows cont rol
Syntax
[ErrorNumber=]wcClear("ControlName");
Parameters
Cont rolName
The name of the windows control object. For example, ListBox_1. Actual string or message
tagname.
Remarks
For a list of returned error numbers, see Understanding Windows Controls Error Messages on page 115.
Applies To
List boxes and combo boxes.
Example(s)
The following statement clears all items in a list box when an action script runs:
wcClear("ListBox_1");
104
Wizards InTouch HMI Visualization Guide
wcLoadList() Loads the contents of a list box or combo box with new
items from a file.
wcLoadList() Function
Loads a list box or combo box with new items from a file.
Category
windows cont rol
Syntax
[ErrorNumber=]wcLoadList("ControlName", "Filename");
Parameters
Cont rolName
The name of the windows control object. For example, ListBox_1. Actual string or message
tagname.
Filename
Cont ains the name of a file. If you do not supply a complete path name as part of the message
parameter, the function checks the application directory for the message file. Actual string or
message tagname.
Remarks
For a list of returned error numbers, see Understanding Windows Controls Error Messages on page 115.
If you use external files to fill the list and combo boxes, they must follow specific formatting and contain
specific information. Format:
Cont rolType, ListCount
ListItem, ItemIndex
ListItem, ItemIndex
: :
: :
ListItem, ItemIndex
The ControlType is either COMBOBOX or LIS TB OX.
For example, you want to load a list file to a combo box and it contains three items to select from and
those items have no item data assigned. The format of the file appears as:
COMBOB OX, 3
Choc olate, 0
Vanilla, 0
Strawberry, 0
105
Wizards InTouch HMI Visualization Guide
The COMBOB OX is the control type. The list count is 3 for Chocolate, Vanilla, and Strawberry. Chocolate
is then listed as the first item or position 1. Vanilla as position 2, and Strawberry as position 3. Each of
these items has a data value of 0.
For more information on item data, see wcSetItemData() Function on page 111.
Applies To
List boxes and combo boxes.
Example(s)
The following statement loads a properly formatted list (located in c: \wclist.txt.) into a combo box:
wcLoadList("Combobox_1", "c:\wclist.txt");
See Also
wcAddItem(), wcSaveList()
wcSaveList() Function
Saves the items of a list box or combo box to a file.
Category
windows cont rol
Syntax
[ErrorNumber=]wcSaveList("ControlName","Filename");
Parameters
Cont rolName
The name of the windows control object. For example, ListBox_1. Actual string or message
tagname.
Filename
Cont ains the name of a file. If the file does not exist, it is created. Actual string or message tagname.
Remarks
For a list of returned error numbers, see Understanding Windows Controls Error Messages on page 115.
Applies To
List boxes and combo boxes.
Example(s)
The following statement saves the current items in a list box in a file (c: \newlist.txt) when an action script
runs:
wcSaveList("ListBox_1", "c:\newlist.txt");
See Also
wcLoadList(), wcSetItemData()
wcFindItem() Function
Determines the corresponding position of the first item in the list box or combo box that matches the
supplied message string.
106
Wizards InTouch HMI Visualization Guide
Category
windows cont rol
Syntax
[ErrorNumber=]wcFindItem ("ControlName", "MessageTag", CaseSens, Tagname);
Parameters
Cont rolName
The name of the windows control object. For example, ListBox_1. Actual string or message
tagname.
MessageTag
The message string to be compared. Actual string or message tagname.
CaseSens
Determines the type of the string comparison. It can either be a discrete value or tagname. The
following values are valid:
0 = case-insensitive.
1 = case-sensitive.
Tagname
Integer tag into which the position of the matching item is returned. If no matching item is found, -1 is
returned.
Remarks
For a list of returned error numbers, see Understanding Windows Controls Error Messages on page 115.
Applies To
List boxes, combo boxes
Example(s)
Assuming that ListBox_1 is a list box that contains " ItemA", "ItemB", and "ItemC", the function returns the
following values into Result:
wcFindItem("ListBox_1", "ItemB", 0, Result);
returns 2
wcFindItem("ListBox_1", "Itemb", 1, Result);
returns -1
wcFindItem("ListBox_1", "itemc", 0, Result);
returns 3
wcFindItem("ListBox_1", "XYZ", 0, Result);
returns -1
.TopIndex The integer index of the topmost item in the list box.
.NewIndex The integer index (tagname) of the last item added to the list box or combo
box through the wcAddItem() or wc InsertItem() functions.
107
Wizards InTouch HMI Visualization Guide
.ListIndex The index (tagname or number) of the currently selected item in the list.
.TopIndex Dotfield
Sets or reads the integer index of the top-most item in a list box.
Category
windows cont rol
Usage
[ErrorNumber=]GetPropertyI("ControlName.TopIndex", Tagname);
[ErrorNumber=]SetPropertyI("ControlName.TopIndex", Number);
Parameters
Cont rolName
Name of the windows control. For example, ListBox_1.
Tagname
An Integer tagname that holds the property value when the function is processed.
Number
The index number that defines the top-most item in the list box. Can be a literal integer value or a
integer tagname or expression that provides an integer value.
Remarks
This property is available only in run time.
Data Type
Integer (read/ write)
Applies To
List boxes.
Example(s)
The following statement sets the TopIndex of the list box object "ListBox_1" to a value of 14:
SetPropertyI("ListBox_1.TopIndex",14);
See Also
GetPropertyI(), SetPropertyI(), .ListIndex, .NewIndex
.NewIndex Dotfield
Returns the integer index (Tagname) of the last item added to the list box or combo box via the
wcAddItem() or wcInsert Item().
Category
windows cont rol
Usage
[ErrorNumber=]GetPropertyI("ControlName.NewIndex", Tagname);
108
Wizards InTouch HMI Visualization Guide
Parameters
Cont rolName
Name of the windows control. For example, ListBox_4.
Tagname
A tagname containing the int eger index of the last item added to the list or combo box. For empty
lists, a value of -1 is returned.
Remarks
This property is only available in run time.
Data Type
Integer (read-only)
Applies To
List boxes and combo boxes.
Example
The following statement ret rieves the index of the most recently added item in the list box named
"ListBox_1" and writes that value to the memory integer tagname NewItemIndex.
GetPropertyI("ListBox_1.NewIndex", NewItemIndex);
See Also
GetPropertyI(), wcAddItem(), wcInsert Item(), .ListIndex, .TopIndex
.ListIndex Dotfield
Sets or reads the index (Tagname or Number) of the currently selected item in the list.
When using a list box, an index of -1 indicates that no item is currently selected.
When using a combo box, an index of -1 indicat es that the user has typed new text into the text entry field
of the control.
Syntax
[ErrorNumber=]GetPropertyI("ControlName.ListIndex", Tagname);
[ErrorNumber=]SetPropertyI("ControlName.ListIndex", Number);
Parameter
Cont rolName
Name of the windows control. For example, ListBox_4.
Tagname
The tagname to which the index of the currently selected item is written.
Number
The index number that defines a specific item in the list.
Remarks
The index number defines a specific item in a list. Use the .ListIndex dotfield to set or det ermine the i ndex
of the currently selected item in a list or combo box.
This property is available only in run time.
Data type
Integer (read or write)
109
Wizards InTouch HMI Visualization Guide
Applies to
List boxes and combo boxes.
Example
This statement retrieves the index of the currently selected item in the list box named "ListBox_1" and
writes that value to the memory integer tagname MyListBoxIndex.
GetPropertyI( "ListBox_1.ListIndex", MyListBoxIndex );
See Also
GetPropertyI(), SetPropertyI(), .NewIndex, .TopIndex
.ListCount Dotfield
Reads the number of items in the list box or combo box.
Category
Windows control
Syntax
[ErrorNumber=]GetPropertyI("ControlName.ListCount", Tagname);
Parameter
Cont rolName
Name of the windows control.
Tagname
A valid tagname that contains the integer count of the items in the list.
Remarks
This property is available only in run time.
Data Type
Integer (read-only)
Applies To
List boxes and combo boxes.
Example(s)
The following statement ret rieves the number of items in the list box named ListBox_1 and writ es that
value to the memory integer tag MyListBoxCount.
GetPropertyI("ListBox_1.ListCount", MyListBoxCount);
See Also
GetPropertyI(), .ListIndex
110
Wizards InTouch HMI Visualization Guide
wcGetItemData() Function
Reads the integer value associated with the list item identified by the ItemIndex parameter.
Category
windows cont rol
Syntax
[ErrorNumber=]wcGetItemData("ControlName", ItemIndex, Tagname);
Parameters
Cont rolName
The name of the windows control object. For example, ListBox_1. Actual string or message
tagname.
ItemIndex
A number corresponding to the position of the item. Any number or integer tagname.
Tagname
Actual name of a real or integer tagname. The wc GetItemData() function places the numeric value
corresponding to the item into this tagname upon return from the function.
Remarks
For a list of returned error numbers, see Understanding Windows Controls Erro r Messages on page 115.
Applies To
List boxes and combo boxes.
Example(s)
The following statement retrieves the numeric value associated with t he fifth item in a list box and returns
it to the ItemValue Integer tagname when an action script runs:
wcGetItemData("ListBox_1", 5, ItemValue);
If the fifth item in the list is assigned the integer value 4500, the ItemValue tagname contains 4500.
See Also
wcSetItemData()
wcSetItemData() Function
Assigns an integer value of the item (t he Number parameter) to the item in the list specified by the
ItemIndex parameter. This function enables the assignment of a number to a string.
Category
windows cont rol
Syntax
[ErrorNumber=]wcSetItemData("ControlName", ItemIndex, Number);
Parameters
Cont rolName
The name of the windows control object. For example, ListBox_1. Actual string or message
tagname.
ItemIndex
An integer value specifying the list item you want to edit. Any number or Int eger tagname.
Number
An integer value representing the item data. Any number or Integer tagname.
111
Wizards InTouch HMI Visualization Guide
Remarks
You can create complet e lists containing the items using a program like Notepad and then load them
using one function call. Format the list as required by the wcSaveList() function.
For a list of returned error numbers, see Understanding Windows Controls Error Messages on page 115.
Use the wcGetItemDat a() function to return the value (item data) associated wit h the list item. The
tagname parameter contains the returned numeric value. This parameter could be an I/O Integer
tagname that writes directly to the real world device.
Example(s)
A recipe has three ingredients; flour, sugar and salt. The quantity of flour is 4500 grams, sugar is 1500
and salt is 325 grams. The values are assigned t o each of the list box items by using a data change script
triggered by what recipe (tagname, RecipeName) is selected:
wcSetItemData("ListBox_1", 1, 4500); {set 1st item in the list (flour)=4500}
wcSetItemData("ListBox_1", 2, 1500); {set 2nd item in the list (sugar)=1500}
wcSetItemData("ListBox_1", 3, 325); {set 3rd item in the list (salt)=325}
See Also
wcLoadList(), wcSaveList(), wcGetItemData()
wcGetItem() Function
Returns a string containing the contents of the item corresponding to the ItemIn dex in the list box or
combo box.
Category
windows cont rol
Syntax
[ErrorNumber=]wcGetItem("ControlName", ItemIndex, Tagname);
Parameters
Cont rolName
The name of the windows control object. For example, ListBox_1. Actual string or message
tagname.
ItemIndex
A number corresponding to the position of the item. Any number or Integer tagname.
Tagname
Message tagname. The wc GetItem function will place the data corresponding to the item index into
this tagname upon return from the function.
Remarks
For a list of returned error numbers, see Understanding Windows Controls Error Messages on page 115.
Applies To
List boxes and combo boxes.
Example(s)
The following statement ret urns the string value of the tenth item in a combo box to the ListSelection
message tag when an action script runs:
112
Wizards InTouch HMI Visualization Guide
Note: If the tag name has been defined with a maximum length, only that number of characters can be
assigned from t he text box contents to the tag. If no tag is assigned to the text box, its contents can be up
to 65,535 characters.
wcLoadText() Function
Replaces the contents of the text box with the cont ents of the file.
Category
windows cont rol
Syntax
[ErrorNumber=]wcLoadText("ControlName", "Filename");
Parameters
Cont rolName
The name of the windows control object. For example, ListBox_1. Actual string or message
tagname.
Filename
Cont ains the name of a file. If a complete path name is not supplied as part of the message
parameter, the function will check the application direc tory for the file. Actual string or message
tagname.
Remarks
For a list of returned error numbers, see Understanding Windows Controls Error Messages on page 115.
Applies To
Text boxes.
Example(s)
The following statement loads a text file (c:\InTouch. 32\readme.txt.) into a text box when the window (On
Show Window script) containing the text box opens:
wcLoadText("Textbox_1", "c:\InTouch.32\readme.txt");
wcSaveText() Function
Saves the text contained in the text box to the specified file. If the file doesn't exist, it is created. If it does
exist, it must be read/write.
Category
windows cont rol
Syntax
[ErrorNumber=]wcSaveText("ControlName", "Filename");
113
Wizards InTouch HMI Visualization Guide
Parameters
Cont rolName
The name of the windows control object. For example, ListBox_1. Actual string or message
tagname.
Filename
Cont ains the name of the destination file. If you do not supply a complete path name, the file is saved
in the application directory. If the file exists, it is overwritten. If the file does not exist, it is created. The
resulting file can subsequently be loaded into a text box object using the wcLoadText() function.
Actual string or message tagname.
Remarks
For a list of returned error numbers, see Understanding Windows Controls Error Messages on page 115.
Applies To
Text boxes.
Example(s)
The following statement saves the current information entered in a text box to a file in
c:\InTouch.32\newtext.txt when an action script runs:
wcSaveText("Textbox_1", "c:\InTouch.32\newtext.txt");
See Also
wcLoadText()
.ReadOnly Dotfield
Determines whet her the content of the text box is read -only or read/ write.
Category
windows cont rol
Usage
[ErrorNumber=]GetPropertyD("ControlName.ReadOnly", Tagname);
Parameters
Cont rolName
Name of the windows control. For example, Textbox_1.
Tagname
A discrete tagname that holds the property value when the function is processed.
0 = Contents of the text box is read/ write
1 = Contents of the text box is read -only
Remarks
This property is available in both development and run time.
Data Type
Discrete (read-only)
114
Wizards InTouch HMI Visualization Guide
Applies To
Text boxes.
Example(s)
The following statement ret rieves the read -only status of the Text box named " TextBox_1":
GetPropertyD("TextBox_1.ReadOnly",A_Tagname);
See Also
GetPropertyD(), SetPropertyD()
.Caption Dotfield
Determines the message to be displayed with the check box.
Category
windows cont rol
Usage
[ErrorNumber=]GetPropertyM ("ControlName.Caption", Tagname);
[ErrorNumber=]SetPropertyM ("ControlName.Caption", "Message");
Parameters
Cont rolName
Name of the windows control. For example, ChkBox_4.
Tagname
A message tagname that holds the property requested.
Message
A message string surrounded in quotes.
Remarks
This property is read/write during both development and run time.
Data Type
Message (read/write)
Applies To
Check boxes.
Example
This statement sets the caption of the check box object "CheckBox_1" to "Blue Paint Option."
SetPropertyM("CheckBox_1.Caption","Blue Paint Option");
See Also
GetPropertyM(), SetPropertyM()
115
Wizards InTouch HMI Visualization Guide
The Window Controls functions return values based on the result of proc essing QuickScript functions.
The return value is used for error diagnostics. You can assign these values to integer tag names. For
example:
ErrorNumber = wcGetItem("ControlName", Number, Tagname);
In this script, ErrorNumber is an integer tag that contains the ret urned error value. The returned value
of the function can be passed to the wcErrorMessage(). The wcErrorMessage() will return a string
description of the error. For example:
ErrorMsg = wcErrorMessage(ErrorNumber);
In this script, ErrorMsg is a message type tag that contains the text of the returned error. The following
table identifies numeric error values and their definitions.
Error Definition
Message
0 Success
-1 General failure
-3 Property is read-only
-x Unknown error.
wcErrorMessage() Function
Returns a message string describing the error.
Category
windows cont rol
Syntax
ErrorMessage=wcErrorMessage(ErrorNumber);
Parameters
ErrorMessage
Message tagname.
ErrorNumber
Number returned by all windows control functions. Any number or Integer tagname.
Remarks
For a list of returned error numbers, see Understanding Windows Controls Error Messages on page 115.
Applies To
List boxes, text boxes, combo boxes, check boxes and radio buttons.
116
Wizards InTouch HMI Visualization Guide
Example(s)
If an error occurs while a list is being loaded, show the text description of the error into the
ErrorDescription message tagname. In this example, a Value Display animation link is assigned to the
ErrorDescription tagname to show the error message.
In the "On Show" window QuickScript:
ErrorNumber=wcLoadList("ListBox_1","c:\recipe.txt");
ErrorDescription=wcErrorMessage(errornumber);
You can use this function with all windows control functions to show error messages:
ErrorNumber=wcAddItem("ListBox_1","AM_4A4356");
ErrorMsg=wcErrorMessage(ErrorNumber);
117
InTouch HMI Visualization Guide
C HAPTER 6
ActiveX Controls
In This Chapter
About ActiveX Controls ............................................................................................................... 119
Using ActiveX Controls................................................................................................................ 120
Configuring ActiveX Controls ....................................................................................................... 121
Naming ActiveX Controls............................................................................................................. 121
Standard Operations on ActiveX Controls ..................................................................................... 122
Installing and Removing ActiveX Cont rols .................................................................................... 122
119
Acti ve X Controls InTouch HMI Visualization Guide
ActiveX controls cannot overlap ot her InTouch objects, such as window controls or graphic objects. Too
many ActiveX controls on one window can reduce system performance.
2. In the list of wizards, click the ActiveX Control s category. All available ActiveX controls appear in
the display area.
3. Double-click the ActiveX control to use. The dialog box closes and the curs or changes to the corner
symbol.
4. Click the location to paste the ActiveX cont rol.
To add ActiveX controls to the toolbar
1. Click the Wizard Dialog tool in the Wizards/ActiveX Toolbar. The Wizard Selection dialog box
appears.
2. Select the ActiveX cont rol to add.
3. Click Add to toolbar.
120
Acti ve X Controls InTouch HMI Visualization Guide
Use the Events tab to assign scripts to available control events, such as when the user double-clicks the
mouse.
Any other tabs and their configurations are unique to the cont rol and depend upon its properties. For
example, some cont rols may require you to configure colors and fonts, while others may not have these
properties.
121
Acti ve X Controls InTouch HMI Visualization Guide
3. In the Installed ActiveX control s list, select the control to install in the Available ActiveX control s
list and then click Install.
Tip:To select multiple cont rols, use the SHIFT key or CTRL key.
4. Click OK.
To remove an ActiveX control
1. On the Special menu, point to Configure and then click Wizard/ActiveX Installation. The
Wizard/ActiveX Installation dialog box appears.
2. Click the ActiveX Control Installation tab. The ActiveX Control Installation property sheet
appears.
3. In the Installed ActiveX control s list, select the control to remove from your application and then
click Remove. A message appears asking you to confirm the deletion.
122
Acti ve X Controls InTouch HMI Visualization Guide
Tip: To select multiple controls, use the SHIFT key or CTRL key.
4. Click Yes to remove the control. The control is moved to the Available ActiveX control s list.
5. Click OK.
123
Index
$
$ObjHor system tag • 67, 68
$ObjVer system tag • 67, 69
.
.Caption dot field • 115
.Enabled dot field • 100
.NewIndex dotfield • 108
.ReadOnly dotfield • 114
.TopIndex dotfield • 108
.Value dot field • 99
.Visible dotfield • 93, 101
A
action script link, creating • 74
ActiveX cont rols
about • 119
adding to toolbar • 120
definition • 39
placing on a window • 120
removing from toolbar • 120
alarm types • 61
analog data display, creating • 56
analog input, creating links • 71
anchor points • 59
ArchestrA Symbol, definition • 39
B
bitmap containers
definition • 39
bitmaps
creating a transparent bitmap • 51
importing • 49
pasting, editing • 49
blink attributes • 64
blink frequency, setting • 64
bring to front, object • 43
buttons
default fonts • 10
substitute strings • 38
C
cells
creating • 40
definition • 39
circle button • 38
close button • 24
color links
creating analog alarm status link • 61
creating analog expression link • 61
creating discrete alarm status link • 61
creating discrete fill link • 61
defining • 61
expression types • 61
color palettes
opening • 17
D
data display
analog value, creating • 56
discrete value, creating • 56
string value, creating • 56
data entry
analog input • 71
discrete • 70
string input • 72
Development fast switch • 10
DialogStringEntry() function • 77
DialogValueEntry () function • 78
disable link • 66
discrete input, creating links • 70
discrete value display, creating • 56
display links • 55
dotfields
.Caption dot field • 115
.Enabled dot field • 100
.NewIndex dotfield • 108
.ReadOnly dotfield • 114
.TopIndex dotfield • 108
.Value dot field • 99
.Visible dotfield • 93, 101
drawing buttons • 38
drop-down lists • 93
E
ellipse button • 38
error messages
definitions • 115
F
fast switch
Development • 10
Runtime • 10
fill levels
percent • 63
fonts
configure • 10
format characters • 86
functions
DialogStringEntry() function • 77
DialogValueEntry () function • 78
ShowAt() function • 67
ShowTopLeftAt() function • 67
wcAddItem() function • 102
wcClear() function • 104
wcDeleteItem() function • 103
wcDeleteSelection() function • 104
wcErrorMessage() function • 116
wcFindItem() function • 106
wcGet Item() function • 112
wcGet ItemData() function • 111
wcIns ertItem() function • 102
wcLoadList() function • 105
wcLoadText() function • 113
wcSaveList() function • 106
wcSaveText() function • 113
wcSetItemData() function • 111
G
grid
show • 10, 12
spacing • 10, 12
H
home, windows • 27
horizonal movement • 57
horizontal line button • 38
I
importing bitmaps • 49
L
line button • 38
lines, select precision • 10
links
action script • 74
analog alarm status color, creating • 61
analog expression color, creating • 61
analog input • 71
animate objects • 55
animation • 20, 40
animation types • 55
blink • 64
cannot make symbol • 40
clipboard limitations • 48
color • 61
color link types • 61
creating movement • 57
creating rotation • 58
cut, copy, or paste • 47
disabling • 66
discrete alarm status, creating • 61
discrete color fill, creating • 61
discrete input • 70
discrete value touch links • 74
display • 55
keyboard shortcuts • 83
location links • 57
on screen keyboards • 76
opening or closing windows • 76
orientation • 58
percent fill • 63
push buttons • 74
size links • 59
slider, creating • 73
string input • 72
symbol in a cell • 40
ToolTips • 67
touch • 55, 69
user input types • 69
value display types • 56
visibility • 65
M
maximum limit
configuring • 71
minimum limit
configuring • 71
movement
horizontal • 57
vertical • 57
O
objects
alarm types • 61
horizontal movement • 57
pick through hollow objects • 10
size height link • 59
size width link • 59
vertical movement • 57
orientation link, creating • 58
overlay, windows type • 24
P
percent fill • 63
polygons, adding or deleting points • 49
popup, windows type • 24
R
radio button group cont rol • 97
rectangle button • 38
replace, window type • 24
rounded rectangle button • 38
Runtime fast switch • 10
S
send to back, objects • 43
show hide windows • 76
ShowAt() function • 67
ShowTopLeftAt() function • 67
size height link • 59
size width link • 59
sliders, creating • 73
SmartSymbol, definition • 39
string input, creating links • 72
string value display, creating • 56
substitute strings
creating buttons • 38
text objects • 52
substituting tags • 83
symbols
combining and breaking • 40
creating or breaking • 41
definition • 39
use of • 40
system tags
$ObjHor • 68
$ObjHor • 67
$ObjVer • 67, 69
T
tags
enable logging • 93
show tag count • 10
substituting • 83
text
default fonts • 10
format numbers • 86
tool tips
creating • 67
static or expression • 67
toolbars
changing size • 15
touch links • 55, 69
trend objects • 39
U
undo, levels of • 10
update use counts • 10
V
vertical line button • 38
vertical movement • 57
visibility link, creating • 65
W
wcAddItem() function • 102
wcClear() function • 104
wcDeleteItem() function • 103
wcDeleteSelection() function • 104
wcErrorMessage() function • 116
wcFindItem() function • 106
wcGet Item() function • 112
wcGet ItemData() function • 111
wcIns ertItem() function • 102
wcLoadList() function • 105
wcLoadText() function • 113
wcSaveList() function • 106
wcSaveText() function • 113
wcSetItemData() function • 111
WindowMaker
close on trans fer • 10
fast switch • 10
levels of undo • 10
title bar changing • 10
windows
home • 27
name • 24
opening at selected object • 67
selecting background color • 24
show hide • 76
type • 24
windows type, replace, overlay, or popup • 24
Windows XP • 24, 67
wizards
definition • 39
importing • 91
removing from the toolbar • 90