Iris Reference Manual · 2006. 3. 28. · 3 - 390 Iris Reference Manual Iris Version 3.0 Abstract...

Reference Manual

The eye of Iris

IRIS, Greek goddess of the rainbow Iris is the messenger of Gods, especially of Hera. A nickname is Podenemus (with feet, fast as the wind, fast footed). She is also called the heavenly Iris. She is the daughter of the titan Thaumas and the oceanide Electra. Iris is portrayed with golden wings. She also had feathered feet. Iris brings the deceased women to heaven by cutting a lock of hair of the dying queen Dido, making free the way to her soul. On an antique vase she is portrayed running while holding up her skirt with her hands. The Greek called her 'The Source of water from above'. If the Gods argue, or if they lie about something, Iris will get water out of the river Styx. With this water the Gods must pledge the truth. If they lied, they lost their immortality. If Iris brings a message to a mortal soul, she usually will take the form of a familiar person. Iris is the messenger of gods; she is as fast as the wind. For her flight Iris uses the services of the wind, her multicoloured bow makes a passage possible from earth to heaven. Homerus calls her the fast-footed one. He also associates her with a dove. She carries the same name as the flower Iris; this was named after her because of her multitude of colour in which this flower comes. The Iris had the same connotations as the lily. The daffodil of which the wreath is made of Demeter and Persephone is in matter of fact a blue Iris, blue lis flowered with three crown leafs.

3 - 390

Iris Reference Manual

Iris Version 3.0

Abstract

This manual is the reference manual for Iris SCADA and Iris Panelware from Raster Products B.V. Iris is a program for controlling and visualising PLC controlled objects. Iris runs on a Windows based PC (XP, 2000) with a common interface (Modbus+, TCP/IP, Siemens MPI) to one or more PLC’s. This reference manual describes how to install Iris, create screens, and make contact to PLC’s and link to information into the connected PLC’s. Raster Products B.V. P.O. box 3 6620 AA DREUMEL The Netherlands Phone: +31 (0)487-572719 Fax: +31 (0)487-573394 E-mail: [email protected] Website: www.raster-ia.nl

4 - 390


Iris Version 3.0

History

Version Date Author Description 1 01-05-2004 R.P. Langereis Version 1.1 of Iris 2 01-12-2004 R.P. Langereis Version 2.0 of Iris 3 02-02-2005 R.P. Langereis Version 2.1 of Iris 4 01-09-2005 R.P. Langereis Version 3.0 of Iris This document is property of Raster Products B.V. No part of it may be reproduced or used in any form or by any means without written permission of the owner. Although this manual is written with the most care, Raster will not be responsible for any mistakes in this manual or damage that is a result of the information in this manual. If the Raster logo is not printed in green and blue, this is an unofficial copy. ©2005 Raster Products B.V. All right reserved

5 - 390


Iris Version 3.0

Table of contents 1 Introduction ................................................................................... 10

1.1 Intended readership ..................................................................................... 10 1.2 Applicability statement.................................................................................. 10 1.3 Purpose........................................................................................................ 10 1.4 Convections ................................................................................................. 10

2 Overview ....................................................................................... 11 3 Installation of Iris .......................................................................... 12 4 Starting Iris .................................................................................... 19 5 Preferences .................................................................................... 21

5.1 Application.................................................................................................... 21 5.2 Form Designer.............................................................................................. 22 5.3 Security ........................................................................................................ 24 5.4 Windows locks ............................................................................................. 25

6 License info ................................................................................... 26 7 Application Editor ......................................................................... 27

7.1 Overview ...................................................................................................... 29 7.1.1 Tree panel........................................................................................................... 29 7.1.2 Table panel ......................................................................................................... 29 7.1.3 Detail panel ........................................................................................................ 32 7.1.4 Message panel .................................................................................................... 32

7.2 Setting up an application .............................................................................. 33 7.2.1 General tab ......................................................................................................... 33 7.2.2 Page Settings tab ................................................................................................ 34 7.2.3 System Settings tab ............................................................................................ 35

7.3 Adding items to an application ..................................................................... 35 7.3.1 Add a device driver and device .......................................................................... 36 7.3.2 Add points .......................................................................................................... 38 7.3.3 Add runtime settings .......................................................................................... 45

6 - 390


Iris Version 3.0

8 Screen Editor ................................................................................. 52

8.1 Layout .......................................................................................................... 52 8.2 Iris form designer window............................................................................. 53 8.3 Editing and navigation buttons ..................................................................... 53

8.3.1 New .................................................................................................................... 53 8.3.2 Open ................................................................................................................... 53 8.3.3 Save file.............................................................................................................. 53 8.3.4 Save file as ......................................................................................................... 53 8.3.5 Undo ................................................................................................................... 54 8.3.6 Redo ................................................................................................................... 54 8.3.7 Select All ............................................................................................................ 54 8.3.8 Cut ...................................................................................................................... 54 8.3.9 Copy ................................................................................................................... 54 8.3.10 Paste ................................................................................................................... 54 8.3.11 Align to grid ....................................................................................................... 54 8.3.12 Set scale factor ................................................................................................... 55 8.3.13 Bring to front...................................................................................................... 55 8.3.14 Send to back ....................................................................................................... 55 8.3.15 Aling................................................................................................................... 55 8.3.16 Size ..................................................................................................................... 56 8.3.17 Set tab order ....................................................................................................... 56 8.3.18 View object inspector......................................................................................... 57 8.3.19 Show alignment palette ...................................................................................... 57 8.3.20 View and test results .......................................................................................... 57

8.4 Object buttons .............................................................................................. 57 8.4.1 Changing layout ................................................................................................. 58 8.4.2 Add ActiveX objects .......................................................................................... 60

8.5 Object Inspector ........................................................................................... 61 8.5.1 The properties page ............................................................................................ 62 8.5.2 The event page ................................................................................................... 63

8.6 Tag connector .............................................................................................. 64

7 - 390


Iris Version 3.0

9 Objects........................................................................................... 67

9.1 Action list ...................................................................................................... 68 9.2 Alarm grid panel ........................................................................................... 71 9.3 Angular meter............................................................................................... 73 9.4 Animate ........................................................................................................ 76 9.5 Arrow............................................................................................................ 79 9.6 Bevel ............................................................................................................ 82 9.7 Bit button ...................................................................................................... 84 9.8 Bit indicator .................................................................................................. 88 9.9 Bitmap image ............................................................................................... 91 9.10 Blotter........................................................................................................... 94 9.11 Button........................................................................................................... 97 9.12 Iris Chart..................................................................................................... 100 9.13 Checkbox ................................................................................................... 109 9.14 Check led ................................................................................................... 112 9.15 Check list box............................................................................................. 115 9.16 Color Dialog ............................................................................................... 119 9.17 Combo box................................................................................................. 121 9.18 Compass .................................................................................................... 125 9.19 Control bar ................................................................................................. 128 9.20 Cool bar...................................................................................................... 131 9.21 Date Time picker ........................................................................................ 135 9.22 DBasegrid .................................................................................................. 139 9.23 Digit group.................................................................................................. 142 9.24 Directory list box......................................................................................... 145 9.25 Draw grid.................................................................................................... 148 9.26 Drive combo box ........................................................................................ 152 9.27 Edit ............................................................................................................. 155 9.28 Filter combo box......................................................................................... 158 9.29 File list box ................................................................................................. 161 9.30 Find dialog.................................................................................................. 164 9.31 Font dialog ................................................................................................. 165 9.32 Gradient ..................................................................................................... 167 9.33 Group box .................................................................................................. 169 9.34 Header ....................................................................................................... 172 9.35 Header control............................................................................................ 174 9.36 Hotkey ........................................................................................................ 178 9.37 Image ......................................................................................................... 181 9.38 Image list .................................................................................................... 184 9.39 Indicator ..................................................................................................... 186 9.40 Jog meter ................................................................................................... 190 9.41 Label .......................................................................................................... 193 9.42 Iris label...................................................................................................... 196 9.43 Led bar ....................................................................................................... 199 9.44 Level bar .................................................................................................... 202 9.45 List box....................................................................................................... 205 9.46 List view ..................................................................................................... 209

8 - 390


Iris Version 3.0

9.47 Main menu ................................................................................................. 213 9.48 Mask edit .................................................................................................... 216 9.49 Media player............................................................................................... 219 9.50 Memo ......................................................................................................... 221 9.51 Meter .......................................................................................................... 225 9.52 Month calendar........................................................................................... 228 9.53 Notebook.................................................................................................... 231 9.54 Ole container.............................................................................................. 234 9.55 Open dialog................................................................................................ 237 9.56 Open picture dialog .................................................................................... 240 9.57 Page control ............................................................................................... 243 9.58 Page scroller .............................................................................................. 246 9.59 Paintbox ..................................................................................................... 249 9.60 Panel .......................................................................................................... 251 9.61 Popup menu............................................................................................... 254 9.62 Power meter............................................................................................... 256 9.63 Print dialog ................................................................................................. 259 9.64 Printer setup dialog .................................................................................... 261 9.65 Progress bar............................................................................................... 263 9.66 Radio button............................................................................................... 266 9.67 Radio group................................................................................................ 269 9.68 Replace dialog ........................................................................................... 272 9.69 Rich edit ..................................................................................................... 274 9.70 Iris rocker ................................................................................................... 278 9.71 Rotary switch.............................................................................................. 281 9.72 Save dialog ................................................................................................ 284 9.73 Save picture dialog..................................................................................... 286 9.74 Screen........................................................................................................ 288 9.75 Scrollbar ..................................................................................................... 291 9.76 Scroll box ................................................................................................... 294 9.77 Shape......................................................................................................... 297 9.78 Speed button.............................................................................................. 299 9.79 Splitter ........................................................................................................ 302 9.80 Static text ................................................................................................... 304 9.81 Status bar................................................................................................... 307 9.82 String grid................................................................................................... 311 9.83 Switch......................................................................................................... 314 9.84 Tab control ................................................................................................. 317 9.85 Tabbed notebook ....................................................................................... 320 9.86 Tab set ....................................................................................................... 322 9.87 Tank ........................................................................................................... 325 9.88 Timer .......................................................................................................... 328 9.89 Toolbar ....................................................................................................... 329 9.90 Track bar .................................................................................................... 332 9.91 Iris Track bar .............................................................................................. 335 9.92 Tree view.................................................................................................... 338 9.93 UpDown ..................................................................................................... 342 9.94 User led...................................................................................................... 345

9 - 390


Iris Version 3.0

10 Events ....................................................................................... 347 10.1 Keyboard events ........................................................................................ 348 10.2 Mouse events............................................................................................. 349 10.3 DragDrop events ........................................................................................ 350 10.4 Behaviour events........................................................................................ 351 10.5 Other events............................................................................................... 352 10.6 Example ..................................................................................................... 354 10.7 Special Iris statements ............................................................................... 356

10.7.1 ChangePage(‘PageName’) ............................................................................... 356 10.7.2 CloseWindow() ................................................................................................ 356 10.7.3 Popup(‘PopupName’)....................................................................................... 356

11 Alarming................................................................................... 357

11.1 Alarm groups.............................................................................................. 357 11.1.1 General ............................................................................................................. 358 11.1.2 Screen Colors ................................................................................................... 359 11.1.3 Printer Settings ................................................................................................. 360

11.2 Alarm blocks............................................................................................... 362 11.2.1 Block Settings .................................................................................................. 363 11.2.2 Alarm Definitions............................................................................................. 364

11.3 Value alarms .............................................................................................. 365 11.4 Alarm grid panel ......................................................................................... 366

12 Trending ................................................................................... 368

12.1 Trend Designer........................................................................................... 368 12.2 The Chart Editor ......................................................................................... 371

12.2.1 The Chart tab.................................................................................................... 372 12.2.2 The series tab.................................................................................................... 375 12.2.3 The data tab ...................................................................................................... 377 12.2.4 The tools tab ..................................................................................................... 377 12.2.5 The export tab................................................................................................... 378 12.2.6 The print tab ..................................................................................................... 379

13 On line changing an application ............................................... 380

13.1 Changing screens ...................................................................................... 380 13.2 Changes in the application editor ............................................................... 381

13.2.1 Changing or adding points ............................................................................... 382 13.2.2 Chang or add device drivers............................................................................. 385 13.2.3 Changing or adding Alarm blocks and groups................................................. 386

14 Index......................................................................................... 387

10 - 390


Iris Version 3.0

1 Introduction

1.1 Intended readership This manual is meant for the following groups:

• Persons who want to program with Iris. Certain knowledge of the connected PLC’s, their addresses and memory map is required.

• Persons who want to use Iris. • Persons who want to learn and investigate what is possible with Iris.

This manual is not meant for operators who have to work with an Iris interface as an object. A separate document from the persons or company who made the interface should be provided.

1.2 Applicability statement This document describes Iris version 3.0.

1.3 Purpose Iris is a visualisation program that can be used as an operator interface for PLC controlled object. Iris is also very useful for investigate problems with the connecting PLC, as help for technical personnel and PLC programmers. Iris combines a very user-friendly interface with a very high possible communication speed. This document describes how to create a user interface with Iris, how to make contact with the connected PLC’s and how to exchange information with these PLC’s.

1.4 Convections

This symbol provides you a extra tip or hint The text is written in italic characters

!

This symbol indicates a warning The text is written in italic characters

User input Input from the user or programmer is printed in Courier letter type<Enter> Keys which have to be pressed are indicated by < and > [Next] Buttons and menu items on the screen are indicated by [ and ] Text on the screen Text on the screen is typed in bold characters

11 - 390


Iris Version 3.0

2 Overview Iris is a visualisation and data acqusition program that can be used with the following interfaces:

• Modbus (Modicon) • Modbus+ (Modicon Quantum, Momentum etc.) • MPI (Siemens S7) • TCP/IP Ethernet (Modicon / Siemens / Allen Bradley) • Profibus * • OPC*

With Iris other native drivers can easily be implemented. If your driver is not mentioned here, please contact Raster Products. Iris SCADA runs on a PC with Windows XP as operating system. This may be an ordinary office PC or an industrial computer with touch screen. Iris Panelware runs on panels with Windows XP embedded installed. With Iris it is possible to create objects in one or more screens, it visualise the process that is controlled by the connected PLC’s. Also it is possible to create buttons and input fields for controlling and adjusting the process that is controlled by the connected PLC. Iris can show and log error messages and other warnings, and can log data and show this in a so-called trend diagram. The application can be changed online, which means that changes can be made to the application without stopping the application. This is possible for the graphical interface of the application as well as for the Tag database, alarms and trending. Iris can be configured as a stand-alone application or in Server / Client applications. For examples of Iris applications we advise you to take a look at the Iris website, www.IrisScada.com.

12 - 390


Iris Version 3.0

3 Installation of Iris Follow the next procedure for a full installation of Iris: Run the Iris Scada setup file by double clicking on it. The following window appears:

Within the combo box you can choose the language to use during the installation of Iris. You can choose between English, German and Dutch. The following screen will appear after choosing the language English.

Close all other applications and press [Next] to continue.

13 - 390


Iris Version 3.0

The following window appears:

You’ll have to accept the agreement if you want to continue the installation. After you have selected the accept radio button and have pressed the [Next] button, the installation procedure will ask you for the user information.

14 - 390


Iris Version 3.0

The following screen will appear after entering the user information.

If you want to change from directory, change the name in the edit box of this window or choose another directory by clicking on the [Browse] button. Default: C:\Program Files\Raster V3_0 Press [Next] if the edit box shows the directory you want to install Iris.

15 - 390


Iris Version 3.0


You can choose the Start menu folder in which a link to Iris will be made. Default value is Iris Scada V3.0. You can change this value in anything you want or choose an already existing directory using the [Browse] button.

16 - 390


Iris Version 3.0

The following screen appears:

The figure above shows the default values. Install LPT Dongle Hardware Drivers installs the drivers that are needed for recognising the dongle you have to plug in your parallel port of your computer. Without this dongle Iris runs in Demo mode (and automatically shuts off after 15 minutes). Install USB Dongle Hardware Drivers installs the drivers that are needed for recognising the dongle you have to plug in your USB port of your computer. Without this dongle Iris runs in Demo mode (and automatically shuts off after 15 minutes). Create a desktop icon creates a link on the desktop of your computer for easy starting up Iris via your desktop Create a Quick Launch icon creates a link in the Quick Launch toolbar that is mostly situated to the right of the Start button.

If you have already installed a previous version of Iris, it is possible that Install a Dongle Hardware Drivers is not checked.

Press [<Back] if you want to go back to a previous screen or [Next>] to continue.

17 - 390


Iris Version 3.0


This window shows the options you have chosen. Choose [<Back] if you want to change anything or choose [Install] to continue. An indictor appears and shows the progress of the installation process. When the installation process is finished the following window appears:

18 - 390


Iris Version 3.0

Default the set-up procedure starts the readme.txt of Iris when you press on [Finish]. If you do not want to view this file, remove the check before View Readme.txt. Press [Finish] to finish the installation procedure.

19 - 390


Iris Version 3.0

4 Starting Iris After starting Iris by double clicking on its icon on the desktop or from the start menu, you will see the splash screen of Iris Design Studio.

Within the [Options] menu you can select the different parts to configure Iris and design the application.

[Start Application] This will start the application, which is selected within the preferences window. [Start Screen Editor] This will start the Screen Editor of Iris. Within the Screen Editor the screen for the application is designed. The Screen Editor will be discussed in chapter 8 Screen Editor.

20 - 390


Iris Version 3.0

[Start Application Editor] This will start the Application Editor of Iris. Within the Application Editor the device drivers, tags and alarms are configured. The Application Editor will be discussed in chapter 7 Application Editor. [Show Preferences] This will show the Preferences Screen of Iris. Within this screen some default setting can be made for both the application and Screen Editor. The Preferences are discussed in chapter 5 Prefferences. [Show License Info] This will show the information of the license, which is installed for your copy of Iris. A license of Iris can be obtained by a hardware dongle or by a License File. This is discussed in chapter 6 License Info. After starting Iris, the splash screen will appear for a few seconds. After this, all the items mentioned before can be reached through the Iris icon in the tray bar by clicking with the right button of the mouse on this icon.

21 - 390


Iris Version 3.0

5 Preferences The preferences screen is shown when you choose [Options] at the splash screen followed with [Show Preferences]. The preferences screen can also be opened in the screen designer using the [View] menu. The preferences screen has four tabs: Application, Form Designer, Security and Windows Locks, which are described in the following paragraphs.

5.1 Application The Application tab looks like:

Under Application File you can fill in the file of the application when you want to start the application directly when you start Iris. You can fill in the name by typing the name in the white textbox, or by pressing the button with the three dots on the right side of the textbox. The three check boxes have the following functions: When Automatic Start Application is checked, the application starts automatically when Iris starts up. This is what you do normally when the application is ready and runs in its final surrounding. Normally you start Iris then also automatically when Windows starts up. When the Automatic Save Tag Edits is checked, Iris will save directly changes that are made in the tag configurations. When the Automatic Save Screen Edits is checked, Iris will save directly changes that are made in the Screen.

22 - 390


Iris Version 3.0

5.2 Form Designer The Form tab looks like:

In this tab you can make several settings for the Designer mode. Grid Settings By checking the box Display grid you select to see a grid in Designer mode. A grid is very useful if there are several objects on one page that have to be out-lined. When the Snap to grid function is checked, the pointer will move on the screen according to the grid. You can change the gridsize using the X and Y values. You change the size by using the arrow buttons next to the box. The higher the number, the bigger the grid will be. The Grid Color can be selected with the combo box. Underneath you’ll find some examples of grid sizes.

Grid size 20

Grid size 5

23 - 390


Iris Version 3.0

Tool behaviour Within this field you can select how de tools (Form Designer and Object Inspector) behave during engineering time. You can choose to have the Form Designer and Object Inspector always on top. If you do so, it is interesting to use the transparency function. The higher the number, the more transparent the windows are. This is very useful when you want to have a total survey of the page that you’re working on. The windows are only transparent when they are inactive, when you active the window the transparency is switched down. The following screen shows you the result of applying a high Transparency.

24 - 390


Iris Version 3.0

Allowed Actions Within this field you can limit the designer by un-checking several actions: Select components When unchecked it is not possible to select any object. Delete components When unchecked it is not possible to delete any object. Insert components into parent When unchecked it is not possible to insert an object into another (parent) object. E.g. it is not possible to insert a checkbox into a panel. Move components When unchecked it is not possible to move objects. Resize components When unchecked it is not possible to resize any object. Show invisible components When unchecked non-visual objects like for instance an action list will not be shown on the screen during design time. Edit properties When unchecked it is not possible to change the properties of objects.

5.3 Security Within the security tab you can protect your application from closing down. When a password is entered in the “Runtime Close Password” text box, Iris will ask for this password when the application is shut down. In case of a wrong password Iris will not be closed.

25 - 390


Iris Version 3.0

5.4 Windows locks Within the Windows Locks tab you can lock Windows key combinations, buttons and functions, which can disturb the purpose of an Iris station.

26 - 390


Iris Version 3.0

6 License info The License Info screen is shown when you choose [Options] at the splash screen followed with [Show License Info]. The following screen shows an example of license.

With Iris you can use a software license or a hardware dongle. The hardware dongle overrules the software license. By clicking on the button [Import License File] you can import the license file, which was sent to you by Raster or you local distributor.

27 - 390


Iris Version 3.0

7 Application Editor Within this chapter the Application editor is discussed. Within the Application editor the devices, to which Iris will be connected, are defined and the tags used in the application can be created. The Application Editor is shown when you choose [Options] at the splash screen followed with option [Start Application Editor]. When the splash screen is not shown you can launch the application editor by clicking with the right mouse button on the Iris icon in the tray bar and choose the option [Start Application Editor].

28 - 390


Iris Version 3.0

The editor is organized into four windows; Tree panel, Table panel, Detail panel and Message panel. If the windows are not visible, you can make them visible by selecting the windows in the [View] menu.

The windows can be hidden using the button. The window will be available in the application editor as a Tab page.

When the mouse pointer is moved over the tab, the screen will appear.

29 - 390


Iris Version 3.0

7.1 Overview The section gives a brief overview of the windows that are used in the application editor. Later on in this chapter the use of the different windows will be shown when items like numerical points and alarm groups are added to an application.

7.1.1 Tree panel The Tree panel shows the application in a tree view. Within this tree structure the devices and tags can be added to the application. You can also make the alarm blocks and – groups. At the first start-up, only the application item will be visible.

By clicking on the Application with the right button of the mouse you can insert application objects like Device drivers, Alarm Groups, Alarm Blocks and Points. Further on in this chapter the creation of the different parts are discussed.

7.1.2 Table panel The table panel shows information of the selected items in the tree panel in a table layout. This gives the developer a clear view of the items with their details. The table panel is very useful when a large amount of almost the same points must be added. With the table panel it is also possible to filter or sort the items or to group items to a certain header.

Clicking on a column’s header will make the table panel sort that column ascending or descending. Columns can be moved using drag and drop. When dragging a column, green arrows will appear indicating the position where the column will be dropped if the mouse button is loosened.

30 - 390


Iris Version 3.0

The developer can also drag the columns to the top of the Table panel. This will activate the filter function. E.g. when the column “Device” is dragged to the top of the panel, the panel will show the items grouped by the Device column. The following screen shows an example of this.

The header of the panel shows the “Device” column. Pressing on the arrow on that column will give the developer the options to show the items related to, in this case, PLC_1 and PLC_2.

There is also the option (Custom…). With this option it is possible to customize the filter condition. Selecting this option will make the following window appear.

In this screen, two conditions can be set for using the filter function. This condition only applies to the column that is dragged into the header of the table panel. In case a filter is applied, the table panel shows on the bottom of the panel the following bar.

31 - 390


Iris Version 3.0

The following functions are available: Item Description

Clicking on this box will delete the filter condition and the table panel will show all the items. Also the filter bar will be closed.

Un checking the checkbox will disable the filter condition but the filter bar will be available. This is very useful when the developer wants to disable the condition just for a short time.

The combo box shows the selected filter condition. With the arrow the developer can select quickly previous used conditions.

With the customize… button conditions can be customized using not only the column which is dragged to the table panel header but also using all other columns.

Customize… Pressing on the [Customize…] button will make the following screen appear.

Within this window several filter conditions can be programmed. Using the hyperlinks the conditions can be added, changed of parameter and arguments. The programmed filter can be saved so it can easily be reused at a later time.

32 - 390


Iris Version 3.0

7.1.3 Detail panel The detail panel gives detailed information about the selected item. The detail panel is mostly used when the developer configures the items, all the parameters of the items can be configured in this panel. The following screen gives an example of the detail panel for a point.

Notice that the detail panel often has the following buttons available.

Validated changes made in the detail panel.

Cancels changes made in the detail panel.

Scrolls to the previous item in the tree panel.

Scrolls to the next item in the tree panel.

Add a new item of the selected item. When a point is selected showing the detail panel, a new point is created.

7.1.4 Message panel Within the message panel messages are shown which actions are made during the session.

33 - 390


Iris Version 3.0

7.2 Setting up an application When starting a new application you first have to make some basic settings for the application. When you click on the application item in the tree panel of the application screen the detail panel gives you three tabs to make general settings for the application. The different tabs are now discussed.

7.2.1 General tab The following picture shows the General tab within the Detail panel when the application item is selected.

The following table explains the different options within the general tab. General Description

Application General Settings

Description A field to enter a brief description of the application.

34 - 390


Iris Version 3.0

7.2.2 Page Settings tab The following picture shows the Page Settings tab within the Detail panel when the application item is selected.

The following table explains the different options within the Page Settings tab. Page Settings Description

Page Settings

Page Dir Defines the directory in which the graphical pages (screens) of the applications are stored.

35 - 390


Iris Version 3.0

7.2.3 System Settings tab The following picture shows the System Settings tab within the Detail panel when the application item is selected.

The following table explains the different options within the System Settings tab. System Settings Description

System Settings

System Alarmgroup Defines the base Alarmgroup of the application.

7.3 Adding items to an application In this section is described how to add items to an application and how to configure them. The following order will be used:

• Add a device driver and device; • Add Points.

Adding alarm groups and alarm blocks will be discussed in chapter 11 Alarming.

36 - 390


Iris Version 3.0

7.3.1 Add a device driver and device The first thing to do when developing a new application is to add a device driver to which Iris should communicate. To add a device driver, select the Application in the application tree, click on the right button of the mouse and go with the mouse pointer to the [Insert] option. Here you see the possible items to insert in an application. Choose the [Device Drivers] item. Iris will ask to enter a unique name for the Device Drivers item.

After inserting the Device Drivers items you can add the specific driver you want to use. This will go in the same way. Go to the Device Drivers item, click on the right button of the mouse en go to the [Insert] option. This option will collapse showing all possible drivers to be inserted. In this manual we choose the Modbus driver.

After choosing the device driver, Iris will come with a window to enter a unique name for the driver to use in the application.

After validating this window with [Ok], the device driver will be added to the application tree.

37 - 390


Iris Version 3.0

In the Detail panel you can enter the specific parameters for the Modbus communication.

Item Description

Base Settings

Description A field to enter a brief description of the communication driver. Polling Interval (ms) The interval on which Iris should update his communication.

Modbus Mode Defines the mode of Modbus communication, RTU of ASCII. Comm Port Defines the communication port to use. BaudRate Defines the BautRate of the Modbus communication. Date Bits Defines the number of Data Bits to be used for the communication. Stop Bits Defines the number of Stop Bits to be used for the communication. Parity Defines the Parity to be used for the communication.

To add a device connected to the device driver, select the Modbus driver and press the right button of the mouse and select the option [Insert Modbus Device].

38 - 390


Iris Version 3.0

Again, Iris will come with the following window to enter a unique name for the Modbus Device.

After validating with the [OK] button the Modbus device is added to the application tree. Within the Detail panel you can change the setting for the device.

7.3.2 Add points After configuring the device(s) to which iris will communicate you can configure the specific points that refer to specific addresses in the device(s). The points can be created in groups. First, like with the addition of device drivers, you have to make the tag item. Click on the Application item, click on the right button of the mouse en go to the option [Insert]. Choose the option [Points].

39 - 390


Iris Version 3.0

Enter a unique name for the Point item. Under this Point item the Numerical points will be defined. After validating with [Ok], the Point item will be shown in the application tree. Now in the same way you can insert the different points for your application. Click on the Point item, click on the right button of the mouse and go to the option [Insert Num Point].

Again you will be asked to enter a unique name for the Point. After validating with [Ok] the point will be inserted in the application. Within the Detail panel settings for the point can be made. The following screens explain the possible options that you have.

40 - 390


Iris Version 3.0

General The following picture shows the General tab within the Detail panel when a point is selected. Within this tab you can define the kind of the point.


Definition

Description A field to enter a brief description of the point. TagName The name of the point that was entered when the tag was created. Here the name can

be modified remembering that the name must be unique with an application. TagType Defines the type of the point. Possibilities are:

Unsigned Int Signed Int Float Boolean String

Attributes Min Level Disabled When checked the point is completely disabled from the application and has no

functionality. AlarmsEnabled When checked the point will be enabled for Alarms. ReadOnly When checked the point will only read data from the device and will not be able to

write data. Virtual Point When checked the point will act like an internal tag. No data will be sent to a device.

41 - 390


Iris Version 3.0

Device The following picture shows the Device tab within the Detail panel when a point is selected. Within this tab you can define from which device and location the point gets its data.

The following table explains the different options within the device tab. Device Description

Scan Properties

Device Defines the device from which the point should get its data from. You can enter the device name into the combo box or use the dropdown list to select the device.

Format Defines the format of the data from the device. When “Auto” is selected Iris will define the format itself with the information of the device which is configured.

Data References Read Ref Defines the address within the device from which the point gets its data from. Write Ref Defines the address within the device to which the point will write its data to.

Scanning Mode Always Scan When checked the data of the point will always be updated. This overrules the interval

property. Interval Defines the interval time on which the data of the point will be updated.

42 - 390


Iris Version 3.0

Limits The following picture shows the Limits tab within the Detail panel when a point is selected. Within this tab you can define limits for the point.

The following table explains the different options within the limits tab. Limits Description

Readout Limits

Low Limit Defines the lower limit for the point. This can be a constant value entered into the edit box or another point selected using the three dot button. The limit must be enabled before it takes effect.

High Limit Defines the higher limit for the point. This can be a constant value entered into the edit box or can be another point selected using the three dot button. The limit must be enabled before it takes effect.

Setpoint Limits Low Limit Defines the lower limit for the point. This can be a constant value entered into the edit

box or can be another point selected using the three dot button. The limit must be enabled before it takes effect.

High Limit Defines the higher limit for the point. This can be a constant value entered into the edit box or can be another point selected using the three dot button. The limit must be enabled before it takes effect.

43 - 390


Iris Version 3.0

Conversion The following picture shows the Conversion tab within the Detail panel when a point is selected. Within this tab you can define scaling properties for the point.

The following table explains the different options within the conversion tab. Conversion Description

Conversion Mode

None When selected no scale will be applied to the point. Scale When selected linear scaling will be applied to the point according to the Linear Scale

Settings. Enumerate Not available

Linear Scale Settings Raw Range Defines the Raw range from the device e.q. 0 – 65535. Scaled Range Defines the scaled range for the tag e.q. 0 – 100.

Iris will calculate with the scaled point within the application.

44 - 390


Iris Version 3.0

Trend & Data Logging The following picture shows the Trend & Data Logging tab within the Detail panel when a point is selected. Within this tab you can define scaling properties for the point.

The following table explains the different options within the Trend & Data Logging tab. Trend & Data Logging Description

Trend Logging Properties

Enable Trend Data logging can be enabled using this field. Entering a 0 or 1 (false or true) in this field will enable data logging for this point. Also a point can be defined here when you want to enable data logging for a point using another point in the application.

Table Name Defines the name of the database into which the Trend data must be logged. Deadband When checked you can define the deadband to be used when Trend data is logged

to avoid numerous logging on slight changes of the point. Interval When checked you can log Trend data using an interval time.

Both Deadband and Interval can be used together. Data Logging Properties

Enable Data logging can be enabled using this field. Entering a 0 or 1 (false or true) in this field will enable data logging for this point. Also a point can be defined here when you want to enable data logging for a point using another point in the application.

Table Name Defines the name of the database into which the data must be logged. Trigger When the point defined in this field changes, there will be one sample logged into

the database. Log Null Values When checked Null values are also logged.

45 - 390


Iris Version 3.0

Alarms The following picture shows the Alarms tab within the Detail panel when a point is selected. This tab will be discussed in detail in chapter 11 Alarming.

7.3.3 Add runtime settings You have to make runtime settings for an Iris application. Runtime Settings means assigning data bases and settings for the database and defining the screens and monitors. You insert the Runtime Settings in the same way.

After you have inserted the Runtime Settings you can insert under these settings the FirebirdLogger and Viewport.

46 - 390


Iris Version 3.0

Firebird Logger When you have inserted the Firebird Logger you have the following Detail panel.

The following table explains the different options within the General tab. General Description

Definition

Description A field to enter a brief description of the logger. Deadband Defines the name of the Firebird Logger.

Attributes Store Days Defines the number of days that the logger has to keep in his database

47 - 390


Iris Version 3.0

The following screen shows the SQL server tab of the Firebird Logger.

The following table explains the different options within the SQL Server tab. SQL Server Description

Location

HostName Defines the name of the host computer when the database is not local located but on a different computer within the network.

DB Name Defines the name of the database. Data references

User Name Defines the user name of the database. PassWord Defines the password of the database.

48 - 390


Iris Version 3.0

Viewport With viewports you define monitors that the application will use to show the screens of the application. You can define 4 different monitors on which the application can be shown. Within a viewport you can define several viewframes that will show the content of a page. So on one monitor you can show several pages of the application. To add a viewport you click on the RuntimeSettings and click the right mouse button and choose “Insert View Port”.

A Viewport has two tabs in the detail panel. The following screen shows the General tab.


Definition

Description A brief description of the viewport. Name Defines the name of the viewport. Monitor Defines the monitor number on which this viewport is shown. You can choose

between 0, 1, 2 and 3. 0 is the local monitor of the computer on which the Iris application is running.

49 - 390


Iris Version 3.0

The following screen shows the Attributes tab.

The following table explains the different options within the Attributes tab. Attributes Description

Position

Top Defines the top position of the viewport on the monitor. The distance between the top of the monitor and the viewport is defined in pixels.

Left Defines the left position of the viewport on the monitor. The distance between the left end of the monitor and the viewport is defined in pixels.

Height Defines the height of the viewport in pixels. Width Defines the width of the viewport in pixels.

Window Style Borderstyle Defines the border style of the viewport:

None: The viewport will have no border. This means also that there are no buttons and it is not possible to change the size of the viewport. Single: The viewport will have a normal border but is not sizeable. So only the initial state defined in the position field, maximized and minimized are possible. Sizeable: The viewport will have a normal border that is also sizeable. Dialog: The viewport will have a dialog look that means that there are no minimize and maximize buttons (even when they are checked). ToolWindow: The viewport will be shown like a tool window with a smaller border and no minimize and maximize buttons (even when they are checked). The window is also not sizeable. SizeToolWin: Same as ToolWindow but sizeable.

WindowState Defines the initial state of the viewport: Normal: the viewport will be shown as defined in the position area. Minimized: the viewport will be shown minimized. Maximized: the viewport will be shown maximized.

Minimize Button When checked the viewport will have a minimize button.

Maximize Button When checked the viewport will have a maximize button.

System Menu When checked the viewport will have a system menu.

50 - 390


Iris Version 3.0

After a viewport is defined, you can define the viewframes. A viewframe is the frame within the viewport (monitor) in which the graphics will be shown.

The viewframe has two tabs in the detail panel. The following screen shows the general tab.


Definition

Description A brief description of the viewframe. Name Defines the name of the viewframe. Start Page Defines the start page that will be shown in this viewframe when the application is

started.

51 - 390


Iris Version 3.0

The following screen shows the Attributes tab.

The following table explains the different options within the General tab. Attributes Description

Attributes

Top Defines the top position, in pixels, of the viewframe within the viewport. Left Defines the left position, in pixels, of the viewframe within the viewport. Height Defines the height, in pixels, of the viewframe. Width Defines the width, in pixels, of the viewframe. Align Defines the position of the viewframe within the viewport:

None: The viewframe will use the position number define above Top: The viewframe will be stretch out on top of the viewport taking only the height in account. Bottom: The viewframe will be stretch out on the bottom of the viewport taking only the height in account. Left: The viewframe will be stretch out on the left of the viewport taking only the width in account. Right: The viewframe will be stretch out on the right of the viewport taking only the width in account. Client: The viewframe will be stretch out all over the viewport.

Update Caption When checked the Caption of the viewport will be updated with the caption of the selected viewframe.

52 - 390


Iris Version 3.0

8 Screen Editor This chapter describes the screen editor of Iris. All the tools that are available in the screen editor to build up a screen will be reviewed. The objects to build up the application are discussed in the chapter 9 Objects.

Notice that the screen editor can work completely independent from an application. This makes it possible to make online changes to the graphical layout of a screen in an application.

8.1 Layout We can start the screen editor from the [Options] menu in the splash screen of Iris or right clicking on the Iris Icon in the tray-bar. Choose the option [Start Screen Editor]. The following two windows will appear. The windows are called the Iris Form Designer window and the Object Inspector. Notice that at this moment only the screen editor is opened, not yet a screen.

53 - 390


Iris Version 3.0

8.2 Iris form designer window This window contains several buttons to edit and navigate screens and buttons of possible objects to be placed on the screen. Editing and navigation buttons Object buttons

8.3 Editing and navigation buttons In this section all the editing and navigation buttons will be reviewed. Many of the buttons are known for standard Windows application, others specialized buttons for Iris.

8.3.1 New

This button will create a new screen. An open screen will be closed when creating a new screen. If the open screen is not saved, there will be asked for it to save it or not. This function is also available in the [File] menu.

8.3.2 Open

With the “Open” button you can open an existing screen. The screen can be selected from any directory. Clicking on the arrow next to the button will show a list of the latest opened screens. An open screen will be closed when opening another existing screen. If the open screen is not saved, there will be asked for it to save it or not. This function is also available in the [File] menu.

8.3.3 Save file

With the save file button a screen is saved. If the screen has not been saved before Iris will ask for a file name. This function is also available in the [File] menu.

8.3.4 Save file as

With the save file button a screen is saved and Iris will always ask for a file name. When the screen has been saved before, that filename is default. This function is also available in the [File] menu.

54 - 390


Iris Version 3.0

8.3.5 Undo

Using the undo button will undo the latest action that has been done. E.g. when an object is moved on the screen the undo button will set back the object to its original position. This function is also available in the [Edit] menu.

8.3.6 Redo

The redo button redoes the action that has been undone by the undo button. E.g. when an object is moved on the screen the undo button has set back the object to its original position, the redo button will place the object again to the place where it has been moved to in the first place. This function is also available in the [Edit] menu.

8.3.7 Select All

The select all button selects all objects that are placed on the screen. This function is also available in the [Edit] menu.

8.3.8 Cut

The cut button will cut selected objects from the screen and puts it on the clipboard. Using the paste button the objects can be placed again on the screen. The objects are placed on the clipboard including all property settings. This function is also available in the [Edit] menu.

8.3.9 Copy

The copy button copies selected objects to the clipboard. Unlike to the cut button, with the copy button the original objects will remain on the screen. This function is also available in the [Edit] menu.

8.3.10 Paste

The paste button pasts objects from the clipboard to the screen that where placed on the clipboard using the cut- and copy buttons. This function is also available in the [Edit] menu.

8.3.11 Align to grid

The align-to-grid button will snap selected objects to the grid. All non-selected objects will not be snapped to the grid. This function is also available in the [Position] menu.

55 - 390


Iris Version 3.0

8.3.12 Set scale factor

The Set scale factor will scale the selected objects. When this button is pressed a window will appear where you can enter the scale factor (a percentage of the original size). This function is also available in the [Position] menu.

8.3.13 Bring to front

This button will bring the selected object to the front. E.g. when two images are placed on the screen, the image that has been brought to the front will always stay on top. This function is also available in the [Position] menu.

8.3.14 Send to back

This button will send the selected object to the back. E.g. when two images are placed on the screen, the image that has been send to the back will always stay behind the other image. This function is also available in the [Position] menu.

8.3.15 Aling..

When two objects are selected, the objects can be aligned. Clicking on this button will show the Alignment window where the desired horizontal and vertical alignment for those objects can be selected. This function is also available in the [Position] menu.

56 - 390


Iris Version 3.0

8.3.16 Size

This is a tool for changing the size of an object related to other objects or to enter the exact size in pixels. The width and the height of an object can be separately changed. This function is also available in the [Position] menu.

8.3.17 Set tab order

This button will show the Tab order window. In this window all the controls placed on a screen are showed. This defines the order of activity when the [Tab] key on the keyboard is used. The Tab order can be changed using the arrow keys. This function is also available in the [Position] menu.

57 - 390


Iris Version 3.0

8.3.18 View object inspector

This button will show the Object Inspector. If the Object Inspector is already shown then this button has no function. This function is also available in the [View] menu.

8.3.19 Show alignment palette

This button will show the alignment pallet with several buttons to align objects on the screen. The buttons in this palette are only available when more than one object is selected. This function is also available in the [View] menu.

8.3.20 View and test results

With this button the developer can view and test the result of a designed screen. Clicking on this button will show the screen as if it is in runtime mode. All internal commands can be tested like setting property values or event handlers. Off course there is no communication to any device so objects using information from devices will result 0. This function is also available in the [View] menu.

8.4 Object buttons The object buttons in the Iris Form Designer are standard categorized in several tabs. The developer can change the layout of these tabs to create the layout that fits him the best for its application. This means he can create his own tabs containing the different object button. It’s also possible to add ActiveX objects to the Iris Form Designer. The functionality of the object buttons are discussed in the chapter 9 Objects.

58 - 390


Iris Version 3.0

8.4.1 Changing layout To change the layout of the object tabs you’ll have to open the property page of the Iris Form Designer. To do this, go with the mouse pointer to the Object tabs area and click on the right button of the mouse and choose the option [Properties…]. The following screen will appear.

Within this screen tabs (pages) can be added, deleted or moved to a position to the developer’s wishes. To add a tab you’ll have to click on the [Add…] button. The following screen will appear. Here you’ll have to enter a unique name for you page.

After validating with [Ok] you’ll see that the page is added to the existing list of pages. When you select your page you’ll see the page shows no current components. To add components you select the desired component in a tab and drag it into your tab. Notice that there is an All page that contains all possible objects but is not shown in the Iris Form Designer. Here you’ll find all possible components.

59 - 390


Iris Version 3.0

When you have dragged a component to your own page, it will be deleted from the page on which it was originally stored. A component can only be one time displayed. In this example we drag the Button, Label and Edit box into the page we have called John.

After dragging all components into our page we can change the position of the page in the list using the [Move Up] and [Move Down] buttons. After closing the Properties window with [Ok] the layout of the Iris Form Designer will look as following.

60 - 390


Iris Version 3.0

8.4.2 Add ActiveX objects It is also possible to add ActiveX components to Iris Form Designer. To do this, go with the mouse pointer to the Object tabs area and click on the right button of the mouse and choose the option [Components…]. The following screen will appear.

This screen shows a list of all ActiveX components installed on your PC. To add components just check the checkbox in front of the desired component and close the screen with [Ok]. In the Iris Form Designer you’ll notice that there has been a tab added called ActiveX. In this tab the components selected are stored and ready for use in your application.

Notice that ActiveX components have extended properties that are not discussed in this manual.

61 - 390


Iris Version 3.0

8.5 Object Inspector The Object Inspector contains all properties and Events of a selected object (also from the screen itself). The next Object Inspector window is from an Image. The properties of the object are categorized by functionality. Although every object has its specific properties, many properties will come back in every object.

At the top of the Object Inspector is a drop-down list containing all the objects on the active screen and it also displays the object type of the selected component. This lets you quickly display properties and events for the different objects on the current screen. The Object Inspector has two pages:

• The properties page; • The Events page.

These pages will be discussed in the next sections. On the bottom of the Object Inspector is a field that shows a brief description of the selected property or event. This description is only shown when it is available for that specific property of event.

62 - 390


Iris Version 3.0

8.5.1 The properties page The Properties page of the Object Inspector enables you to set design-time properties for objects on a screen, and for the screen itself. By setting properties at design time you are defining the initial state of an object. You can set runtime properties by writing code within event handlers. The Properties page displays the properties of the component that is selected on the screen. The first column on the Properties page lists the names of the selected object’s published properties: If a plus sign (+) appears beside a property name, this can be clicked to display the sub-properties of that property. This can be a list of possible values when the property represents a set of flags (the value column lists the set enclosed in square brackets []), or sub-properties if the property represents an object (the value column gives the name of the object, enclosed in parentheses). Similarly, if a minus sign (-) appears, this can be clicked to collapse the sub-properties. When a property has focus, you can also use the keyboard + and – keys to expand or collapse properties. The second column on the Properties page displays the property values: When the property is selected, the value changes to an edit control where you can type a new value. If the value can be set using a dialog, an ellipsis button (...) appears when the property is selected. Click this button to display a dialog where you can set the property. You can also display the dialog by double-clicking. If the value is an enumerated type, a drop-down button appears when the property is selected. Click this button to display a drop-down list that you can use to set the property. You can see images in the drop-down lists for properties that include images such as cursors, brush types, colors, and image lists. To view images referenced by the ImageIndex property, you need to set the property that holds the image list containing the images. You can resize the columns of the Object Inspector by dragging the separator line to a new position. The Object Inspector dynamically changes the set of properties it displays, based on the objects that are selected. Only the shared properties are displayed. For example, if you select a Label and a GroupBox, you'll see the property Color along with other properties. If you select a Label and then a Button, the choice for Color goes away because Color is not a property for buttons. The Object Inspector has several other behaviours that make it easier to set object properties at design time.

63 - 390


Iris Version 3.0

When you use the Object Inspector to select a property, the property remains selected in the Object Inspector while you add or switch focus to other objects in the screen, provided that those objects also share the same property. This enables you to type a new value for the property without always having to reselect the property. If an object does not share the selected property, the product selects its Caption property. If the object does not have a Caption property, the product selects its Name property. When more than one object is selected in the screen, the Object Inspector displays all properties that are shared among the selected objects. This is true even when the value for the shared property differs among the selected objects. In this case, the property values displayed are either the default, or the value of the first object selected. When you change any of the shared properties in the Object Inspector, the property value changes those values in all the selected objects. There is one exception to this: when you select multiple objects in a screen, the Name property no longer appears in the Object Inspector, even though they all have a Name property. This is because you cannot assign the same name to more than one object in a form. The properties of every object available in Iris are discussed in chapter 9 Objects.

8.5.2 The event page The Events page of the Object Inspector enables you to connect forms and objects to program events. To generate a default event handler for an event, double-click the right column. Iris creates the event handler and switches focus to the Code editor. In the Code editor, you write the event handlers that specify how an object or a screen responds to a particular event. When you select an event, the value column can display a drop-down list of existing event handlers that can respond to the event. Choose one of these existing event handlers if you write one event handler to respond to multiple events. The Events page displays only the published events of the object that is selected in the screen. Events and Event handlers are discussed in chapter 10 Events.

64 - 390


Iris Version 3.0

8.6 Tag connector When you want to link numerical points to a property of and object, you have to use the Tag Connector. When you double click on an object the Tag Connector will appear. The following screen shows the Tag Connector.

The Tag Connector has two columns, the Object Property column and the Linked Tag column. Some objects have Pre-selected view properties in the Tag Connector, other objects have an empty Tag Connector. When no properties are available you can add properties by pressing the arrow down key on the keyboard. A line is added in the Tag Connector. With the pull-down menu you can select a property of the object to which you want to link a point to. See the following screen.

65 - 390


Iris Version 3.0

Once you have selected a property you can link the point. All available points of the application can be selected in the Linked Tag column.

On the right side of the Tag Connector screen there is a Button called Pre-Selected. With this button you can customize the Tag Connector for every object. When you use an object in an Application a lot, it is nice when you can select directly the point to a property. When you press on the button the following screen will appear.

Within this screen you can select the properties that you want to appear directly in the Tag Connector for a certain object. When you place another object of the same type on a screen, those properties will be shown in the Tag Connector of that object.

66 - 390


Iris Version 3.0

There is also a button “Extended” in the Tag Connector screen. With this button you can make the detail panel of a point available in the Tag Connector screen.

As you can see it is also possible to add a new point to the application. That makes is easier to develop application.

67 - 390


Iris Version 3.0

9 Objects In this chapter the properties of all possible objects will be discussed. Obviously many properties are the same for many objects. The objects will be discussed in alphabetical order. The properties of the objects will be discussed in order of its Object Inspector. The events that can be connected to an object will be discussed in the chapter 10 Events.

68 - 390


Iris Version 3.0

9.1 Action list

The Action list object maintains a list of actions that are available to the client controls in an application such as buttons or menu items. You can add action list objects to your screen or data module from the standard page of the component palette. Double-click the action list to display the action list editor, from which you can add, delete and rearrange actions.

Basic layout when first placed on the screen.

Action list properties

Explanation of the Action list properties: Property Description

Misc

Name Returns or sets the name used in code to identify an object. Tag Stores any extra data needed for your program.

Other Images Lists of images available for actions in the action list.

The Images property is a list of bitmaps that can be displayed to the left of any action in the action list. An action is associated with an image from this image list by its ImageIndex property. This image can then appear on client controls such as menu items, tool buttons, and so on. See also the object Image List.

State Indicates whether the actions in the action list respond when the user triggers a client object. asNormal: Actions perform their normal response when triggered by client objects or hotkeys. asSuspended: The actions in the action list do not respond when client objects tell them to “fire”. The Enabled property for all actions in the list is unchanged. asSuspendedEnabled: The actions in the action list do not respond when client objects tell them to “fire”. The Enabled property for all actions in the list is set to True.

69 - 390


Iris Version 3.0

Double clicking on the Action List object will make the Action list editor appear.

Action properties

70 - 390


Iris Version 3.0

Within this screen actions can be added or deleted using the buttons on top of the screen. Property Description

Appearance

Caption Returns or sets the text displayed in an object’s title bar or below an object’s icon. Behaviour

Enabled Returns or sets a value that determines whether an object can respond to user-generated events.

GroupIndex Visible Returns or sets a value that determines whether an object is visible or hidden.

Misc HelpContext HelpContext property specifies the help context for the action when it is set. Name Returns or sets the name used in code to identify an object. Tag Stores any extra data needed for your program.

Hint Hint Returns or sets the text displayed when the mouse is paused over the control.

Other AutoCheck When checked the Checked property toggles when the action executes. Category Specifies the category under which the action appears in its action list. Checked Indicates whether client controls and menu items appear checked. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. ImageIndex Identifies an image that is associated with controls and menu items that use this

action. SecondairyShortCuts Specifies the short cuts (in addition to ShortCut) for triggering. ShortCut The ShortCut property holds the value that is the shortcut for the action when it is

set.

71 - 390


Iris Version 3.0

9.2 Alarm grid panel

With the Alarm grid panel alarms can be made visible. The alarm grid can be placed on several pages; it is also possible to place more than one alarm grid panel on one page.


Alarm grid panel properties

72 - 390


Iris Version 3.0

Explanation of the Alarm grid panel properties: Property Description

Appearance

Cursor Specifies the image used to represent the mouse pointer when it passes into the region covered by an object.

Misc HelpContext Specifies the default help file context ID for an object. Name Returns or sets the name used in code to identify an object. Tag Stores any extra data needed for your program.


Position Height Returns or sets the height of an object. Left Returns or sets the distance between the internal left edge of an object and the left

edge of its container. Top Returns or sets the distance between the internal top edge of an object and the top

edge of its container. Width Returns or sets the width of an object.

Other ColAckNowledge Specifies settings for the Acknowledge column. ColAckTime Specifies settings for the AckTime column. ColAlarmGroup Specifies settings for the Alarmgroup column. ColColdTime Specifies settings for the ColdTime column. ColHotTime Specifies settings for the HotTime column. ColMessage Specifies settings for the Message column. ColPriority Specifies settings for the Priority column. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Settings Specifies settings for the Alarm grid panel in general.

More information concering alarms you’ll find in chapter 11 Alarming.

73 - 390


Iris Version 3.0

9.3 Angular meter

The Angular meter represents graphically the value of a tag. The angular meter has powerful graphical options as will be described here.


Angular meter properties

74 - 390


Iris Version 3.0

Explanation of the Angular meter properties: Property Description

Appearance

Caption Returns or sets the text displayed in an object’s title bar or below an object’s icon. Color Returns or sets the background color of the component. Cursor Specifies the image used to represent the mouse pointer when it passes into the

region covered by an object. ParentColor To have a control use the same color as its parent control, check the ParentColor

property. When unchecked the control uses its own Color property. Transparent When checked the background of the object is transparent. When unchecked the

object uses the background color stored in the color property or from the ParentColor property when this one is checked.

Behaviour DragCursor Indicates the image used to represent the mouse pointer when the control is being

dragged. DragMode Returns or sets a value that determines whether manual or automatic drag mode is

used. Visible Returns or sets a value that determines whether an object is visible or hidden.

Font Font Returns or sets the font characteristics of the component, including typeface, size,

attributes and color. Misc

HelpContext Specifies the default help file context ID for an object. Name Returns or sets the name used in code to identify an object. PopupMenu Identifies the pop-up menu associated with the control. Tag Stores any extra data needed for your program.

Hint Hint Returns or sets the text displayed when the mouse is paused over the control. ParentShowHint When ParentShowHint is checked, the control uses the showHint property value of

its parent. If not, the control uses its own ShowHint property. ShowHint Determines if the control should display a hint when the mouse pointer rests

momentarily on control. Position

Height Returns or sets the height of an object. Left Returns or sets the distance between the internal left edge of an object and the left



Other Anchors Specifies how the control is anchored to its parent. Use this property to ensure that a

control maintains its current position relative to an edge of its parent, even if the parent is resized.

Angle Defines the angle of the scale measured from a vertical line. When the angle is 0 and the position of the needle is 0 the needle will point down.

AngelOffset Defines the angle of the scale to be applied. CenterDotColor Defines the color of the center dot on the needle. CenterDotWidth Defines the width in pixels of the center dot of the needle. ColorZone1 Defines the color of Zone 1. The zones are defined by the properties Percent1 and

Percent2. ColorZone2 Defines the color of Zone 2. The zones are defined by the properties Percent1 and

Percent2. ColorZone3 Defines the color of Zone 3. The zones are defined by the properties Percent1 and

Percent2.

75 - 390


Iris Version 3.0

Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum width and height of an object. When specified, the object cannot be resized to violate those constraints.

Decimals Defines the number of decimals to be used on the scale. DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Labels Defines the number of labels to be used on the scale. LabelsFont Defines the font to be used for the numbers on the scale. LabelsOffset Defines the distance in pixels between the labels and the inside of the scale. MaxValue Defines the maximum value for the angular meter. MinValue Defines the minimum value for the angular meter. NeedleBaseWidth Defines the width of the needle base in pixels. NeedleColor Defines the color of the needle. NeedleLength Defines the length of the needle in pixels. NeedlePosition Specifies the Tag from which the object gets its actual value from. The tag is

specified using the Tag selector function as described earlier in this chapter. Percent1 Defines the percentage of the scale that will be used for Zone 1. Percent2 Defines the percentage of the scale that will be used for Zone 2. Zone 3 is the

leftover when Percent1 and Percent2 together is less than 100%. Position Represents the actual value of the angular meter. Radius Defines the radius in pixels of the angular meter. Spacing Defines the space between the scale and the outside of the selected field for the

Angular meter. Ticks Defines the number of ticks (notches) to be used over the whole scale. TicksColor Defines the color of the ticks. TicksEnlarge Defines the number of large ticks on the scale. When set to 10, every 10th tick will be

a large one. When set to 20 every 20th tick will be a large one. TicksMax Defines the length of the big Ticks (notches). TicksMin Defines the length of the small Ticks (notches). Version Represents the version of the object. It has no functionality.

Examples

76 - 390


Iris Version 3.0

9.4 Animate

Use the Animate object to put an animation on a screen. An animation is a window that silently displays an Audio Video Interleaved (AVI) clip. An AVI clip is a series of bitmap frames like a movie. Although AVI clips can have sound, animation controls only work with silent AVI clips.


Animate properties

77 - 390


Iris Version 3.0

Explanation of the Animate properties: Property Description

Appearance

Color Returns or sets the background color of the component. Cursor Specifies the image used to represent the mouse pointer when it passes into the




Behaviour Visible Returns or sets a value that determines wether an object is visible or hidden.




momentarily on the control. Position

Align Determines how an object aligns within its parent object. Use the align property to align the object on the top, left, bottom or right of a parent (e.g. panel or page) and have it remain there even if the size of that parent changes.

AutoSize Determines whether a control is automatically resized to display its entire context. Height Returns or sets the height of an object. Left Returns or sets the distance between the internal left edge of an object and the left



Other Active Indicates whether the animation object is playing the AVI clip. When checked the

object will cycle through the frames specified by the StopFrame, StartFrame and Repetitions properties.

Anchors Specifies how the control is anchored to its parent. Use this property to ensure that a control maintains its current position relative to an edge of its parent, even if the parent is resized.

BorderWidth Specifies the distance, in pixels, between the outer- and inner bevels. Use BorderWidth to specify how wide the border around an object should be. When the value is 0, no border will appear.

Center Determines whether the frames of the AVI clip are centred in the animation object. CommonAVI Indicates whether the animation object displays one of the common Windows AVI

clips. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum

width and height of an object. When specified, the object cannot be resized to violate those constraints.

FileName Specifies the name of the file that contains the AVI clip displayed by the animation object.

HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword.

78 - 390


Iris Version 3.0

Repetitions Specifies the number of times to repeat the sequence of frames. StartFrame Specifies the first frame displayed when the animation object is activated. StopFrame Specifies the last frame displayed when the animation object is activated. Timers Specifies whether the frames are displayed using a timer.

79 - 390


Iris Version 3.0

9.5 Arrow

The Iris Arrow is an active arrow representing an active or inactive status of an object. This depends on the bit-value of a Tag. The direction as well as the graphical layout can be fully adapted by his properties.


Arrow properties

80 - 390


Iris Version 3.0

Explanation of the Arrow properties: Property Description

Appearance







used. Visible Returns or sets a value that determines wether an object is visible or hidden.

Misc HelpContext Specifies the default help file context ID for an object. Name Returns or sets the name used in code to identify an object. PopupMenu Identifies the pop-up menu associated with the control. Tag Stores any extra data needed for your program.



momentarily on it. Position





Other Active Represents the status of the arrow. False or True means Low or High. ActiveTag Specifies the Tag from which the object gets its actual value from. The tag is

specified using the Tag selector function as described earlier in this chapter. Anchors Specifies how the control is anchored to its parent. Use this property to ensure that a



Direction Indicates the direction of the arrow. Possibilities are Left, Right, Up, and Down.

Examples

DragKind Specifies whether an object is being dragged normally of for docking.

81 - 390


Iris Version 3.0

HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Palette Sets the color of the arrow for status High and Low. TrackMouse When set to true the status of the arrow will be shown High when the mouse pointer

is in the area of the arrow. Version Represents the version of the object. It has no functionality.

82 - 390


Iris Version 3.0

9.6 Bevel

With the bevel object you can make other object look like a 3D-object. Actually the bevel object only consists of a shadow line. Some components have build-in properties to created bevelled borders. A Bevel can show an object raised or lowered.


Bevel properties

83 - 390


Iris Version 3.0

Explanation of the Bevel properties: Property Description

Appearance


Behaviour Visible Returns or sets a value that determines whether an object is visible or hidden.












HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Shape There are two styles available: Lowered and raised.

Style Different shapes can be chosen depending on the object.

84 - 390


Iris Version 3.0

9.7 Bit button

A Bit Button is a button that can have a bitmap image on the face. Commonly buttons have the same functionallity like <Ok>, <Cancel> or <Help>. For those functionallities predefined behaviours are present that can be choosen in the Kind property. When you’re defining your own actions you can choose an action from an Action list or you can write an OnClick event.

Bit button properties

85 - 390


Iris Version 3.0

Explanation of the Bit button properties: Property Description

Appearance

Caption Returns or sets the text displayed in an object’s title bar or below an object’s icon. Cursor Specifies the image used to represent the mouse pointer when it passes into the

region covered by an object. Glyph Specifies the bitmap that appears on the bitmap button.

Behaviour Cancel Indicates whether a command button is the Cancel button on a form. Default Determines which button control is the default command button on a form. DragCursor Indicates the image used to represent the mouse pointer when the control is being


used. Enabled Returns or sets a value that determines whether an object can respond to user-

generated events. TabOrder Indicates the position of the object in its parent’s tab order. Its the order in which the

child windows are visited when the user presses the Tab key. The object that has focus has a TabOrder value of 0. Initially, the tab order is always the order on which the objects were added to a form.

TabStop Returns or sets a value indicating whether a user can use the TAB key to give the focus to an object.

Visible Returns or sets a value that determines whether an object is visible or hidden. Font

Font Returns or sets the font characteristics of the component, including typeface, size, attributes and color.

ParentFont Determines where a control looks for its font information Misc








Other Action Designates the action associated with the object. Actions allow an application to

centralize the response to user commands. For creating actions, see the object Action list.


86 - 390


Iris Version 3.0

BiDiMode Specifies the bi-directional mode for an object. Use BidiMode to enable the object to adjust its appearance and behaviour automatically when the application runs in a locale that reads from right to left instead of left to right.


DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Kind Specifies the kind of the bitmap button. (More information, see later on in this

section). Layout Specifies where the image appears on the bitmap button. Margin Specifies the number of pixels between the edge of the image (specified in the Glyph

property) and the edge of the button. ModalResult Determines whether and how the button closes its (modal) parent form. For example,

if a dialog box has OK and Cancel buttons, their ModalResult properties could be set at design time to mrOk and mrCancel, respectively. At runtime, clicking the OK button then changes the dialog’s ModalResult property to mrOk, and clicking the Cancel button changes the dialog’s ModalResult property to mrCancel. Unless further processing is required, no OnClick event handlers are required for the buttons.

NumGlyphs Indicates the number of images that are in the graphic in the Glyph property for use on the bitmap button

ParentBiDIMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is checked, the object’s BiDiMode property is always equal to that of its parent.

Spacing Determines the number of pixels between the image (specified in the Glyph property) and the text (specified in the Caption property).

Style Defines the style of the bit button.

87 - 390


Iris Version 3.0

The following table shows an overview of possible kinds of buttons that can be chosen in the Kind property. Value Meaning

bkCustom The button uses the Glyph property to determine the image that appears. As with

push buttons, select a ModalResult for the button, or supply the code to respond using an action or an OnClick event.

bkOK The text “OK” appears on the button face. The button becomes the default button (the Default property is automatically set to True). When the user chooses the button, the dialog box closes. The resulting ModalResult value of the bitmap button is mrOk.�

bkCancel The text “Cancel” appears on the button face. The button becomes the Cancel button (the Cancel property is automatically set to True). When the user chooses the button, the dialog box closes. The resulting ModalResult value of the bitmap button is mrCancel.

bkYes The text “Yes” appears on the button face. The button becomes the default button (the Default property is automatically set to True) When the user chooses the button, any changes the user has made in the dialog box are accepted and the dialog box closes. The resulting ModalResult value of the bitmap button is mrYes.

bkNo The “No” appears on the button face. The button becomes the Cancel button (the Cancel property is automatically set to True). When the user chooses the button, any changes the user has made in the dialog box are canceled and the dialog box closes. The resulting ModalResult value of the bitmap button is mrNo.

bkHelp The text “Help” appears on the button face. When the user chooses the button, a Help screen in the application's Help file appears. The Help file that appears is the file specified as the value of the application's HelpFile property. The value of the HelpContext property of the button specifies which Help screen in the Help file appears.

bkClose The text “Close” appears on the button face. When the user chooses the button, the form closes. The Default property of the button is True.

bkAbort The “Abort” appears on the button face. bkRetry The text “Retry” appears on the button face. bkIgnore The text “Ignore” appears on the button face. Use it to allow to continue after an

error has occurred. bkAll The text “Yes to All” appears on the button face.

88 - 390


Iris Version 3.0

9.8 Bit indicator

The Bit Indicator represents the status of one bit by means of the color of the text within the indicator.


Bit indicator properties

89 - 390


Iris Version 3.0

Explanation of the Bit Indicator properties: Property Description

Appearance

Alignment Specifies how text is aligned within an object. Text can be left-justified, right-justified or centred within the object.


region covered by an object. Behaviour


TabOrder Indicates the position of the object in its parent’s tab order. Its the order in which the child windows are visited when the user presses the Tab key. The object that has focus has a TabOrder value of 0. Initially, the tab order is always the order on which the objects were added to a form.


Visible Returns or sets a value that determines whether an object is visible or hidden. Misc



attributes and color. ParentFont Determines where a control looks for its font information




Align Determines how an object aligns within its parent object. Use the align property to align the object on the top, left, bottom or right of a parent (e.g. panel or page) even if the size of that parent changes.

AutoSize Determines whether a control is automatically resized to display its entire contents. Height Returns or sets the height of an object. Left Returns or sets the distance between the internal left edge of an object and the left



Other BackColorFalse Defines the color of the background of the bit indicator when the selected bit is false. BackColorTrue Defines the color of the background of the bit indicator when the selected bit is true. BevelEdges Specifies which edges of an object are bevelled. The BevelInner and BevelOuter

properties determine the appearance of the specified edges. BevelInner Determines the style of the inner bevel of an object. Use BevelInner to provide the

object with a three-dimensional look. BevelKind Specifies the objects bevel style. Use this property to modify the appearance of a

bevel. BevelKind influences how sharp the bevel stands out.

90 - 390


Iris Version 3.0

BevelOuter Determines the style of the outer bevel of an object. Use BevelOuter to provide the object with a three-dimensional look.

BitNumber Indicates the bit which has to be connected to this bit indicator object. This number relates to the Tag that is defined in the ValueTag property. When Bitnumber is set to 1 the MSB form the Tag is selected, when Bitnumber is set to 16 the LSB form the Tag is selected.

BorderStyle Returns or sets the border style for an object. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


ForeColorFalse Specifies the fore color of the indicator when the Bit accociated with the indicator is high.

ForeColorTrue Specifies the fore color of the indicator when the Bit accociated with the indicator is low.

HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. ShowAccelChar If ShowAccelChar is checked, an ampersand in the object’s Caption text appears as

an underline and makes the character after it into an accelerator key. StateValue Specifies the state of the indicator, checked means a high level. StateValueTag Specifies the Tag from which the object gets its actual value from. The tag is

specified using the Tag selector function as described earlier in this chapter. Examples:

False

True

91 - 390


Iris Version 3.0

9.9 Bitmap image

With the Bitmap image it is possible to make a dynamic picture. A list of bitmaps is used and depending on the value of the Tag, where the bitmap image is connected to, a picture will be shown.


Bitmap image properties

92 - 390


Iris Version 3.0

Explanation of the Bitmap image properties: Property Description

Appearance


















BitmapIndex Represents the status of the bitmap image, which bitmap is currently shown in the field. When the BitmapImage is 0, the first picture in the list is shown.

BitmapIndexTag Specifies the Tag from which the object gets its actual value from. The tag is specified using the Tag selector function as described earlier in this chapter.

93 - 390


Iris Version 3.0

Bitmaps When the three dots button in the field are pressed, the following screen will appear.

In the screen a number of bitmaps can be loaded. The bitmap on top of the list will be shown when the value of the Tag is 0. The second will be shown when the value of the Tag is 1. And so on. The position of a bitmap in the list can be changed by using the [Move Up] and [Move Down] buttons.

Center When checked the images will be presented in the center of the reserved area of the bitmap.


DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Stretch When set to true the bitmaps will be stretched to fit the area that is selected for the

Bitmap Image. Version Represents the version of the object. It has no functionality.

94 - 390


Iris Version 3.0

9.10 Blotter

The Blotter is used to blot a color or picture within the frame of the object. The blotter object has no active control of display functionality.


Blotter properties

95 - 390


Iris Version 3.0

Explanation of the Blotter properties: Property Description

Appearance



property. When unchecked the control uses its own Color property. Behaviour

DragCursor Indicates the image used to represent the mouse pointer when the control is being dragged.

DragMode Returns or sets a value that determines whether manual or automatic drag mode is used.


TabOrder Indicates the position of the object in its parent’s tab order. It is the order in which the child windows are visited when the user presses the Tab key. The object that has focus has a TabOrder value of 0. Initially, the tab order is always the order on which the objects were added to a form.



HelpContext Specifies the default help file context ID of an object. Name Returns or sets the name used in code to identify an object. PopupMenu Identifies the pop-up menu associated with the control. Tag Stores any extra data needed for your program.










BackImage Defines the background image of the blotter. The picture will be tiled within the area of the blotter.

Bevel Specifies the bevel appearance on the blotter. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


96 - 390


Iris Version 3.0

DockSite When checked the object can be a target of a drag-and-dock operation. DragKind Specifies whether an object is being dragged normally of for docking. FullRepaint Determines how the object repaints itself when it is updated. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Locked When checked the object is locked. UseDockManager Specifies whether the docking manager is used in drag-and-dock operations. The

Docking manager handles the position of docked objects and any painting of docking zones around those objects.

Version Represents the version of the object. It has no functionality.

97 - 390


Iris Version 3.0

9.11 Button

The Button is used to initiate actions of the user. This version button is not connected to an Iris activity but more to standard dialog actions like “Ok”, “Cancel” and “Retry”. Therefore this button is often used in dialog screens.


Button properties

98 - 390


Iris Version 3.0

Explanation of the Button properties: Property Description

Appearance



Cancel Indicates whether a command button is the Cancel button on a form. Default Determines which button control is the default command button on a form. DragCursor Indicates the image used to represent the mouse pointer when the control is being



generated events. TabOrder Indicates the position of the object in its parent’s tab order. It is the order in which

the child windows are visited when the user presses the Tab key. The object that has focus has a TabOrder value of 0. Initially, the tab order is always the order on which the objects were added to a form.
















99 - 390


Iris Version 3.0


DragKind Specifies whether an object is being dragged normally of for docking. FullRepaint Determines how the object repaints itself when it is updated. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. ModalResult Determines whether and how the button closes its (modal) parent form. For example,

if a dialog box has OK and Cancel buttons, their ModalResult properties could be set at design time to mrOk and mrCancel, respectively. At runtime, clicking the OK button then changes the dialog’s ModalResult property to mrOk, and clicking the Cancel button changes the dialog’s ModalResult property to mrCancel. Unless further processing is required, no OnClick event handlers are required for the buttons.

ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is checked, the object’s BiDiMode property is always equal to that of its parent.

100 - 390


Iris Version 3.0

9.12 Iris Chart

The Iris Chart represents the value of a point in graphic format showing the pattern of the value of the point over time.


101 - 390


Iris Version 3.0

102 - 390


Iris Version 3.0

Iris Chart properties

103 - 390


Iris Version 3.0

Explanation of the Iris Chart properties: Property Description

Appearance









Visible Returns or sets a value that determines wether an object is visible or hidden. Misc









Other AllowPanning Defines whether it is allowed to scroll the chart at runtime. Possibilities are None,

Horizontal, Vertical and Both. Anchors Specifies how the control is anchored to its parent. Use this property to ensure that a


AxisBehind When set to True and the 3D view is set to True the chart will use the back of the 3D Axis for his axis. When 3D view is set to False this property has no function.

AxisVisible Defines whether the Axis of the chart will be visible or not. The four axes will be drawn separately. The visibility of each axis depends on there own visible property.

104 - 390


Iris Version 3.0

BackImage Defines the image to be used for the background of the chart. BackImageInside When set to True the image selected by the BackImage property will be shown

within the borders of the chart-frame. BackImageMode Defines if the background image will be Stretched, Normal or Tiled. BackImageTransp When set to True the background color of the BackImage will become transparent. BackWall Defines the pen and brush used to fill the Back chart side. To use this property the

View3D and View3DWalls properties should be True. BevelInner Determines the style of the inner bevel of an object. Use BevelInner to provide the

object with a three-dimensional look. BevelOuter Determines the style of the outer bevel of an object. Use BevelOuter to provide the

object with a three-dimensional look. BevelWidth Determines the width, in pixels, of both the inner- and outer bevel of an object. Border Specifies the border around the Chart. BorderRound Defines the amount in pixels to draw a border around chart boundaries with rounded

corners. BorderWidth Specifies the distance, in pixels, between the outer- and inner bevels. Use

BorderWidth to specify how wide the border around an object should be. When the value is 0, no border will appear.

BottomAxis Defines the Bottom axis of the chart. See ChartAxis table for details. BottomWall Defines the pen and brush used to fill the bottom chart side. To use this property the

View3D and View3DWalls properties should be True. Chart3DPercent Specifies the size ratio between Chart dimensions and Chart depth. This property has

no effect when the View3D property is set to False. ClipPoints When set to True the series points will be drawn on the chart. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


CustomAxis Defines a custom axis e.g. with two or more series are displayed in one chart with different scales.

DepthAxis Defines the Depth (Z) axis of the chart. See ChartAxis table for details. DepthTopAxis Defines the Depth (Z) of the top axis of the chart DockSite When checked the object can be a target of a drag-and-dock operation. DragKind Specifies whether an object is being dragged normally of for docking. Foot Defines the text to be drawn at the bottom of the chart. Frame Indicates the Pen used to draw a frame around the Chart axis. Gradient Specifies the colors used for filling the background of the chart panel. When a

background image is used the gradient will only be seen outside the chart itself. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. LeftAxis Defines the Left axis of the chart. See ChartAxis table for details. LeftWall Defines the pen and brush used to fill the Left chart side. To use this property the

View3D and View3DWalls properties should be True. Legend Specifies the Legend of the chart. Locked When checked the object is locked. MarginBottom Specifies the margin between the bottom of the chart and the bottom of the panel. MarginLeft Specifies the margin between the Left of the chart and the Left of the panel. MarginRight Specifies the margin in pixels, between the Right of the chart and the Rigth of the

panel. MarginTop Specifies the margin between the Top of the chart and the Top of the panel. MarginUnits Determines the units of the four margin properties. MaxPointPerPage Defines the Minimum number of points to be used on one page. Monochrome Defines whether the chart will be drawn monochrome (black and white) or in color. Orientation Specifies the preview panel orientation of the chart. Page Determines the current visible point of series in a chart. PrintProportional When set to True the Chart will be printed on proportional size.

105 - 390


Iris Version 3.0

RealTime When set to True the chart will be displayed real-time, that means if a series is on the end of the chart the series will be shift to the next value and the first value will fall of the chart.

RightAxis Defines the Right axis of the chart. See ChartAxis table for details. RightWall Defines the pen and brush used to fill the right chart side. To use this property the

View3D and View3DWalls properties should be True. ScaleLastPage Defines how the last page will be displayed. When set to True the last page will have

the same horizontal scaling as the other pages. ScrollMouseButton Defines the button of the mouse which the user can use to scroll the chart. SeriesList The list of the series which will be displayed in the chart, the series can only be

defined through the Chart Editor (see later on in this section). Shadow Defines whether the chart should have a shadow effect. SpanDays Defines the number of days on an axis. The total time on an axis is total of

SpanDays, SpanHours and SpanMinutes. SpanHours Defines the number of hours on an axis. The total time on an axis is total of

SpanDays, SpanHours and SpanMinutes. SpanMinutes Defines the number of minutes on an axis. The total time on an axis is total of

SpanDays, SpanHours and SpanMinutes. SpanPeriod Represents the total span period of the chart. This is a addition of SpanDays,

SpanHours and SpanMinutes properties. SubFoot Defines a sub footer of a chart. SubTitle Defines the subtitle of the chart. TimeEnd Defines the end-time of the chart. TimeStart Defines the Start time of the chart. Title Defines the text to be drawn at the bottom of the chart. TobAxis Defines the Top axis of the chart. See ChartAxis table for details. UseDockManager Specifies whether the docking manager is used in drag-and-dock operations. The


View3D When set to true the chart will be drawn in 3D effect. The effect depends on the View3DWalls and Chart3DPercent properties.

View3DOptions Indicates the control of the Rotation, Scrolling and Zoom function for the chart. View3DWalls When set to True the Left and Bottom walls of the chart will be drawn in 3D. This

property has no effect when the View3D property is set to False. Zoom Specifies the zoom function.

106 - 390


Iris Version 3.0

ChartAxis table: A chart has 5 axes, LeftAxis, RightAxis, TopAxis, BottomAxis and DepthAxis. Each of those axes can be defined separately. The axes have the following properties. Property Description

Automatic

When set to True the Maximum and minimum values for the axis will be calculated with all axes depended series.

AutomaticMaximum

When set to True the Maximum value will be automatically adjusted based on the series.

AutomaticMinimum

When set to True the minimum value will be automatically adjusted based on the series.

Axis Defines the Pen used to draw the Major lines for the Axis. AxisValuesFormat Specifies the formatting string to be applied to Axis labels. DateTimeFormat Specifies the format for the date and time to be used on the axis. EndPosition

Defines the position, as a percentage of Chart width or height (depending on whether it is applied to a Horizontal Axis or a Vertical Axis) of the End position of the Axis to which it is applied. Left and Top are 0,0 positions.

ExactDateTime When set to true the labels of the axis will be calculated in exact date time steps. Grid Defines the kind of pen used to draw the Axis lines at every Axis label position. GridCentred When set to True the grid will be centred between two ticks. Horizontal

Represents the status of the axis. When this property is True the axis is horizontal.

Increment Defines the minimum step between axis labels. Inverted

When set to True the maximum and minimum scales will be swapped. The labels and series points will be unchanged.

Labels When set to True labels will be shown on the axis. LabelsAlign Defines the alignment of the labels. LabelsAlternate LabelsAngle

Defines the angle (rotation) of the labels on the axis. Possible values are 0, 90, 180, 270 and 360.

LabelsExponent When set to True the labels will be presented exponential on the axis. LabelsFont Defines the Font used to draw Axis labels. LabelsMultiLine

When set to true the labels on an Axis can be split in two or more lines. The label will be split where a space is found in the label.

LabelsOnAxis

Specifies if Labels at axis maximum and minimum positions will be shown or not.

LabelsSeparation

Defines the minimum distance between axis labels. The amount is specified in percentage.

LabelsSize

Defines the space between the axis and the chart. When set to 0 the space will be calculated based on the axis labels Width and Height.

LabelStyle

Defines the style of the labels to be drawn on the axis. Possibilities are Auto, Text, Value, None and Mark.

Logarithmic

When set to True the axis will be scaled logarithmically. The maximum and minimum values of the axis must be greater than 0 and must not be of the type Date Time.

LogarithmicBase

The number that is used for the logarithmical base. Only useful when the property Logarithmic is set to True.

Maximum

Defines the maximum value an Axis will use to scale their dependent Series point values. This value must be higher than the minimum property.

MaximumOffset The amount of pixels that will be left as a margin at axis maximum position. Minimum

Defines the minimum value an Axis will use to scale their dependent Series point values. This value must be lower than the maximum property.

MinumumOffset The amount of pixels that will be left as a margin at axis minimum position.

107 - 390


Iris Version 3.0

MinorGrid Defines the Pen used to draw the Minor grid. MinorTickCount

Defines the minor ticks on an axis. Minor ticks are sub-ticks between the major ticks.

MinorTickLength Defines the length, in pixels, of the minor ticks. MinorTicks Defines the Pen used to draw the Axis Minor ticks. OtherSide

Represents the status of the axis. When this property is True the axis is either the TopAxis or RigthAxis.

PositionPercent

Defines the position, as a percentage of Chart width or height (depending on whether it is applied to a Horizontal Axis or a Vertical Axis) of the Position of the Axis to which it is applied. Left and Top are 0,0 positions.

PositionUnits Defines how to use the axis PositionPercent property. RoundFirstLabel Specifies if axis labels will be rounded automatically. TickOnLabelsOnly When set to True there will be only ticks shown on the labels StartPosition

Defines the position, as a percentage of Chart width or height (depending on whether it is applied to a Horizontal Axis or a Vertical Axis) of the Start position of the Axis to which it is applied. Left and Top are 0,0 positions.

TickInnerLength Defines the length, in pixels, of axis ticks drawn inside the chart boundaries. TickLength Defines the length, in pixels, of the major ticks. TickOnLabelsOnly Defines whether to used tick on labels only. Ticks Defines the Pen used to draw the Axis Major ticks. TickInner Defines the Pen used to draw the Inner ticks. TimeBase Specifies is the axis is time based. Title Defines the Title used for the Axis. Caption contains the text displayed near the

axis. The font of the label can be defined. TitleSize Defines the space between the title of the axis and the chart. Visible When set to True the axis and all its components (labels, grid, axis lines, ticks and

title) will be visible.

108 - 390


Iris Version 3.0

The Trend Designer: By clicking on the chart with the right button of the mouse or double clicking on the chart you can open the Trend Designer of iris. With this designer you can configure very quickly trends and connect them to the corresponding points.

Clicking on the [Extended] button will open the Chart Editor for detailed configuration of the trends. The Trend Designer and the Chart editor are discussed in detail in chapter 12 Trending.

109 - 390


Iris Version 3.0

9.13 Checkbox

With the checkbox the user can select an option when checked or deselect an option by uncheck it.


Check box properties

110 - 390


Iris Version 3.0

Explanation of the Check box properties: Property Description

Appearance


Caption Returns or sets the text displayed in an object’s title bar or below an object’s icon. Color Returns or sets the background color of the component Ctl3D Returns or sets whether an object is painted or not at runtime with 3-D effects. Cursor Specifies the image used to represent the mouse pointer when it passes into the











HelpContext Specifies the default help file context ID of an object. Name Returns or sets the name used in code to identify an object. PopupMenu Identifies the pop-up menu associated with the control. Tag Stores any extra data needed for your program.









AllowGrayed When set to true the check box has three possibilities: Checked, unchecked and greyed.

111 - 390


Iris Version 3.0


BiDiMode Specifies the bi-directional mode of an object. Use BidiMode to enable the object to adjust its appearance and behaviour automatically when the application runs in a locale that reads from right to left instead of left to right.

Checked When set to true the default of the check box is checked. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is

checked, the object’s BiDiMode property is always equal to that of its parent. ParentCtl3D Determines where an object looks to determine if it should appear three-dimensional.

This property determines whether the object uses its parent Ctl3D property. State Indicates the state of the check box, checked, unchecked or greyed.

112 - 390


Iris Version 3.0

9.14 Check led

The functionality of the Check led is the same as the Checkbox. The box is replaced by a led that can be customized to the users needs like position, shape and color.


Check led properties

113 - 390


Iris Version 3.0

Explanation of the Check Led specific properties: Property Description

Appearance

Caption Returns or sets the text displayed in an object’s title bar or below an object’s icon. Color Returns or sets the background color of the component Cursor Specifies the image used to represent the mouse pointer when it passes into the





















CheckHeigth Defines the height of the led.

114 - 390


Iris Version 3.0

CheckStyle Defines the functionality of the CheckLed. RadioButton; When more than one CheckLed placed in for example a panel the CheckLeds work like a RadioButton. CheckBox: The CheckLed has the same functionality as a CheckBox.

CheckWidth Defines the width of the led. Checked When set to true the default of the check led is checked. CheckedTag Specifies the Tag from which the object gets its actual value from. The tag is

specified using the Tag selector function as described earlier in this chapter. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Layout Specifies the layout of the check led:

ImageBottom: The led is placed under the Caption. ImageLeft: The led is placed on the left of the Caption. (Default) ImageTop: The led is placed on top of the Caption. ImageRight: The led is placed on the right of the Caption.

Margin Defines the margin in pixels between the Led and the border of panel depending on the layout choosen. E.g. when Layout is ImageLeft the margin defines the distance between the led and the left border of the panel.

Palette Defines the color of the led for both the Low status as the High status. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is

checked, the object’s BiDiMode property is always equal to that of its parent. Spacing Defines the space between the led and the label. Version Represents the version of the object. It has no functionality.

115 - 390


Iris Version 3.0

9.15 Check list box

The Check list box displays a scrollable list with check boxes next to each item. It is the same as the List box object except that the items have check boxes.


Check list box properties

116 - 390


Iris Version 3.0

Explanation of the Check list box properties: Property Description

Appearance

Color Returns or sets the background color of the component Ctl3D Returns or sets whether or not an object is painted at runtime with 3-D effects. Cursor Specifies the image used to represent the mouse pointer when it passes into the

region covered by an object. Flat Determines whether the borders of an object appear three-dimensional. ParentColor To have a control use the same color as its parent control, check the ParentColor





ImeMode Determines the behaviour of the input method editor (IME). An IME is a front-end input processor for Asian language characters. The IME converts all keyboard input to Asian characters and send them to the application.

ImeName Specifies the input method editor (IME). It specifies one of the IME’s installed through the windows panel.



Visible Returns or sets a value that determines whether an object is visible or hidden. List

IntegralHeigth Determines whether the list box displays partial items. The checked and the Style property is set to OwnerDrawFixed, the listbox height will always be a multiple of the ItemHeigth property. In this case items will never be partially displayed.

ItemHeigth Specifies the height in pixels of an item in the list box. When the Style property is set to Standard or OwnerDrawVariable, the value is ignored.

Items Specifies the items of the listbox. Clicking on the three dot button in this field will make the following screen appear.

Within this screen the strings (items) can be type to display in the list box.

117 - 390


Iris Version 3.0

Example




Hint Hint Returns or sets the text displayed when the mouse is paused over the control. ParentShowHint When ParentShowHint is checked, the control uses the showHint property value

of its parent. If not, the control uses its own ShowHint property. ShowHint Determines if the control should display a hint when the mouse pointer rests






Other AllowGrayed When set to true the check box has three possibilities: Checked, unchecked and

greyed. Anchors Specifies how the control is anchored to its parent. Use this property to ensure that

a control maintains its current position relative to an edge of its parent, even if the parent is resized.

AutoComplete Determines whether the user can give focus to items by typing in the list. BevelEdges Specifies which edges of an object are bevelled. The BevelInner and BevelOuter



bevel. BevelKind influences how sharply the bevel stands out. BevelOuter Determines the style of the outer bevel of an object. Use BevelOuter to provide

the object with a three-dimensional look. BevelWidth Determines the width, in pixels, of both the inner- and outer bevel of an object. BiDiMode Specifies the bi-directional mode for an object. Use BidiMode to enable the object

to adjust its appearance and behaviour automatically when the application runs in a locale that reads from right to left instead of left to right.

BorderStyle Returns or sets the border style for an object. Columns Specifies the number of columns, in a multi-column list box, that are visible

without having to scroll.

118 - 390


Iris Version 3.0


DragKind Specifies whether an object is being dragged normally of for docking. HeaderBackgroundColor Specifies the background color for a header item in the listbox. HeaderColor Specifies the font color for a header item in the listbox. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode

is checked, the object’s BiDiMode property is always equal to that of its parent. ParentCtl3D Determines where an object looks to determine if it should appear three-

dimensional. This property determines whether the object uses its parent Ctl3D property.

Sorted When checked the items in the list box will be arranged alphabetically. Style Specifies the style of the list box:

lbStandard: All items are strings, with each item the same height. lbOwnerDrawFixed: The list box is owner-draw and each item in the list box is the height specified by the ItemHeigth property. lbOwnerDrawVariable: The list box is owner-draw and the items in the list box can be of varying heights. lbVirtual: The list box is virtual and all items are strings with the same height. lbVirtualOwnerDraw: The list box is virtual and owner-draw and all items are the same height. When the list box style is virtual the items are supplied dynamically using event handlers.

TabWidth Specifies the size of the tabs in the list box.

119 - 390


Iris Version 3.0

9.16 Color Dialog

The Color Dialog object displays a Windows dialog box for selecting colors. The dialog does not appear at runtime until it is activated by a call to the Execute method. When the user selects a color and clicks OK, the dialog closes and the selected color is stored in the Color property.


Color Dialog properties

Explanation of the Color Dialog properties: Property Description

Appearance

Color Returns the selected color. Ctl3D Returns or sets whether an object is painted or not at runtime with 3-D effects.


Other CustomColors Determines which custom colors are available in the dialog box. Options Specifies options and default appearance for the dialog.

cdFullOpen: Displays the custom color options when the dialog opens. cdPreventFullOpen: Disables the Define Custom Colors button in the dialog, so that the user cannot define new colors. cdShowHelp: Adds a Help button to the dialog. cdSolidColor: Directs Windows to use the nearest solid color to the color chosen. cdAnyColor: Allows the user to select non-solid colors (which may have to be approximated by dithering).

120 - 390


Iris Version 3.0

The Color Dialog:

121 - 390


Iris Version 3.0

9.17 Combo box

The Combo box combines the edit box and the list box. It is an Edit box with a scrollable drop-down list attached to it. A user can select an item from the drop-down list or can directly enter text into the edit box.


Combo box properties

122 - 390


Iris Version 3.0

Explanation of the Combo box properties: Property Description

Appearance

Color Returns or sets the background color of the component Ctl3D Returns or sets whether an object is painted or not at runtime with 3-D effects. Cursor Specifies the image used to represent the mouse pointer when it passes into the region

covered by an object. ParentColor To have a control use the same color as its parent control, check the ParentColor





ImeMode Determines the behaviour of the input method editor (IME). An IME is a front-end input processor for Asian language characters. The IME converts all keyboard input to Asian characters and send them to the application.





ItemHeigth Specifies the height in pixels of an item in the combo box. When the Style property is set to Standard or OwnerDrawVariable, the value is ignored.

Items Specifies the items of the combo box. Clicking on the three dot button in this field will make the following screen appear.

Within this screen the strings (items) can be type to display in the combo box.


attributes and color. ParentFont Determines where a control looks for its font information.

123 - 390


Iris Version 3.0


Hint Hint Returns or sets the text displayed when the mouse is paused over the control. ParentShowHint When ParentShowHint is checked, the control uses the showHint property value of its

parent. If not, the control uses its own ShowHint property. ShowHint Determines if the control should display a hint when the mouse pointer rests







AutoComplete Determines whether the user can give focus to items by typing in the combo box. AutoDropDown When AutoDropDown is true, the combo box automatically drops down its list when

the user starts typing his data. BevelEdges Specifies which edges of an object are bevelled. The BevelInner and BevelOuter



bevel. BevelKind influences how sharply the bevel stands out. BevelOuter Determines the style of the outer bevel of an object. Use BevelOuter to provide the

object with a three-dimensional look. BevelWidth Determines the width, in pixels, of both the inner- and outer bevel of an object. BiDiMode Specifies the bi-directional mode for an object. Use BidiMode to enable the object to

adjust its appearance and behaviour automatically when the application runs in a locale that reads from right to left instead of left to right.

CharCase Defines the case of the text in the combo box. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DragKind Specifies whether an object is being dragged normally of for docking. DropDownCount The number of list items that will be shown when the drop-down list is active. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. ItemIndex Indicates which item in the drop-down list is selected. The first item is the list has

value 0, the second item has value 1, and so on. If no item is selected the value of ItemIndex is -1.

MaxLength Specifies the maximum number of characters the user can type into the edit portion of the combo box.


ParentCtl3D Determines where an object looks to determine if it should appear three-dimensional. This property determines whether the object uses its parent Ctl3D property.

Sorted Determines whether the list portion of the combo box will be shown in alphabetic order.

124 - 390


Iris Version 3.0

Style Select the style of the Combobox: DropDown: a Combobox with a drop-down list DropDownList: a Combobox that is read-only, the user can only select from the drop-down list. Simple: a Combobox without a drop-down list OwnerDrawFixed: a Combobox that displays graphical items OwnerDrawVariable: a Combobox that displays items with heights

Text Contains a taxt string which is associated with the combo box.

125 - 390


Iris Version 3.0

9.18 Compass

The Iris Compass shows graphically a direction of an object. The presentation of the direction depends on a value of a Tag. The graphical layout of the compass can be fully adapted by adapting his properties.


Compass properties

126 - 390


Iris Version 3.0

Explanation of the Compass properties: Property Description

Appearance

Color Returns or sets the background color of the component Cursor Specifies the image used to represent the mouse pointer when it passes into the region

















127 - 390


Iris Version 3.0

BackImage An Image can be loaded as background of the compass. Pressing on the three-dot

button within the field will make the following screen appear.

The required picture can be selected from any location by using the button.

CircleColor Indicates the fill color of the center circle within the compass. CircleOutlineColor Indicates the line color of the center circle within the compass. CircleOutlineWidth Indicates the line width of the center circle within the compass. CircleWidth Indicates the diameter of the center circle within the compass. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DragKind Specifies whether an object is being dragged normally of for docking. Heading Represents the actual direction of the compass. Lies between 0 an 360 HeadingTag Specifies the Tag from which the object gets its actual value from. The tag is specified

using the Tag selector function as described earlier in this chapter. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. NeedleColor Indicates the color of the needle of the compass. NeedleLength Indicates the length of the needle of the compass in pixels. When the length of the

needle crosses the area of the compass the needle will have the maximum length within that area.

NeedleTransparent Indicates the transparency of the needle. NeedleWidth Indicates the width of the needle. Version Represents the version of the object. It has no functionality.

Examples

128 - 390


Iris Version 3.0

9.19 Control bar

The Control bar object manages the layout of toolbar components. You can use the Control bar object as a container for toolbar components. Control bars contain child controls (usually Tool bar objects) that can be moved and resized independently. Each child control resides on its own individual band that the user positions by dragging its sizing grip.


Control bar properties

129 - 390


Iris Version 3.0

Explanation of the Control bar properties: Property Description

Appearance





















130 - 390


Iris Version 3.0

AutoDock If AutoDock is True (the default), when a dockable object is dragged over the control

bar, the control bar temporarily docks the object so that the user can see the impact of the drag operation. That is, the user can see the dock position and how other docked controls will be repositioned to make room. When the user releases the mouse, the dragged object is docked at the current spot, and any temporary dockings are cancelled. However, if the user cancels the drag-and-dock operation, the dragged object revert to its last temporary dock site rather than to its location at the start of the drag operation.

AutoDrag Specifies whether control bands are automatically undocked when the user drags them.

BevelEdges Specifies which edges of an object are bevelled. The BevelInner and BevelOuter properties determine the appearance of the specified edges.

BevelInner Determines the style of the inner bevel of an object. Use BevelInner to provide the object with a three-dimensional look.

BevelKind Specifies the objects bevel style. Use this property to modify the appearance of a bevel. BevelKind influences how sharply the bevel stands out.


BevelWidth Determines the width, in pixels, of both the inner- and outer bevel of an object. BorderWidth Specifies the distance, in pixels, between the outer- and inner bevels. Use



DockSite When checked the object can be a target of a drag-and-dock operation. DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. ParentCtl3D Determines where an object looks to determine if it should appear three-dimensional.

This property determines whether the object uses its parent Ctl3D property. Picture The picture property specifies the control bar’s picture. The picture is tiled across the

control bar. RowSize Specifies the height of the control bar’s rows. RowSnap Specifies whether controls are snapped to the control bar’s rows.

131 - 390


Iris Version 3.0

9.20 Cool bar

The Cool bar contains child objects that can be moved and resized independently. Each object resides on an individual band, represented by a CoolBand object listed in the Bands property. The user positions the object by dragging the sizing grip to the left of each band.

Basic layout when first placed on the screen. (On top of the screen covering the whole width)

Cool bar properties

132 - 390


Iris Version 3.0

Explanation of the Cool bar properties: Property Description

Appearance

Color Returns or sets the background color of the component Ctl3D Returns or sets whether or not an object is painted at runtime with 3-D effects. Cursor Specifies the image used to represent the mouse pointer when it passes into the region



















BandBorderStyle Determines the border style of the bands in the Cool bar. BandMaximize Specifies the conditions under which a CoolBand is maximized. Bands Lists the bands (TCoolBands) of the coolbar. The CoolBands will be discussed later

on in this section. Pressing on the three dot button at the and of the field will make the Bands Editor appear.

Bitmap Specifies the image that appears behind the bands in the Cool bar.

133 - 390


Iris Version 3.0



DockSite When checked the object can be a target of a drag-and-dock operation. DragKind Specifies whether an object is being dragged normally of for docking. EdgeBorder Determines which sides of the control have visible borders. EdgeInner Determines the border style for the Cool bar inner edge. EdgeOuter Determines the border style for the Cool bar outer edge. FixedOrder Determines whether the user can reorder the bands in the Cool bar. FixedSize Determines whether the bands automatically maintain a uniform height or width. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Images Lists images available for bands in the Cool bar. ShowText If ShowText is checked, the Text string of each CoolBand is displayed on the band at

runtime. Vertical Determines whether the bands are arranged vertically or horizontally.

CoolBands: The following picture shows the Band’s Editor. With the buttons on top of the screen you can add and remove bands in the list.

CoolBand properties

134 - 390


Iris Version 3.0

Explanation of the CoolBand properties: Property Description

Appearance

Color Returns or sets the background color of the component ParentColor To have a control use the same color as its parent control, check the ParentColor


Visible Returns or sets a value that determines whether an object is visible or hidden. Position

Width Returns or sets the width of an object. Other

Bitmap Specifies the background image displayed on the band. BorderStyle Specifies the border style for the band.

If BorderStyle is set to the default bsSingle, the band has a single-line border. If BorderStyle is set to bsNone, no border appears around the band.

Break Causes the band to start on a new line. Control Specifies the control that appears on the band. FixedBackground Determines whether the background is realigned within the band. FixedSize Determines whether the band can be resized at runtime. HorizontalOnly Determines whether the band is displayed when the Cool bar is arranged vertically. ImageIndex Determines the image (from the Images list that is specified at the Cool bar) that

appears on the band. MinHeigth Determines the minimum height for the band. MinWidth Determines the minimum width for the band. ParentBitmap Determines whether the band uses the Bitmap image of the Cool bar that owns it. Text Specifies the text string that appears on the band and identifies it in the Bands editor.

135 - 390


Iris Version 3.0

9.21 Date Time picker

The Date Time Picker is a visual object especially for entering dates and times. The base is a combo box or list box whereby the drop-down list is replaced with a calendar illustration. Users can select from the calendar the date or by using the up and down arrow or simply typing the date in the edit box.


Date Time Picker properties

136 - 390


Iris Version 3.0

Explanation of the Date Time Picker box properties: Property Description

Appearance

Color Returns or sets the background color of the component Cursor Specifies the image used to represent the mouse pointer when it passes into the

region covered by an object. Flat Determines whether the borders of an object appear three-dimensional.




generated events. ImeMode Determines the behaviour of the input method editor (IME). An IME is a front-

end input processor for Asian language characters. The IME coverts all keyboard input to Asian characters and send them to the application.














Other Anchors Specifies how the control is anchored to its parent. Use this property to ensure that



137 - 390


Iris Version 3.0




BevelWidth Determines the width, in pixels, of both the inner- and outer bevel of an object. BiDiMode Specifies the bi-directional mode for an object. Use BidiMode to enable the object


CalAlignment Determines the alignment of the drop-dwon calendar. CalColors Defines the color for eacht part of the calendar. Checked Indicates whether the check box next to the date or time is selected. Constraints Specifies the constraints of an object. Use it to specify the minimum and

maximum width and height of an object. When specified, the object cannot be resized to violate those constraints.

Date Returns or sets the date that is marked on the calendar. The value of Date must lie between the MaxDate and MinDate properties.

DateFormat Specifies the format in which the date is presented. dfShort: the date is formatted using the short format. E.g. 8/23/04. dfLong: the date is formatted using the long format. E.g. Monday, August 23, 2004.

DateMode Determines the method of date selection used by the object. dmCombobox: the object has a drop-down calendar illustration from which the user can select a date. dmUpDown: the object has Up/Down arrows with which the user can adjust the date.

DragKind Specifies whether an object is being dragged normally of for docking. Format Specific format for the date-time string. See later on in this section. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Kind Determines whether the object is a date selector or a time selector. MaxDate Indicates the maximum date to which the user can scroll the calendar. MinDate Indicates the minimum date the user can select. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode

is checked, the object’s BiDiMode property is always equal to that of its parent. ParseInput When checked the OnUserInput event will occur when the user types into the edit

box. ShowCheckbox When checked a check box is displayed next to the date or time. Time Represents the time entered by the user.

138 - 390


Iris Version 3.0

The following table shows the elements that can be used to build up a format. Element

Description

d The one- or two-digit day. dd The two-digit day. Single-digit day values are preceded by a zero. ddd The three-character weekday abbreviation. dddd The full weekday name. h The one- or two-digit hour in 12-hour format. hh The two-digit hour in 12-hour format. Single-digit values are preceded by a zero. H The one- or two-digit hour in 24-hour format. HH The two-digit hour in 24-hour format. Single-digit values are preceded by a zero. m The one- or two-digit minute. mm The two-digit minute. Single-digit values are preceded by a zero. M The one- or two-digit month number. MM The two-digit month number. Single-digit values are preceded by a zero. MMM The three-character month abbreviation. MMMM The full month name. t The one-letter AM/PM abbreviation (that is, AM is displayed as "A"). tt The two-letter AM/PM abbreviation (that is, AM is displayed as "AM"). yy The last two digits of the year (that is, 2001 would be displayed as "01"). yyyy The full year (that is, 2001 would be displayed as "2001"). The following picture shows an example of the Date Time picker.

139 - 390


Iris Version 3.0

9.22 DBasegrid

You can use a DBgrid object on a form to display and edit the records from a database table or query. Applications can use the data grid to insert, delete, or edit data in the database, or simply to display it.


DBgrid properties

140 - 390


Iris Version 3.0

Explanation of the DBase grid properties: Property Description

Appearance







ImeMode Determines the behaviour of the input method editor (IME). An IME is a front-end input processor for Asian language characters. The IME coverts all keyboard input to Asian characters and send them to the application.














Data DataSource Sets a value specifies the data control through which the current control is bound to a

database.

141 - 390


Iris Version 3.0

Other



BorderStyle Returns or sets the border style for an object. Columns Returns or sets the number of columns displayed by the DBgrid Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DefaultDrawing Indicates whether the cells in the DBgrid are drawn automatically. DragKind Specifies whether an object is being dragged normally of for docking. FixedColor Specifies the background color of the fixed rows and columns in the grid. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Options Specifies various display and behavioural properties of the data-aware grid.

dgEditing: The user can edit data using the grid. dgEditing is ignored if Options includes dgRowSelect. dgAlwaysShowEditor: The grid is always in edit mode. That means, the user does not have to press Enter or F2 before editing the contents of a cell. dgAlwaysShowEditor does nothing unless dgEditing is also included in Options. dgAlwaysShowEditor is ignored if Options includes dgRowSelect. dgTitles: Titles appear at the top of the columns in the grid. dgIndicator: A small pointer appears in the first column to indicate which row is current. dgColumnResize: Columns that are bound to fields can be resized or moved. dgColLines: Lines appear between columns in the grid. dgRowLines: Lines appear between the rows of the grid. dgTabs: The user can navigate through the grid using the Tab and Shift+Tab keys. dgRowSelect: The user can select an entire row, as well as selecting individual cells. If Options includes dgRowSelect, dgEditing and dgAlwaysShowEditor are ignored. dgAlwaysShowSelection: The selected cell displays the focus rectangle even when the grid does not have focus. dgConfirmDelete: A message box appears, asking for confirmation, when the user types Ctrl+Delete to delete a row in the grid. dgCancelOnExit: When the user exits the grid from an inserted record to which the user made no modifications, the inserted record is not posted to the dataset. This prevents the inadvertent posting of empty records. dgMultiSelect: More than one row in the grid can be selected at a time.



ReadOnly Indicates whether the grid is used for display only, or whether the user can edit data using the grid.

TitleFont Describes the font used to draw the column titles in the grid.

142 - 390


Iris Version 3.0

9.23 Digit group

The Digit group shows a group of digits (7-segment). The digit group can directly be connected to a Tag using the MainTag property.


Digit group properties

143 - 390


Iris Version 3.0

Explanation of the Digit group properties: Property Description

Appearance
















Other ActiveOnly When set to true only the active segments will be shown. Anchors Specifies how the control is anchored to its parent. Use this property to ensure that a



Decimals The number of decimals that the group will have. The number of decimals may not exceed the number of digits.

Digits The number of digits the group consists of. DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. LeadingZero When set to true the leading zeros will be shown. OutlineColor Specifies the border color of the segments.

144 - 390


Iris Version 3.0

Palette Representation of the colors when the segments are High and Low. Value The actual value of the digit group. ValueTag Specifies the Tag from which the object gets its actual value from. The tag is specified

using the Tag selector function as described earlier in this chapter. Version Represents the version of the object. It has no functionality.

145 - 390


Iris Version 3.0

9.24 Directory list box

The Directory List Box represents a list box object that is aware of the directory structure of the current drive.


Directory List box properties

146 - 390


Iris Version 3.0

Explanation of the File List box properties: Property Description

Appearance












IntegralHeigth When set to true the height of the File list box depends on the list items. This means that the items will be displayed in the box completely. Of course the list can be longer.

ItemHeigth Specifies the height in pixels of an item in an owner-draw list box. Font









edge of its container.

147 - 390


Iris Version 3.0

Top Returns or sets the distance between the internal top edge of an object and the top edge of its container.



AutoComplete When set to true the application will search for the closest match as the user types his data.






DirLabel Provides a simple way to display the current directory as the caption of a label control.FileList Provides a simple way to connect a directory list box with a file list box. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. ParentCtl3D Determines where an object looks to determine if it should appear three-dimensional.

This property determines whether the object uses its parent Ctl3D property.

148 - 390


Iris Version 3.0

9.25 Draw grid

The DrawGrid object represents a grid control that displays information in column and row format.


Draw grid properties

149 - 390


Iris Version 3.0

Explanation of the Draw grid properties: Property Description

Appearance






















150 - 390


Iris Version 3.0

BiDiMode Specifies the bi-directional mode for an object. Use BidiMode to enable the object to


BorderStyle Returns or sets the border style of an object. ColCount Specifies the number of columns in the grid. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DefaultColWidth Determines the width (in pixels) of all columns that have not been explicitly resized. DefaultDrawing Determines whether the Cells are painted when the grid is drawn. DefaultRowHeight Specifies the height (in pixels) of all rows that have not been explicitly resized. DragKind Specifies whether an object is being dragged normally of for docking. FixedColor Specifies the background color of the fixed rows and columns in the grid. FixedCols Specifies the number of columns on the left of the grid that cannot be scrolled. FixedRows Specifies the number of rows on the top of the grid that cannot be scrolled. GridLineWidth Specifies the width (in pixels) of the lines that separate the cells of the grid. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Options Specifies various display and behavioural properties of the grid.

goFixedVertLine: Vertical lines are drawn to separate the fixed (nonscrolling) columns in the grid. goFixedHorzLine: Horizontal lines are drawn to separate the fixed (nonscrolling) rows in the grid. goVertLine: Vertical lines are drawn to separate the scrollable columns in the grid. goHorzLine: Horizontal lines are drawn to separate the scrollable rows in the grid. goRangeSelect: Users can select ranges of cells at one time. goRangeSelect is ignored if Options includes goEditing. goDrawFocusSelected: Cells with input focus are drawn with a special highlight color, just like selected cells without input focus. If goDrawFocusSelected is not included, the cell with input focus is distinguished by a focus rectangle, not by a special background color. goRowSizing: Scrollable rows can be individually resized. goColSizing: Scrollable columns can be individually resized. goRowMoving: Scrollable rows can be moved using the mouse. goColMoving: Scrollable columns can be moved using the mouse. goEditing: Users can edit the contents of cells. When goEditing is included in Options, goRangeSelect has no effect. goTabs: Users can navigate through the cells in the grid using Tab and Shift+Tab. goRowSelect: Entire rows are selected rather than individual cells. If goRowSelect is included in Options, goAlwaysShowEditor has no effect. goAlwaysShowEditor: The grid is locked into edit mode. The user does not need to use Enter or F2 to turn on EditorMode. If Options does not include goEditing, goAlwaysShowEditor has no effect. If Options includes goRowSelect, goAlwaysShowEditor has no effect. goThumbTracking: The grid image updates while the user is dragging the thumb of the scrollbar. If goThumbTracking is not included, the image does not update until the user releases the thumb in a new position.



RowCount Specifies the number of rows in the grid.

151 - 390


Iris Version 3.0

Scrollbars Specifies whether the grid includes horizontal and vertical scroll bars.

ssNone: The grid has no scroll bars. ssHorizontal: The grid has a single scroll bar on the bottom edge. ssVertical: The grid has a single scroll bar on the right edge. ssBoth: The grid has a scroll bar on both the bottom and right edges.

VisibleColCount Indicates the number of scrollable columns visible in the grid. VisibleRowCount Indicates the number of scrollable rows visible in the grid.

152 - 390


Iris Version 3.0

9.26 Drive combo box

The Drive Combo Box is a specialized combo box that displays all the drives available when the application runs.


Drive Combo box properties

153 - 390


Iris Version 3.0

Explanation of the Drive Combo box properties: Property Description

Appearance























154 - 390


Iris Version 3.0


AutoDropDown Specifies whether the drop-down list drops down automatically in response to user keystrokes.






DirList Connects the drive combo box to a directory list box. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. ParentCtl3D Determines where an object looks to determine if it should appear three-dimensional.

This property determines whether the object uses its parent Ctl3D property. TextCase Determines if the volume name in the Text property appears in uppercase or

lowercase. tcLowerCase: The volume name specified in the Text property is displayed in lowercase letters. tcUpperCase: The volume name specified in the Text property is displayed in uppercase letters.

155 - 390


Iris Version 3.0

9.27 Edit

The Edit box is used to enter a single line text. It is also possible to present text to the user with the Edit box. Unlike the Label object it is possible to select text and copy the text of an Edit box to the Clipboard.


Edit properties

156 - 390


Iris Version 3.0

Explanation of the Edit properties: Property Description

Appearance





















157 - 390


Iris Version 3.0

Other


AutoSelect Determines whether all the text in the edit box is automatically selected when the object gets focus.






BorderStyle Returns or sets the border style for an object. CharCase The type of Case the text will be forced to. The possibilities are Lower Case, Normal

Case or Upper Case. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. HideSelection Determines whether the visual indication of the selected text remains when focus

shifts to another control. MaxLength Specifies the number of characters the user can enter into the edit box. OEMConvert When set to true all the type characters will be converted from ANSI (windows) to an

OEM character set. This is useful when type filenames. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is


This property determines whether the object uses its parent Ctl3D property. PasswordChar Returns or sets a value that determines whether characters typed bu the user or

placeholder characters are displayed in a control ReadOnly When set to true the text in the edit box cannot be change. Text Contains the string that is associated with the edit box.

158 - 390


Iris Version 3.0

9.28 Filter combo box

The Filter Combo Box is a specialized combo box that presents the user with a choice of file filters.


Filter Combo box properties

159 - 390


Iris Version 3.0

Explanation of the Filter Combo box properties: Property Description

Appearance























160 - 390


Iris Version 3.0


AutoDropDown Specifies whether the drop-down list drops down automatically in response to user keystrokes.






FileList Links the filter combo box to a file list box object. Filter Contains all the file masks displayed in the filter combo box. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. ParentCtl3D Determines where an object looks to determine if it should appear three-dimensional.


161 - 390


Iris Version 3.0

9.29 File list box

The File List Box is a specialized list box that lists all the files in a specified directory.


File List box properties

162 - 390


Iris Version 3.0

Explanation of the File List box properties: Property Description

Appearance












IntegralHeigth When set to true the height of the File list box depends on the list items. This means that the items will be displayed in the box completely. Of course the list can be longer.

ItemHeigth MultiSelect See also ExtendedSelect.

When set to true and ExtendedSelect is set to false the user can select several item (without using the Shift- or Ctrl-key).








163 - 390


Iris Version 3.0












ExtendedSelect The ExtendedSelect function works with the MultiSelect function. When set to true and the multiSelect also set to true the user can select more than one item by using the shift-key or Ctrl-key. When the MultiSelect is set to false the ExtendedSelect function has no effect.

FileEdit Links the directory list box to an edit object that displays the currently selected file. FileType Determines which files are displayed in the file list box based on the attributes of the

files. ftReadOnly: The list box displays files with the read-only attribute. ftHidden: The list box displays files with the hidden attribute. ftSystem: The list box displays system files. ftVolumeID: The list box displays the volume name. ftDirectory: The list box displays directories. ftArchive: The list box displays files with archive attribute. ftNormal: The list box displays files with no special attributes.

HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Mask Limits which files are displayed in the file list box. The file mask *.* displays all files,

which is the default value. ParentCtl3D Determines where an object looks to determine if it should appear three-dimensional.

This property determines whether the object uses its parent Ctl3D property. ShowGlyphs Determines whether glyphs (bitmaps) appear next to the file names listed in the file

list box.

164 - 390


Iris Version 3.0

9.30 Find dialog

The Find Dialog object displays a modeless Windows dialog box that prompts the user for a search string. The dialog does not appear at runtime until it is activated by a call to the Execute method.


Find Dialog properties

Explanation of the Find Dialog properties: Property Description

Appearance

Ctl3D Returns or sets whether an object is painted or not at runtime with 3-D effects. Misc

HelpContext Specifies the default help file context ID for an object. Name Returns or sets the name used in code to identify an object. Tag Stores any extra data needed for your program.

Other FindText Defines the string to find. Options Defines options for the find command.

The Find Dialog:

165 - 390


Iris Version 3.0

9.31 Font dialog

The Font Dialog object displays a modal dialog box for selecting fonts. The dialog does not appear at runtime until it is activated by a call to the Execute method. When the user selects a font and clicks OK, the dialog closes and the selected font is stored in the Font property.


Font Dialog properties

Explanation of the Font Dialog properties: Property Description

Appearance

Ctl3D Returns or sets whether an object is painted or not at runtime with 3-D effects. Font



Other Device Defines the Device to display the fonts MaxFontSize Defines the maximum font size. MinFontSize Defines the minimum font size. Options Defines options for the Font dialog.

166 - 390


Iris Version 3.0

The Font Dialog:

167 - 390


Iris Version 3.0

9.32 Gradient

The Gradient is a graphical object. It has no application function.


Gradient properties

168 - 390


Iris Version 3.0

Explanation of the Edit properties: Property Description

Appearance















ColorWidth The steps, in pixels, the Gradient has to change form the StartColor to the EndColor. The lower the colorWidth is, the smoother the change of color is.


Direction The direction of the gradient. DragKind Specifies whether an object is being dragged normally of for docking. EndColor The color on which the gradient must end. FormDrag Specifies whether the gradient object can be dragged over the screen. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. StartColor The color on which the gradient must start. SwapColors When set to true the StartColor and EndColor are swapped. Version Represents the version of the object. It has no functionality.

169 - 390


Iris Version 3.0

9.33 Group box

Functionally the group box is the same as the panel object. A difference is that the group box has a name in the top left corner. When objects are placed within the group box, the group box becomes the parent of those objects.


Group box properties

170 - 390


Iris Version 3.0

Explanation of the Group box properties: Property Description

Appearance

Caption Returns or sets the text displayed in an object’s title bar or below an object’s icon. Color Returns or sets the background color of the component Ctl3D Returns or sets whether or not an object is painted at runtime with 3-D effects. Cursor Specifies the image used to represent the mouse pointer when it passes into the region





















171 - 390


Iris Version 3.0



DockSite When checked the object can be a target of a drag-and-dock operation. DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is



172 - 390


Iris Version 3.0

9.34 Header

The Header is an object that displays text and allows each section to be resized with the mouse.


Header properties

173 - 390


Iris Version 3.0

Explanation of the Header properties: Property Description

Appearance


Behaviour Enabled Returns or sets a value that determines whether an object can respond to user-

generated events. TabOrder Indicates the position of the object in its parent’s tab order. Its the order in which














Other AllowResize Determines if the user can modify the size of the header at runtime with the mouse. Anchors Specifies how the control is anchored to its parent. Use this property to ensure that




HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Sections Lists the strings that contain the text for the sections of a header.

174 - 390


Iris Version 3.0

9.35 Header control

A Header Control object is a set of column headers the user can resize at runtime. Each header is represented by a HeaderSection object listed in the Sections property.

Basic layout when first placed on the screen. (On top of the screen covering the whole width)

Header control properties

175 - 390


Iris Version 3.0

Explanation of the Header control properties: Property Description

Appearance





generated events. Visible Returns or sets a value that determines whether an object is visible or hidden.
















DragKind Specifies whether an object is being dragged normally of for docking. DragReorder When checked the header is reorderable. FullDrag Specifies whether headers are repainted when they are dragged.

176 - 390


Iris Version 3.0

HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. HotTrack Highlights the header sections as the mouse passes over them. Images The images property contains a list of images that can be used as icons. Each section's

ImageIndex property determines the specific image displayed on it. If Images is unassigned, items are displayed as captions with no icons.


Sections Specifies header sections. The header sections will be discussed later on in this section.

Style Specifies the header control’s style.

177 - 390


Iris Version 3.0

Header sections: The following screen shows the Header section editor. This appears when the three dot button in the Sections property field of the Header control is clicked. With the buttons on top of the screen sections can be added or deleted.

Header section properties

Explanation of the Header section properties: Property Description

Appearance


Position AutoSize Determines whether a control is automatically resized to display its entire contents. Width Returns or sets the width of an object.

Other AllowClick Allows the section to respond to mouse clicks at runtime. BiDiMode Specifies the bi-directional mode for an object. Use BidiMode to enable the object to


ImageIndex Identifies the image that appears next to the text on the header section. Maxwidth Specifies the maximum width of the header section. MinWidth Specifies the minimum width of the header section. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is

checked, the object’s BiDiMode property is always equal to that of its parent. Style Determines how the header section’s text is displayed. Text Specifies the header section’s caption.

178 - 390


Iris Version 3.0

9.36 Hotkey

Use the hot key object to assign a keyboard shortcut that transfers focus to any object.


Hotkey properties

179 - 390


Iris Version 3.0

Explanation of the Hotkey properties: Property Description

Appearance



generated events. TabOrder Indicates the position of the object in its parent’s tab order. It is the order in which the















HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Hotkey Contains the current key combination of the hot key control.

180 - 390


Iris Version 3.0

InvalidKeys Allows you to specify that one or more modifier keys should be considered invalid.

hcNone: Unmodified keys are invalid. hcShift: The Shift key is invalid as a modifier. hcCtrl: The Ctrl key is invalid as a modifier. hcAlt: The Alt key is invalid as a modifier. hcShiftCtrl: The Shift+Ctrl key combination is invalid as a modifier. hcShiftAlt: The Shift+Alt key combination invalid as a modifier. hcCtrlAlt: The Ctrl+Alt key combination is invalid as a modifier. hcShiftCtrlAlt: The Shift+Ctrl+Alt key combination is invalid as a modifier.

Modifiers Specifies the key or keys that are used in combination with a non-modifier key. hkShift: The Shift key is used as a modifier. hkCtrl: The Ctrl key is used as a modifier. hkAlt: The Alt key is used as a modifier. hkExt: The Extra key is used as a modifier.


181 - 390


Iris Version 3.0

9.37 Image

The Image function is used to place an existing picture on a screen. Possible formats to use as a picture are BMP, ICO, EMF, WMF and JPG.


Image properties

182 - 390


Iris Version 3.0

Explanation of the Image properties: Property Description

Appearance


Transparent When checked the background of the object is transparent. When unchecked the object uses the background color stored in the color property or from the ParentColor property when this one is checked.















Center Centres the selected picture in the area reserved for the image. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. IncrementalDisplay When set to true partial renderings of the image are drawn periodically during slow

operations.

183 - 390


Iris Version 3.0

Picture Selection of the picture. Pressing on the three dots button at the end of the field will

cause the next window to appear

With the button a picture can be selected form a location. Proportional Fits the picture into the reserved area keeping the original ratio of the picture, Stretch When set to true stretches the selected picture in to the reserved area.

The pictures that are selected will be saved into the screen file. This means that the original pictures don’t have to be distributed with the application.

184 - 390


Iris Version 3.0

9.38 Image list

The Image List represents a collection of same-sized images, each of which can be referred to by its index.


Image list properties

Explanation of the Image list properties: Property Description

Misc

Name Returns or sets the name used in code to identify an object. Tag Stores any extra data needed for your program.

Position Height Returns or sets the height of an object. Width Returns or sets the width of an object.

Other AlloBy Sets the number of images by which the image list grows when it needs to make room

for new images. BkColor Determines which background color to use when drawing an image. BlendColor Determines which foreground color to use when drawing an image. DrawingStyle Specifies the style to be used when the image list is drawing an image. ImageType Determines whether the image list uses the associated mask when drawing.

itImage: Draws the image. itMask: Draws the image using the image mask.

Masked Specifies whether the image list includes masks that can be combined with the images.

ShareImages Specifies whether the image list destroys its handle when the image list is destroyed.

185 - 390


Iris Version 3.0

Double clicking on the Image List icon on the screen will make the Image List Editor appear.

Selected Image: The field shows the selected image. By clicking on another image in the image view below, this image is changed. When the image is added the first time this image can be changed using the other controls in this editor e.g. changing colors. Transperant color: Within this field you can change the color that will be used to create a mask for drawing the image transparently. Fill Color: Within this field you can specify a color that is added around the edges of the selected image when it is smaller than the dimensions indicated by the Height and Width properties of the image list object. Options: Use the radio button to specify what to do when the selected image does not exactly fit the dimensions specified by the Image List.

• Crop; Displays the section of the image beginning at the top-left, extending the image list width and height towards the bottom-right.

• Stretch; Causes the entire image to stretch so it will fit the image list width and height. • Center; Centers the image within the image list width and height. If the image width or

height is larger than the image list width or height, the image may be clipped. Button: With the buttons on the right site of the screen you can add, delete (single image), clear (all images) and save the image list.

186 - 390


Iris Version 3.0

9.39 Indicator

The Iris indicator is a label with predefined labels that will be shown depending on the value of a Tag.


Indicator properties

187 - 390


Iris Version 3.0

Explanation of the Iris Indicator properties: Property Description

Appearance


Caption Returns or sets the text displayed in an object’s title bar or below an object’s icon. Color Returns or sets the background color of the component Cursor Specifies the image used to represent the mouse pointer when it passes into the region

covered by an object. ParentColor To have a control use the same color as its parent control, check the ParentColor property.

When unchecked the control uses its own Color property. Behaviour

DragCursor Indicates the image used to represent the mouse pointer when the control is being dragged. DragMode Returns or sets a value that determines whether manual or automatic drag mode is used. Enabled Returns or sets a value that determines whether an object can respond to user-generated

events. TabOrder Indicates the position of the object in its parent’s tab order. Its the order in which the child

windows are visited when the user presses the Tab key. The object that has focus has a TabOrder value of 0. Initially, the tab order is always the order on which the objects were added to a form.





FocusControl Set FocusControl to the object that should receive focus when the user presses the accelerator key specified by the label.


Hint Hint Returns or sets the text displayed when the mouse is paused over the control. ParentShowHint When ParentShowHint is checked, the control uses the showHint property value of its parent.

If not, the control uses its own ShowHint property. ShowHint Determines if the control should display a hint when the mouse pointer rests momentarily on

it. Position


AutoSize Determines whether a control is automatically resized to display its entire contents. Height Returns or sets the height of an object. Left Returns or sets the distance between the internal left edge of an object and the left edge of its

container. Top Returns or sets the distance between the internal top edge of an object and the top edge of its

container. Width Returns or sets the width of an object.

Other Anchors Specifies how the control is anchored to its parent. Use this property to ensure that a control

maintains its current position relative to an edge of its parent, even if the parent is resized.

188 - 390


Iris Version 3.0






BorderStyle Returns or sets the border style for an object. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum width and

height of an object. When specified, the object cannot be resized to violate those constraints. DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. IndicatorStates The definition of the states used for the indicator. Pressing on the three-dot button in the field

the following screen will appear.

Within this window you can add several states with the button. When a state is added the object inspector will show the state details.


189 - 390


Iris Version 3.0

ShowAccelChar Determines how an ampersand in the label text is displayed. StateFormat Specifies the format of the indicator. Later on in this section the several formats discussed. StateTag Specifies the Tag from which the object gets its actual value from. The tag is specified using

the Tag selector function as described earlier in this chapter. StateValue Represents the status of the indicator. 0 is the first text in the list, 1 the second, and so on.

Stateformat: A format specifier begins with a % character. After the % could follow the following values:

Value Description

d Decimal. The argument must be an integer value. The value is converted to a string of decimal digits. If the format string contains a precision specifier, it indicates that the resulting string must contain at least the specified number of digits; if the value has less digits, the resulting string is left-padded with zeros.

u Unsigned decimal. Similar to 'd' but no sign is output. e Scientific. The argument must be a floating-point value. The value is converted to a string of

the form "-d.ddd...E+ddd". The resulting string starts with a minus sign if the number is negative. One digit always precedes the decimal point. The total number of digits in the resulting string (including the one before the decimal point) is given by the precision specifier in the format string—a default precision of 15 is assumed if no precision specifier is present. The "E" exponent character in the resulting string is always followed by a plus or minus sign and at least three digits.

f Fixed. The argument must be a floating-point value. The value is converted to a string of the form "-ddd.ddd...". The resulting string starts with a minus sign if the number is negative. The number of digits after the decimal point is given by the precision specifier in the format string—a default of 2 decimal digits is assumed if no precision specifier is present.

g General. The argument must be a floating-point value. The value is converted to the shortest possible decimal string using fixed or scientific format. The number of significant digits in the resulting string is given by the precision specifier in the format string—a default precision of 15 is assumed if no precision specifier is present. Trailing zeros are removed from the resulting string, and a decimal point appears only if necessary. The resulting string uses fixed point format if the number of digits to the left of the decimal point in the value is less than or equal to the specified precision, and if the value is greater than or equal to 0.00001. Otherwise the resulting string uses scientific format.

n Number. The argument must be a floating-point value. The value is converted to a string of the form "-d,ddd,ddd.ddd...". The "n" format corresponds to the "f" format, except that the resulting string contains thousand separators.

m Money. The argument must be a floating-point value. The value is converted to a string that represents a currency amount. The conversion is controlled by the CurrencyString, CurrencyFormat, NegCurrFormat, ThousandSeparator, DecimalSeparator, and CurrencyDecimals global variables, all of which are initialized from the Currency Format in the International section of the Windows Control Panel. If the format string contains a precision specifier, it overrides the value given by the CurrencyDecimals global variable.

190 - 390


Iris Version 3.0

9.40 Jog meter

The Jog meter is used for graphical representation of a value of a Tag, especially when the value can be positive as well as negative.


Jog meter properties

191 - 390


Iris Version 3.0

Explanation of the Iris Jog meter specific properties: Property Description

Appearance




DragCursor Indicates the image used to represent the mouse pointer when the control is being dragged. DragMode Returns or sets a value that determines whether manual or automatic drag mode is used. Visible Returns or sets a value that determines whether an object is visible or hidden.

Font Font Returns or sets the font characteristics of the component, including typeface, size, attributes

and color. ParentFont Determines where a control looks for its font information




it. Position


Height Returns or sets the height of an object. Left Returns or sets the distance between the internal left edge of an object and the left edge of its




maintains its current position relative to an edge of its parent, even if the parent is resized. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum width and

height of an object. When specified, the object cannot be resized to violate those constraints. Direction Indicates the direction of the jog meter. Horizontal or vertical. DragKind Specifies whether an object is being dragged normally of for docking. FormColor The start color (from both edges) of the jog meter. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Scale Defines the scale of the jog meter. ShowCaption When checked the caption of the jog meter is displayed within the jog meter.

192 - 390


Iris Version 3.0

ToColor The end color (the middle) of the jog meter.

Examples

Value Defines the Layout of the indicator. ValueTag Specifies the Tag from which the object gets its actual value from. The tag is specified using

the Tag selector function as described earlier in this chapter. Version Represents the version of the object. It has no functionality.

Examples of fully adapted jog meters

193 - 390


Iris Version 3.0

9.41 Label

With a label it is possible to put static text on a screen. A label can also be a part of another object like a Panel or a Group box. The Panel of Group box is in this case the parent of the label. When placed on a screen the parent of the label is the screen itself.


Label properties

194 - 390


Iris Version 3.0

Explanation of the Label properties: Property Description

Appearance




When unchecked the control uses its own Color property. Transparent When checked the background of the object is transparent. When unchecked the object uses

the background color stored in the color property or from the ParentColor property when this one is checked.

WordWrap Specifies whether the label text wraps when it is too long for the width of the label. Behaviour


events. Visible Returns or sets a value that determines whether an object is visible or hidden.



Misc FocusControl Set FocusControl to the object that should receive focus when the user presses the accelerator

key specified by the label. HelpContext Specifies the default help file context ID for an object. Name Returns or sets the name used in code to identify an object. PopupMenu Identifies the pop-up menu associated with the control. Tag Stores any extra data needed for your program.



it. Position






maintains its current position relative to an edge of its parent, even if the parent is resized.

195 - 390


Iris Version 3.0

BiDiMode bi-directional Specifies the mode for an object. Use BidiMode to enable the object to adjust

its appearance and behaviour automatically when the application runs in a locale that reads from right to left instead of left to right.


DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Layout The position of the text within the Label field. Possibilities are Top, Center and Bottom. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is checked,

the object’s BiDiMode property is always equal to that of its parent. ShowAccelChar When set to true an acceleration key can be used by using and ampersand (&) in front of the

character. That character will be underlined. When pressing the acceleration key the application will focus on the windows specified by the FocusControl property.

“W” is the acceleration key in this label.

196 - 390


Iris Version 3.0

9.42 Iris label

With the Iris label is a dynamic label to display text or numeric values on a screen. The label can also be a part of another object like a Panel or a Group box. The Panel of Group box is in this case the parent of the label. When placed on a screen the parent of the label is the screen itself.


Iris Label properties

197 - 390


Iris Version 3.0

Explanation of the Iris Label properties: Property Description

Appearance






WordWrap Specifies whether the label text wraps when it is too long for the width of the label. Behaviour


events. Visible Returns or sets a value that determines whether an object is visible or hidden.



Misc FocusControl Set FocusControl to the object that should receive focus when the user presses the accelerator

key specified by the label. HelpContext Specifies the default help file context ID for an object. Name Returns or sets the name used in code to identify an object. PopupMenu Identifies the pop-up menu associated with the control. Tag Stores any extra data needed for your program.



it. Position






maintains its current position relative to an edge of its parent, even if the parent is resized. AutoEditor When checked the label will show a numerical editor when clicked on the label at runtime.

This will only work when the tag connected to the label is a “Write” tag.

198 - 390


Iris Version 3.0



Decimals Specifies the number of decimals to be used for the label. Digits Specifies the total number of digits to be used within the label. DisplayTag Specifies the tag to be displayed in the label. DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Layout The position of the text within the Label field. Possibilities are Top, Center and Bottom. LeadingZero When checked the label will show leading zero’s. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is checked,

the object’s BiDiMode property is always equal to that of its parent. ShowAccelChar When set to true an acceleration key can be used by using and ampersand (&) in front of the

character. That character will be underlined. When pressing the acceleration key the application will focus on the windows specified by the FocusControl property.

“W” is the acceleration key in this label.

199 - 390


Iris Version 3.0

9.43 Led bar

Fully adaptable led bar for graphical representation of a value of a Tag. The number of LEDs can be adapted as well as the colors and dimensions of the LEDs.


Led bar properties

200 - 390


Iris Version 3.0

Explanation of the Iris Led bar properties: Property Description

Appearance





Behaviour DragCursor Indicates the image used to represent the mouse pointer when the control is being dragged. DragMode Returns or sets a value that determines whether manual or automatic drag mode is used. Visible Returns or sets a value that determines whether an object is visible or hidden.




it. Position






maintains its current position relative to an edge of its parent, even if the parent is resized. ColorWidth Specifies the Colorwidth of the led. The value must be betweeon 1 and 10. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum width and

height of an object. When specified, the object cannot be resized to violate those constraints. DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. LedStyle1 Defines the Ledstyle for the LEDs for the first sections. Colors and borders of the LEDs can

be defined. LedStyle2 Defines the Ledstyle for the LEDs for the second sections. Colors and borders of the LEDs

can be defined. LedStyle3 Defines the Ledstyle for the LEDs for the thirdsections. Colors and borders of the LEDs can

be defined. Leds Indicates the number of LEDs to be used for the LED bar. MaxValue Maximum limit value of the led bar. MinValue Minimum limit value of the led bar.

201 - 390


Iris Version 3.0

Percent1 The LED bar can be divided in three sections indicated by colors and types of LEDs. Percent1 indicates the percentage of the LED bar for the first section.

Percent2 Indicates the percentage of the LED bar for the second section. The third section will be the leftover off 100% minus the percentages of the first two sections.

Position Represents the position on the led bar, actually the value of the tag related to the limit values for the led bar.

Spacing Represents the spacing between de LEDs in pixels. Step Indicates the step width of the LED bar. Version Represents the version of the object. It has no functionality.

Examples

202 - 390


Iris Version 3.0

9.44 Level bar

The Level bar represents the value of a Tag in bar graph format. Like the scale of the Iris Meter the level bar can also be divided into three sections, each with there own color.


Level bar properties

203 - 390


Iris Version 3.0

Explanation of the Level bar properties: Property Description

Appearance




DragCursor Indicates the image used to represent the mouse pointer when the control is being dragged. DragMode Returns or sets a value that determines whether manual or automatic drag mode is used. Visible Returns or sets a value that determines whether an object is visible or hidden.




it. Position





maintains its current position relative to an edge of its parent, even if the parent is resized. Bevel Defines the bevels of the level bar. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum width and

height of an object. When specified, the object cannot be resized to violate those constraints. DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. MaxValue Maximum limit value of the level bar. MinValue Minimum limit value of the level bar. Orientation Defines the direction of the level bar, Vertical or Horizontal. Palette1 Defines the colors to be used for the zone 1, both High and Low states. Palette2 Defines the colors to be used for the zone 2, both High and Low states. Palette3 Defines the colors to be used for the zone 3, both High and Low states. Percent1 The Level bar can be divided in three sections indicated by colors. Percent1 indicates the

percentage of the Level bar for the first section.

Percent2 Indicates the percentage of the level bar for the second section. The third section will be the leftover off 100% minus the percentages of the first two sections.

Position Returns or set the position on the level bar. Spacing Defines the spacing between the leds on the level bar. Step Defines the number of steps to be used on the level bar.

204 - 390


Iris Version 3.0

Style Defines the style of the level bar. psBottomLeft; The 0 position is on the bottom when the orientation is set to vertical and is on the left when the orientation is set to horizontal. psBottomLeft; The 0 position is on the bottom when the orientation is set to vertical and is on the left when the orientation is set to horizontal. psTopRight; The 0 position is on the Top when the orientation is set to vertical and is on the Right when the orientation is set to horizontal.

TickHeigth Defines the height of each tick on the level bar. The height is in pixels. Version Represents the version of the object. It has no functionality.

205 - 390


Iris Version 3.0

9.45 List box

With the List box the user can select items from a list. It is also possible to select more than one item. When the list of items is bigger than the list box itself a scrollbar will appear.


List box properties

206 - 390


Iris Version 3.0

Explanation of the List box properties: Property Description

Appearance












IntegralHeigth When set to true the height of the list box depends on the list items. This means that the items will be displayed in the box completely. Of course the list can be longer.

False True

ItemHeigth Defines the Heigth of an item. Items The editor where the list can be edit.

207 - 390


Iris Version 3.0

MultiSelect See also ExtendedSelect. When set to true and ExtendedSelect is set to false the user can select several item (without using the Shift- or Ctrl-key).



















BorderStyle Returns or sets the border style for an object. Columns The number of columns used in the list box.

1 column 2 columns


208 - 390


Iris Version 3.0


ExtendedSelect The ExtendedSelect function works with the MultiSelect function.

When set to true and the multiSelect also set to true the user can select more than one item by using the shift-key or Ctrl-key. When the MultiSelect is set to false the ExtendedSelect function has no effect.

HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is


This property determines whether the object uses its parent Ctl3D property. ScrollWidth Specifies the width, in pixels, by which the list box can scroll horizontally. Sorted When set to true all the list items will be alphabetical sorted. Style Select the style of the List box:

DropDown: a List box with a drop-down list DropDownList: a List box that is read-only, the user can only select from the drop-down list. Simple: a List box without a drop-down list OwnerDrawFixed: a List box that displays graphical items OwnerDrawVariable: a List box that displays items with heights

TabWidth Specifies the size of the tabs in the list box.

209 - 390


Iris Version 3.0

9.46 List view

The List View object displays a list of items in a form. The items can be displayed in columns with column headers and sub-items, or vertically or horizontally, with small or large icons.

List view properties

210 - 390


Iris Version 3.0

Explanation of the List view properties: Property Description

Appearance










Items Contains the list of items displayed by the list view. MultiSelect When set to true and ExtendedSelect is set to false the user can select several item

(without using the Shift- or Ctrl-key). Font











211 - 390


Iris Version 3.0

Other

Action Designates the action associated with the object. Actions allow an application to centralize the response to user commands. For creating actions, see the object Action list.

AlloBy Indicates the number of items the list view can store in memory. Anchors Specifies how the control is anchored to its parent. Use this property to ensure that a






BevelWidth Determines the width, in pixels, of both the inner- and outer bevel of an object. BiDiMode Specifies the bi-directional mode for an object. Use BidiMode to enable the object to


BorderStyle Returns or sets the border style for an object. BorderWidth Specifies the distance, in pixels, between the outer- and inner bevels. Use


Checkboxes Specifies whether check boxes appear next to the items in the list view. ColumnClick Determines whether the column header behaves like a button. Columns The number of columns used in the list. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DragKind Specifies whether an object is being dragged normally of for docking. FlatScrollBars Specifies whether the list view's scroll bars are flat. FullDrag Specifies whether headers are repainted when they are dragged. GridLines Determines whether lines are drawn separating items in the list. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. HideSelection Determines whether the list view gives a visual indication of which item is selected

when focus shifts to another object. HotTrack Specifies whether list items are highlighted when the mouse passes over them. HotTrackStyles Specifies the hot tracking styles. HoverTime Specifies how long the user must pause with the mouse before an item is selected. IconOptions Determines how icons displayed in the list view are arranged. LargeImages Provides a list of icon images to display for each item in the list when the property

ViewStyle is set to vsIcon. OwnerData Specifies whether the list view control is a virtual object. OwnerDraw Specifies whether the list view receives an OnDrawItem event. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is

checked, the object’s BiDiMode property is always equal to that of its parent. ReadOnly Determines whether the user can change the contents of the object. RowSelect Determines whether an entire row in the list view can be selected. ShowColumnHeader Determines whether the column headers are displayed. ShowWorkAreas Determines whether the visual properties of work areas are displayed. SmalImages Provides a list of icon images to display for each item in the list when the property

ViewStyle is not set to vsIcon. SortType Determines if and how the items in the list are automatically sorted.

212 - 390


Iris Version 3.0

StateImages Provides a list of additional icon images to display next to each item in the list view. ViewStyle Determines how the list items are displayed.

vsIcon: Each item appears as a full-sized icon with a label below it. The user can drag the items to any location in the list view window. vsSmallIcon: Each item appears as a small icon with the label to the right of it. The user can drag the items to any location. vsList: Each item appears as a small icon with a label to the right of it. Items are arranged in columns and cannot be dragged by the user. vsReport: Each item appears on its own line with information arranged in columns. The leftmost column contains the small icon and label, and subsequent columns contain subitems as specified by the application. Unless ShowColumnHeaders is False, each column has a header.

213 - 390


Iris Version 3.0

9.47 Main menu

The Main menu provides a menu bar and its accompanying drop-down menus for a form. To begin designing a menu, add a main menu to a form, and double-click the component.

Besic layout when first placed on the screen.

Main menu properties

Explanation of the Main menu properties: Property Description

List

Items Describes the elements of the menu. Items are a single MenuItem object that describes the elements of the menu in its own Items property. Futher on in this section the MenuItem object is discussed.

Misc Name Returns or sets the name used in code to identify an object. Tag Stores any extra data needed for your program.

Other AutoHotKeys Determines whether the accelerator keys for menu items can be reset automatically. AutoLineReduction Determines whether redundant separator bars are automatically removed from the

menu. Automerge Determines if the main menus of secondary forms merge with the main menu of the

main form in non-MDI applications at runtime. BiDiMode Specifies the bi-directional mode for an object. Use BidiMode to enable the object to


Images Lists the images that can appear beside individual menu items. OwnerDraw Specifies whether the menu items are drawn by the application. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is

checked, the object’s BiDiMode property is always equal to that of its parent.

214 - 390


Iris Version 3.0

Menu Items: Double clicking on the Main menu object on the form will make the following screen appear. By using the right-hand mouse button on the screen you can add and remove menu items and submenu items.

Menu item properties

215 - 390


Iris Version 3.0

Explanation of the Menu item properties: Property Description

Appearance

Caption Returns or sets the text displayed in an object’s title bar or below an object’s icon. Behaviour

Default Specifies whether the menu item is invoked when the parent item is double clicked. Enabled Returns or sets a value that determines whether an object can respond to user-

generated events. GroupIndex Identifies the logical group to which the menu item belongs. Visible Returns or sets a value that determines whether an object is visible or hidden.





AutoCheck Indicates whether the menu item’s checked state toggles automatically when the item is clicked.

AutoHotKeys Determines whether the accelerator keys for submenu items can be reset automatically.

AutoLineReduction Determines whether redundant separator bars are automatically removed from the submenu.

Bitmap Designates a bitmap that is drawn for the menu item. Break Determines whether the menu item starts a new column in the menu.

mbNone: No menu breaking occurs. This is the default value. mbBarBreak: The Parent menu breaks into another column with the menu item appearing at the top of the new column. A bar separates the new and the old columns. mbBreak: The Parent menu breaks into another column with the menu item appearing at the top of the new column. Only space separates the new and the old columns.

Checked Specifies whether a check mark should appear beside the Caption. ImageIndex Indicates which image maintained by the parent menu appears next to the menu item. RadioItem Specifies whether the menu item is mutually exclusive with other menu items in its

group. ShortCut Specifies the key combination users can type to quickly access the menu item. SubMenuImages Lists the images that can appear beside individual items in a submenu of this menu

item. The following picture shows an example of a menu structure.

216 - 390


Iris Version 3.0

9.48 Mask edit

The MaskEdit object is used to put a masked edit control on your form. Masked edit controls validate the text the user enters against a mask that encodes the valid forms the text can take.


Mask edit properties

217 - 390


Iris Version 3.0

Explanation of the Mask edit properties: Property Description

Appearance





















218 - 390


Iris Version 3.0

Other


AutoSelect Determines whether all the text in the Mask edit is automatically selected when the control gets focus.







BorderStyle Returns or sets the border style for an object. CharCase Determines the case of the text within the Mask edit object.

ecLowerCase: The text is converted to lowercase. ecNormal: The text appears in mixed case. It is not forced into any case. ecUpperCase: The text is converted to uppercase.


DragKind Specifies whether an object is being dragged normally of for docking. EditMask Specifies the mask that represents what text is valid for the masked edit object. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. MaxLength Specifies the maximum number of characters that can appear in the Mask edit object. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is


This property determines whether the object uses its parent Ctl3D property. PasswordChar Indicates the character, if any, to display in place of the actual characters typed in the

object. ReadOnly Determines whether the user can change the text of the Mask edit object. Text Denotes the underlying text for the masked edit object before the mask has been

applied.

219 - 390


Iris Version 3.0

9.49 Media player

The Media Player object is used to control devices that provide a media control interface (MCI) driver. The object includes a set of common buttons like Play, Stop, Eject, etc.. that controls a multimedia device such as a CD-ROM drive.


Paintbox properties

220 - 390


Iris Version 3.0

Explanation of the Media Player properties: Property Description

Appearance
















AutoEnable Determines whether the media player automatically enables and disables individual buttons in the object.

AutoOpen Determines if the media player is opened automatically when the application is running.

AutoRewind Determines if the media player control rewinds before playing or recording. ColoredButtons Determines which buttons on the media player have color. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DeviceType Specifies the multimedia device to open the media player. Display Specifies the display window for a multimedia device that uses a window for output. EnableButtons Determines which buttons on the media player are usable. FileName Specifies the opened or saved media file. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Shareable Specifies whether more than one application can share a multimedia device. VisibleButtons Indicates which of the buttons on the media player are visible.

221 - 390


Iris Version 3.0

9.50 Memo

Additional to the Edit box the Memo box can be used to enter more than one line of text by the user.


Memo properties

222 - 390


Iris Version 3.0

Explanation of the Memo properties: Property Description

Appearance




property. When unchecked the control uses its own Color property. WordWrap Determines whether the edit control inserts soft carriage returns so text wraps at the

right margin. Behaviour


















223 - 390


Iris Version 3.0











DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. HideSelection Determines whether the visual indication of the selected text remains when focus

shifts to another object. Lines The text that will be shown in the memo box in lines. Pressing the three dots button in

the field will make the next screen appear.

MaxLength Specifies the maximum length of text, in characters that the memo can contain. OEMConvert Determines whether characters typed in the memo object are converted from ANSI to

OEM and then back to ANSI. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is


This property determines whether the object uses its parent Ctl3D property. ReadOnly Determines whether the user can change the text of the memo object.

224 - 390


Iris Version 3.0

Scrollbars Determines whether the memo control has scroll bars.

ssNone: The control has no scroll bars. ssHorizontal: The control has a single scroll bar on the bottom edge. ssVertical: The control has a single scroll bar on the right edge. ssBoth: The control has a scroll bar on both the bottom and right edges.

WantReturns Set WantReturns to true to allow users to enter return characters into the text. WantTabs Set WantTabs to true to allow users to enter tab characters into the text.

225 - 390


Iris Version 3.0

9.51 Meter

A Meter is an indicator that makes it possible to represent a value of a point in a graphic format. The graphical representation can be completely adapted by changing its properties.


Meter properties

226 - 390


Iris Version 3.0

Explanation of the Meter properties: Property Description

Appearance




















Angle Defines the angle of the scale measured from a horizontal line. When the angle is 0 and the position of the needle is 0 the needle will point to the left.

BackImage An Image can be loaded as for the background of the meter. Pressing on the three-dot button within the field will make the following screen appear.

Bevel Specifies the bevel to be used on the Meter borders.

227 - 390


Iris Version 3.0

Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. LabelOffsetX Indicates the distance, in horizontal direction, between the labels and the scale. LabelOffsetY Indicates the distance, in vertical direction, between the labels and the scale. Labels Indicated the number of labels that will be shown on the scale of the meter. MaxValue Indicates the maximum value of the meter. MinValue Indicates the minimum value of the meter. NeedleColor Indicates the color of the needle. NeedleWidth Indicates the width of the needle in pixels. Position Represents the actual value of the meter. Scale Properties for changing the graphical layout of the scale. The scale can be divided in

three sections each having their own color. Spacing Indicates the space between the top of the scale of the meter and the top of its panel. Version Represents the version of the object. It has no functionality.

Examples

228 - 390


Iris Version 3.0

9.52 Month calendar

The Month calendar is stand-alone calendar in which a user can select a date or range of dates.


Month calendar properties

229 - 390


Iris Version 3.0

Explanation of the Month calendar properties: Property Description

Appearance





generated events. ImeMode Determines the behaviour of the input method editor (IME). An IME is a front-end

input processor for Asian language characters. The IME coverts all keyboard input to Asian characters and send them to the application.





MultiSelect When set to true and ExtendedSelect is set to false the user can select several item (without using the Shift- or Ctrl-key).











230 - 390


Iris Version 3.0

Other




CalColors Contains the colors used for each part of the calendar. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


Date Indicates the date that is marked on the calendar. DragKind Specifies whether an object is being dragged normally of for docking. EndDate Indicates the last date that in the range of selected dates. FirstDayOfWeek Specifies the left-most day on the calendar. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. MaxDate Indicates the maximum date to which users can scroll the calendar. MaxSelectRange Specifies the maximum number of days that can be selected. MinDate Indicates the minimum date that can be selected. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is

checked, the object’s BiDiMode property is always equal to that of its parent. ShowToday Specifies whether today's date is shown below the calendar. ShowTodayCircle Specifies whether today's date is circled on the calendar. WeekNumbers Specifies whether week numbers are shown to the left of the calendar.

231 - 390


Iris Version 3.0

9.53 Notebook

The Notebook object displays multiple pages, each with its own set of objects. Notebook objects are frequently used with tab set objects to let the user select pages in the notebook by clicking a tab.


Notebook properties

232 - 390


Iris Version 3.0

Explanation of the Notebook properties: Property Description

Appearance




















Other ActivePage Determines which page displays in the notebook. Anchors Specifies how the control is anchored to its parent. Use this property to ensure that



233 - 390


Iris Version 3.0

HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. PageIndex Determines which page displays in the notebook object. Pages Contains the strings that identify the individual pages of the notebook object. ParentCtl3D Determines where an object looks to determine if it should appear three-


234 - 390


Iris Version 3.0

9.54 Ole container

The OleContainer embeds or links OLE objects.


Ole Container properties

235 - 390


Iris Version 3.0

Explanation of the Ole Container properties: Property Description

Appearance


















Other AllowActiveDoc Specifies whether the OLE container supports the IOleDocumentSite interface. AllowInPlace Determines whether the OLE container allows in-place activation. Anchors Specifies how the control is anchored to its parent. Use this property to ensure that a


236 - 390


Iris Version 3.0

AutoActivate Determines how the object in an OLE container is activated.

aaManual: The OLE object must be activated programmatically by calling DoVerb (ovShow). aaGetFocus: The OLE object is activated when the OLE container gets focus (by clicking on it with the mouse or pressing Tab to move the focus to it). aaDoubleClick: (Default) The OLE object is activated by double-clicking it or pressing Enter while the container has the focus.

AutoVerbMenu Determines whether the OLE container automatically creates a pop-up menu containing the OLE object's verbs.



CopyOnSave Determines whether the SaveToFile and SaveToStream methods first create a copy of the OLE object.

HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Iconic Determines whether the OLE object is displayed as an icon. OldStreamFormat Indicates whether the OLE object is loaded and saved using the old format. ParentCtl3D Determines where an object looks to determine if it should appear three-dimensional.

This property determines whether the object uses its parent Ctl3D property. SizeMode Determines how the OLE object is sized in the OLE container.

smClip: (Default)- Displays the OLE object at its normal size, clipping any parts that don't fit within the container. smCenter: Displays the OLE object at its normal size, centering it within the container. smScale: Scales or shrinks the view of the OLE object to fit within the container, by scaling width and height proportionally. smStretch: Scales or shrinks the view of the OLE object to fill the OLE container, without regard to preserving the proportions of the OLE object. smAutoSize: Displays the OLE object at its normal size and automatically resizes the container to fit the size of the OLE object.

237 - 390


Iris Version 3.0

9.55 Open dialog

The Open Dialog object displays a modal Windows dialog box for selecting and opening files. The dialog does not appear at runtime until it is activated by a call to the Execute method. When the user clicks Open, the dialog closes and the selected file or files are stored in the Files property.


Open Dialog properties

Explanation of the Open Dialog properties: Property Description

Appearance

Ctl3D Returns or sets whether or not an object is painted at runtime with 3-D effects. Misc


Other DefaultExt Specifies a file extension that is appended automatically to the selected file name,

unless the selected file name already includes a registered extension. FileName Indicates the name and directory path of the last file selected. Filter Determines the file masks (filters) available in the dialog. FilterIndex Determines which filter is selected by default when the dialog opens. InitialDir Determines the current directory when the dialog opens.

238 - 390


Iris Version 3.0

Options Determines the appearance and behaviour of the file-selection dialog.

ofReadOnly: Selects the Open As Read Only check box by default when the dialog opens. ofOverwritePrompt: Generates a warning message if the user tries to select a file name that is already in use, asking whether to overwrite the existing file. (Use with TSaveDialog and TSavePictureDialog.) ofHideReadOnly: Removes the Open As Read Only check box from the dialog. ofNoChangeDir: After the user clicks OK, resets the current directory to whatever it was before the file-selection dialog opened. ofShowHelp: Displays a Help button in the dialog. ofNoValidate: Disables checking for invalid characters in file names. Allows selection of file names with invalid characters. ofAllowMultiSelect: Allows users to select more than one file in the dialog. ofExtensionDifferent: This flag is turned on at runtime whenever the selected filename has an extension that differs from DefaultExt. If you use this flag in an application, remember to reset it. ofPathMustExist: Generates an error message if the user tries to select a file name with a nonexistent directory path. ofFileMustExist: Generates an error message if the user tries to select a nonexistent file. (only applies to Open dialogs). ofCreatePrompt: Generates a warning message if the user tries to select a nonexistent file, asking whether to create a new file with the specified name. ofShareAware: Ignores sharing errors and allows files to be selected even when sharing violations occur. ofNoReadOnlyReturn: Generates an error message if the user tries to select a read-only file. ofNoTestFileCreate: Disables checking for network file protection and inaccessibility of disk drives. Applies only when the user tries to save a file in a create-no-modify shared network directory. ofNoNetworkButton: Removes the Network button (which opens a Map Network Drive dialog) from the file-selection dialog. Applies only if the ofOldStyleDialog flag is on. ofNoLongNames: Displays 8.3-character file names only. This option is only valid if Options also includes ofOldStyleDialog. ofOldStyleDialog Creates the older style of file-selection dialog. ofNordereferenceLinks: Disables dereferencing of Windows shortcuts. If the user selects a shortcut, assigns to FileName the path and file name of the shortcut itself (the .LNK file), rather than the file linked to the shortcut. ofEnableIncludeNotify: (Windows 2000 and later.) Sends CDN_INCLUDEITEM notification messages to the dialog when the user opens a folder. A notification is sent for each item in the newly opened folder. You can use these messages to control which items appear in the folder’s item list. ofEnableSizing: (Windows 98 and later) Lets the Explorer-style dialog be resized with the mouse or keyboard. By default, the dialog allows this resizing regardless of the value of this option. It is only required if you provide a hook procedure or custom template. (Old style dialogs never permit resizing.) ofDontAddToRecent: Prevents the file from being added to the list of recently opened files. ofShowHidden: Ensures that hidden files are visible in the dialog.

OptionsEx More descriptions which determine the appearance and behaviour of the file-selection dialog.

Title Specifies the text in the dialog’s title bar.

239 - 390


Iris Version 3.0

The Open Dialog:

240 - 390


Iris Version 3.0

9.56 Open picture dialog

The Open Picture Dialog object displays a modal Windows dialog box for selecting and opening graphics files. This component is just like TOpenDialog, except that it includes a rectangular preview region. The selected image is displayed in the preview region; supported file types include bitmap (.BMP), icon (.ICO), Windows metafile (.WMF), and enhanced Windows metafile (.EMF). If the selected image cannot be displayed, “(None)” appears in the preview region.


Open Picture Dialog properties

Explanation of the Open Picture Dialog properties: Property Description

Appearance



Other DefaultExt Specifies a file extension that is appended automatically to the selected file name,

unless the selected file name already includes a registered extension. FileName Indicates the name and directory path of the last file selected. Filter Determines the file masks (filters) available in the dialog. FilterIndex Determines which filter is selected by default when the dialog opens. InitialDir Determines the current directory when the dialog opens.

241 - 390


Iris Version 3.0


ofReadOnly: Selects the Open As Read Only check box by default when the dialog opens. ofOverwritePrompt: Generates a warning message if the user tries to select a file name that is already in use, asking whether to overwrite the existing file. (Use with TSaveDialog and TSavePictureDialog.) ofHideReadOnly: Removes the Open As Read Only check box from the dialog. ofNoChangeDir: After the user clicks OK, resets the current directory to whatever it was before the file-selection dialog opened. ofShowHelp: Displays a Help button in the dialog. ofNoValidate: Disables checking for invalid characters in file names. Allows selection of file names with invalid characters. ofAllowMultiSelect: Allows users to select more than one file in the dialog. ofExtensionDifferent: This flag is turned on at runtime whenever the selected filename has an extension that differs from DefaultExt. If you use this flag in an application, remember to reset it. ofPathMustExist: Generates an error message if the user tries to select a file name with a nonexistent directory path. ofFileMustExist: Generates an error message if the user tries to select a nonexistent file. (only applies to Open dialogs). ofCreatePrompt: Generates a warning message if the user tries to select a nonexistent file, asking whether to create a new file with the specified name. ofShareAware: Ignores sharing errors and allows files to be selected even when sharing violations occur. ofNoReadOnlyReturn: Generates an error message if the user tries to select a read-only file. ofNoTestFileCreate: Disables checking for network file protection and inaccessibility of disk drives. Applies only when the user tries to save a file in a create-no-modify shared network directory. ofNoNetworkButton: Removes the Network button (which opens a Map Network Drive dialog) from the file-selection dialog. Applies only if the ofOldStyleDialog flag is on. ofNoLongNames: Displays 8.3-character file names only. This option is only valid if Options also includes ofOldStyleDialog. ofOldStyleDialog Creates the older style of file-selection dialog. ofNordereferenceLinks: Disables dereferencing of Windows shortcuts. If the user selects a shortcut, assigns to FileName the path and file name of the shortcut itself (the .LNK file), rather than the file linked to the shortcut. ofEnableIncludeNotify: (Windows 2000 and later.) Sends CDN_INCLUDEITEM notification messages to the dialog when the user opens a folder. A notification is sent for each item in the newly opened folder. You can use these messages to control which items appear in the folder’s item list. ofEnableSizing: (Windows 98 and later) Lets the Explorer-style dialog be resized with the mouse or keyboard. By default, the dialog allows this resizing regardless of the value of this option. It is only required if you provide a hook procedure or custom template. (Old style dialogs never permit resizing.) ofDontAddToRecent: Prevents the file from being added to the list of recently opened files. ofShowHidden: Ensures that hidden files are visible in the dialog.

OptionsEx More descriptions which determine the appearance and behaviour of the file-selection dialog.

Title Specifies the text in the dialog’s title bar.

242 - 390


Iris Version 3.0

The Open Picture Dialog:

243 - 390


Iris Version 3.0

9.57 Page control

The PageControl object is a set of pages used to make a multiple page dialog box.

Page control properties

244 - 390


Iris Version 3.0

Explanation of the Page control properties: Property Description

Appearance



















Other ActivePage Specifies the page currently displayed by the page control. Anchors Specifies how the control is anchored to its parent. Use this property to ensure that a



245 - 390


Iris Version 3.0



DockSite When checked the object can be a target of a drag-and-dock operation. DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. HotTrack Determines whether labels on the tab under the mouse are automatically highlighted. Images Specifies the images drawn in tabs. MultiLine Determines whether the tabs can appear on more than one row. OwnerDraw Specifies whether the Page control handles its own painting. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is

checked, the object’s BiDiMode property is always equal to that of its parent. RaggedRight Specifies whether rows of tabs stretch to fill the width of the object. ScrollOpposite Determines how the rows of tabs are scrolled in a muliline tab control. Style Specifies the style of the tab control. This can appear as notebook tabs or as buttons. TabHeigth Specifies the height, in pixels, of the tabs in the tab control. TabIndex Identifies the selected tab on a tab control. TabPosition Determines whether tabs appear at the top or bottom. TabWidth Specifies the horizontal size, in pixels, of the tabs in the tab control.

246 - 390


Iris Version 3.0

9.58 Page scroller

The Page scroller defines a display area for a narrow window, such as a toolbar. If the window is larger than the display area, the Page scroller attaches arrows to the edges of the window, allowing it to be scrolled within the display area.


Page scroller properties

247 - 390


Iris Version 3.0

Explanation of the Page scroller properties: Property Description

Appearance






















AutoScroll Specifies whether the page scroller scrolls when the mouse hovers over one of its arrows.

248 - 390


Iris Version 3.0

BorderWidth Specifies the distance, in pixels, between the outer- and inner bevels. Use


ButtonSize Specifies the size of the page scroller’s arrows. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


Control Specifies the control contained in the page scroller. DockSite When checked the object can be a target of a drag-and-dock operation. DragKind Specifies whether an object is being dragged normally of for docking. DragScroll Specifies whether the contained window can be a drag-and-drop target. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Margin Specifies the margin between the contained window and the inside edges of the page

scroller. Orientation Specifies whether the page scroller is horizontal or vertical. Position Specifies the scroll position of the page scroller.

249 - 390


Iris Version 3.0

9.59 Paintbox

The Paintbox can be used to add custom images to a screen. Unlike the Image object, which displays an image that is stored in a bitmap, icon or metafile, the paintbox requires an application to draw the image directly on a canvas.


Paintbox properties

250 - 390


Iris Version 3.0

Explanation of the Paintbox properties: Property Description

Appearance





















DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword.

251 - 390


Iris Version 3.0

9.60 Panel

A panel can be used to group several objects. The panel is the parent of those objects. To make an object a child of the panel, just place an object into the panel instead of placing it on the screen.


Panel properties

252 - 390


Iris Version 3.0

Explanation of the Paintbox properties: Property Description

Appearance





















253 - 390


Iris Version 3.0

Other








DockSite When checked the object can be a target of a drag-and-dock operation. DragKind Specifies whether an object is being dragged normally of for docking. FullRepaint When set to true the whole panel including its borders will be updated when the size

of the panel is changed. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Locked When set to true the panel can be replaced by another panel(toolbar) provided by an

OLE server. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is


This property determines whether the object uses its parent Ctl3D property. UseDockManager Specifies whether the docking manager is used in drag-and-dock operations. The

Docking manager handles the position of docked objects and any painting of docjing zones around those objects.

Example of a panel in combination with a label, checkbox and an Iris Line meter.

254 - 390


Iris Version 3.0

9.61 Popup menu

The Popup menu defines the pop-up menu that appears when the user clicks on an object with the right mouse button. To make a pop-up menu available, assign the PopupMenu object to the objects PopupMenu property.


Popup menu properties

255 - 390


Iris Version 3.0

Explanation of the Popup menu properties: Property Description

Appearance


List Items Describes the elements of the menu. Items is a single MenuItem object that describes

the elements of the menu in its own Items property. See the section Main menu for the decription of the Menu Items.


Other AutoHotKeys Determines whether the accelerator keys for menu items can be reset automatically. AutoLineReduction Determines whether redundant separator bars are automatically removed from the

menu. AutoPopup Determines whether the pop-up menu appears automatically when the user clicks the

right mouse button. BiDiMode Specifies the bi-directional mode for an object. Use BidiMode to enable the object to


Images Lists the images that can appear beside individual menu items. MenuAnimation Specifies how the menu appears when it is first displayed. OwnerDraw Specifies whether the menu items are drawn by the application. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is

checked, the object’s BiDiMode property is always equal to that of its parent. TrackButton Specifies which mouse button activates the popup menu when it is associated with a

toolbar button.

256 - 390


Iris Version 3.0

9.62 Power meter

The Power meter represents a value of a Tag graphically. The meter can be equipped with a scale, with or without units, and title of the meter.


Power meter properties

257 - 390


Iris Version 3.0

Explanation of the Power meter properties: Property Description

Appearance




















BarColor Specifies the background color of the bar. BarWidth Defines the bar width in pixels. BottomOffset Defines the space, in pixels, between the power meter and the bottom side of the panel

of the power meter. When the property TopOffset doesn’t change with the same amount the power meter will be resized.

ColorHighlight Specfies the color of the border of the bar, including the ticks, for the part of the bar that is included within the value.

258 - 390


Iris Version 3.0

ColorShadow Specfies the color of the border of the bar, including the ticks, for the part of the bar that is not included within the value.


Decimals Defines the number of decimals to be used for the units of the scale. DragKind Specifies whether an object is being dragged normally of for docking. FillColor Specifies the color of the bar the represents the actual value. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Increment Defines the value between two ticks on the scale. When set to 10 (default) the scale

will have 10 ticks, when set to 20 the scale will have 5 ticks. MarkerImage Defines the image to be used as the marker. MarkerVisible Defines the marker of the power meter to be visible or not. MaxValue Specifies the maximum value of the power bar. MinValue Specifies the minimum value of the power bar. ScaleVisible Defines if the power meter has to have a scale. TitleAlignment The Title (name) of the power meter can be showed on top or on the bottom of the

power meter. TitleFont Specifies the font of the title of the power bar. TopOffset Defines the space, in pixels, between the power meter and the topside of the panel of

the power meter. When the property BottomOffset doesn’t change with the same amount the power meter will be resized.

UnitsText Defines if en how the units on de scale will be shown. %s means that the scale will have units. The text behind that will be shown behind the units (bar, dB, etc.).

Value Represents the actual value of the power bar. ValueTag Specifies the Tag from which the object gets its actual value from. The tag is specified

using the Tag selector function as described earlier in this chapter. Version Represents the version of the object. It has no functionality.

259 - 390


Iris Version 3.0

9.63 Print dialog

The Print Dialog object displays a standard Windows dialog box for sending jobs to a printer. The dialog is modal and does not appear at runtime until it is activated by a call to the Execute method.


Print Dialog properties

Explanation of the Print Dialog properties: Property Description

Appearance



Other Collate Indicates whether the Collate check box is selected. Copies Indicates the number copies selected in the Print dialog. FromPage Indicates the page on which the print job is to begin. MaxPage Determines the greatest page number the user can enter when specifying pages to

print. MinPage Determines the smallest page number the user can enter when specifying pages to

print.

260 - 390


Iris Version 3.0

Options Determines the appearance and behaviour of the Print dialog.

poDisablePrintToFile: Disables (grays) the Print To File Check box. (Applicable only if the poPrintToFile flag is set.) poHelp: Displays a Help button in the dialog. May not work in some versions of Windows 95. poPageNums: Enables the Pages radio button, allowing the user to specify a page range. poPrintToFile: Displays a Print To File check box in the dialog. poSelection: Enables the Selection radio button, allowing the user to print selected (highlighted) text. poWarning: Generates a warning message if the user tries to send a job to an uninstalled printer.

PrintRange Indicates the type of print range selected in the dialog. prAllPages: The All radio button is selected. prSelection: The Selection radio button is selected. prPageNums: The Pages radio button is selected.

PrintToFile Indicates whether the Print To File check box is selected. ToPage Indicates the page on which the print job is to end.

The Print Dialog:

261 - 390


Iris Version 3.0

9.64 Printer setup dialog

The Printer Setup Dialog displays a modal Windows dialog box for configuring printers. The contents of the dialog vary depending on the printer driver selected. The dialog does not appear at runtime until it is activated by a call to the Execute method.


Printer Setup Dialog properties

Explanation of the Printer Setup Dialog properties: Property Description

Appearance



262 - 390


Iris Version 3.0

The Printer Setup Dialog:

263 - 390


Iris Version 3.0

9.65 Progress bar

Progress bars provide users with visual feedback about the progress of a procedure within an application. As the procedure progresses, the rectangular progress bar gradually fills from left to right with the system highlight color.


Progress bar properties

264 - 390


Iris Version 3.0

Explanation of the Progress bar properties: Property Description

Appearance





















DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Max Specifies the upper limit of the range of possible positions.

265 - 390


Iris Version 3.0

Min Specifies the lower limit of the range of possible positions. Orientation Specifies whether the progress bar is oriented vertically or horizontally. Position Specifies the current position of the progress bar. Smooth Specifies whether the progress bar is smooth or segmented. Step Specifies the amount that Position increases

266 - 390


Iris Version 3.0

9.66 Radio button

A radio button (mostly used in a group) gives the user a set of exclusive options. In a group only one radio button can be selected. When a radio button is selected automatically the previous selected button will be unselected.


Radio button properties

267 - 390


Iris Version 3.0

Explanation of the Radio properties: Property Description

Appearance


Caption Returns or sets the text displayed in an object’s title bar or below an object’s icon. Color Returns or sets the background color of the component Ctl3D Returns or sets whether or not an object is painted at runtime with 3-D effects. Cursor Specifies the image used to represent the mouse pointer when it passes into the




















268 - 390


Iris Version 3.0

Anchors Specifies how the control is anchored to its parent. Use this property to ensure that a



Checked When set to true the default of the radio button is checked. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum





269 - 390


Iris Version 3.0

9.67 Radio group

The Radio group contains only radio buttons. All the Radio buttons placed in the Radio group are directly grouped. That means that only one of the radio buttons can be checked. When a button is checked all the other buttons within the group becomes unchecked.


Radio group properties

270 - 390


Iris Version 3.0

Explanation of the Radio group properties: Property Description

Appearance










Items To add Radio buttons to the Radio group. Each string will create a Radio button in the group.

271 - 390


Iris Version 3.0














Columns With this property the display of the radio buttons can be changed to two or more columns.

Example of display the radio buttons in two columns


DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. ItemIndex The representation of which button in currently active. If the Value is –1 there is

no button checked. When the value is 0 the button [Raster] is checked. Etc. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode

is checked, the object’s BiDiMode property is always equal to that of its parent. ParentCtl3D Determines where an object looks to determine if it should appear three-


272 - 390


Iris Version 3.0

9.68 Replace dialog

The Replace Dialog is a special version of Find Dialog that prompts the user for both a search string and a replace string. Like the Find Dialog, the Replace Dialog is modeless and does not appear at runtime until activated by a call to the Execute method.


Replace Dialog properties

Explanation of the Replace Dialog properties: Property Description

Appearance



Other FindText Contains the text string that the user wants to search for. Options Determines the appearance and behaviour of the Replace Dialog. ReplaceText Contains the text that should replace the text that’s in the property FindText.

273 - 390


Iris Version 3.0

The Replace Dialog:

274 - 390


Iris Version 3.0

9.69 Rich edit

The RichEdit object put’s a standard Windows rich text edit control on a form. Rich text edit controls let you enter text that includes variation in font attributes and paragraph formatting information.


Rich edit properties

275 - 390


Iris Version 3.0

Explanation of the Rich edit properties: Property Description

Appearance




property. When unchecked the control uses its own Color property. WordWrap Determines whether the edit control inserts soft carriage returns so text wraps at the

right margin. Behaviour


















276 - 390


Iris Version 3.0












DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. HideScrollBars Determines whether the scroll bars disappear when not needed. HideSelection Determines whether the visual indication of the selected text remains when focus

shifts to another object. Lines The text that will be shown in the memo box in lines. Pressing the three dots button in

the field will make the next screen appear.

MaxLength Specifies the maximum length of text, in characters that the Rich edit object can

contain. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is


This property determines whether the object uses its parent Ctl3D property. PlainText Controls whether the rich edit object treats the text as plain text or rich text when

streaming to or from a file.

277 - 390


Iris Version 3.0

ReadOnly Determines whether the user can change the text of the Rich edit object. Scrollbars Determines whether the Rich edit object has scroll bars.

ssNone: The control has no scroll bars. ssHorizontal: The control has a single scroll bar on the bottom edge. ssVertical: The control has a single scroll bar on the right edge. ssBoth: The control has a scroll bar on both the bottom and right edges.

WantReturns Set WantReturns to true to allow users to enter return characters into the text. WantTabs Set WantTabs to true to allow users to enter tab characters into the text.

278 - 390


Iris Version 3.0

9.70 Iris rocker

The Iris Rocker is a switch showing directly the status.


Iris rocker properties

279 - 390


Iris Version 3.0

Explanation of the Iris rocker properties: Property Description

Appearance



















Depth Defines the depth of the rocker. DragKind Specifies whether an object is being dragged normally of for docking. FocusColor Defines the color of the rocker when the rocker has focus. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. HighlightColor Defines the color for the part of the rocker that is highlighted. OutlineColor Defines the color for the border of the rocker. OutlineWidth Defines the width of the border of the rocker. ShadowColor Defines the shadow color of the rocker ShadowLightColor Defines the shadow color of the rocker for the part that is highlighted.

280 - 390


Iris Version 3.0

State Defines the state of the Rocker. Possibilities are Upperdown, LowerDown and None.

UpperDown

LowerDown

None Style Defines the style to be used for the Rocker to act when it is clicked on. Button means

that the when the rocker is clicked on, it is activated and stays activated until the mouse button is released. Switch means that the rocker will change from status every mouse click.


281 - 390


Iris Version 3.0

9.71 Rotary switch

The Rotary switch is a switch that allows more that 2 positions. The number of positions can be adapted as well as the complete layout of the switch.


Rotary switch properties

282 - 390


Iris Version 3.0

Explanation of the Rotary switch properties: Property Description

Appearance


covered by an object. Behaviour
















ButtonColor Defines the color of the button (default is Red). DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword.

283 - 390


Iris Version 3.0

LabelsOffset Defines the distance of the labels from the switch in pixels.

LabelOffset = 10

LabelOffset = 30

Radius Defines the Radius of the rotary switch in pixels. ShowLabel When set to true the labels will be shown on the rotary switch.

SwitchAngleEnd Defines the angel where the switch stops. SwitchAngleStart Defines the angel where the switch starts. SwitchColor Defines the color of the switch (default is silver). SwitchPosition Represents the current position of the switch. SwitchPositions The switch positions of the rotary switch. Pressing on the three dots button will cause

the following windows to appear.

The strings typed in this window are the labels of the positions.

Version Represents the version of the object. It has no functionality. WinchColor Defines the color of the winch (default is silver). WinchOffset Defines the width of the winch.

284 - 390


Iris Version 3.0

9.72 Save dialog

The Save Dialog displays a modal dialog box for selecting file names and saving files. The dialog does not appear at runtime until it is activated by a call to the Execute method. When the user clicks Save, the dialog closes and the selected file name is stored in the FileName property.


Save Dialog properties

Explanation of the Save Dialog properties: Property Description

Appearance



Other DefaultExt Specifies a default file extension. FileName Indicates the name and directory path of the last file selected. Filter Determines the file masks (filters) available in the dialog. E.g *.txt or *.bmp FilterIndex Determines which filter is selected by default when the dialog opens. InitialDir Determines the current directory when the dialog opens.

285 - 390


Iris Version 3.0


ofShowHidden: Includes in the display files marked as hidden. ofOverwritePrompt: Generates a warning message if the user tries to select a file name that is already in use, asking whether to overwrite the existing file. (Use with TSaveDialog and TSavePictureDialog.) ofNoChangeDir: After the user clicks OK, resets the current directory to whatever it was before the file-selection dialog opened. ofAllowMultiSelect: Allows users to select more than one file in the dialog. ofExtensionDifferent: This flag is turned on at runtime whenever the selected filename has an extension that differs from DefaultExt. If you use this flag in an application, remember to reset it. ofPathMustExist: Generates an error message if the user tries to select a file name with a nonexistent directory path. ofFileMustExist: Generates an error message if the user tries to select a nonexistent file. (only applies to Open dialogs). ofEnableSizing: Lets the dialog be resized with the mouse or keyboard. By default, the dialog allows this resizing regardless of the value of this option. It is only required if you provide a hook procedure or custom template. ofViewDetail: Includes in the files list attribute details about each file, like creation date and access privileges.

OptionsEx Prohibits a places bar (a bar which contains shortcuts to places like the History folder and the Desktop) from appearing in the dialog.

Title Specifies the title caption for the dialog box. The Save Dialog:

286 - 390


Iris Version 3.0

9.73 Save picture dialog

The Save Picture Dialog displays a modal Windows dialog box for selecting file names and saving graphics files. This component is just like TSaveDialog, except that it includes a rectangular preview region.


Save Picture Dialog properties

Explanation of the Save Picture Dialog properties: Property Description

Appearance



Other DefaultExt Specifies a default file extension. FileName Indicates the name and directory path of the last file selected. Filter Determines the file masks (filters) available in the dialog. E.g *.txt or *.bmp FilterIndex Determines which filter is selected by default when the dialog opens. InitialDir Determines the current directory when the dialog opens.

287 - 390


Iris Version 3.0


ofShowHidden: Includes in the display files marked as hidden. ofOverwritePrompt: Generates a warning message if the user tries to select a file name that is already in use, asking whether to overwrite the existing file. (Use with TSaveDialog and TSavePictureDialog.) ofNoChangeDir: After the user clicks OK, resets the current directory to whatever it was before the file-selection dialog opened. ofAllowMultiSelect: Allows users to select more than one file in the dialog. ofExtensionDifferent: This flag is turned on at runtime whenever the selected filename has an extension that differs from DefaultExt. If you use this flag in an application, remember to reset it. ofPathMustExist: Generates an error message if the user tries to select a file name with a nonexistent directory path. ofFileMustExist: Generates an error message if the user tries to select a nonexistent file. (only applies to Open dialogs). ofEnableSizing: Lets the dialog be resized with the mouse or keyboard. By default, the dialog allows this resizing regardless of the value of this option. It is only required if you provide a hook procedure or custom template. ofViewDetail: Includes in the files list attribute details about each file, like creation date and access privileges.

OptionsEx Prohibits a places bar (a bar which contains shortcuts to places like the History folder and the Desktop) from appearing in the dialog.

Title Specifies the title caption for the dialog box. The Save Picture Dialog:

288 - 390


Iris Version 3.0

9.74 Screen The screen is considered also an object within Iris and therefore has its own properties. Mostly the screen will be the parent of the different objects placed on the screen. The properties Font, Color and Hint are, as will be cleared with the following objects, properties that can be used to standardize a project.

Screen properties

289 - 390


Iris Version 3.0

Explanation of the screen properties: Property Description

Appearance









Hint Hint Returns or sets the text displayed when the mouse is paused over the control. ShowHint Determines if the control should display a hint when the mouse pointer rests








ActiveControl ActiveControl is the control that has focus on the form. AlphaBlend Specifies whether the form is translucent. AlphaBlendValue Specifies the degree of translucency on a translucent form. Anchors Specifies how the control is anchored to its parent. Use this property to ensure that


AutoScroll Specifies whether scroll bars appear automatically on the scrolling windowed control or not.


BorderIcons Set of values that specifies which icons appear on the title bar of the form

290 - 390


Iris Version 3.0

BorderStyle Returns or sets the border style for an object BorderWidth Specifies the distance, in pixels, between the outer- and inner bevels. Use


ClientHeigth Height of the control’s client area in pixels. ClientWidth Width of the control’s client area in pixels. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DefaultMonitor Specifies the monitor on which the form appears. dmDesktop: No attempt is made to position the form on a specific monitor. dmPrimary: The form is positioned on the first monitor listed in the global screen object’s Monitors property. dmMainForm: The form appears on the same monitor as the application’s main form. dmActiveForm: The form appears on the same monitor as the currently active form.

DockSite When checked the object can be a target of a drag-and-dock operation. DragKind Specifies whether an object is being dragged normally of for docking. FormStyle Set of values that represent the form’s style. HelpFile Specifies the name of the file that application uses to display help. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. HorzScrollBars An object that encapsulates the horizontal scroll bar for the scrolling windowed

control. Icon Returns the icon displayed when a form is minimized at run time. KeyPreview Returns or sets whether keyboard events for an object are invoked before keyboard

events for controls on that object/ Menu The form’s main menu. ObjectMenuItem OLE object menu item that reacts to selections of OLE objects. OldCreateOrder Specifies when OnCreate and OnDestroy events occur. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is

checked, the object’s BiDiMode property is always equal to that of its parent. PixelsPerInch Value that represents the proportion of the font on the system on which the form

was designed. Position Returns or sets a value specifying the position of a form when it first appears. PrintScale Value that represents the proportions of a printed form. Scaled Specifies whether the form is sized according to the value of the PixelsPerInch

property or not. TransparentColor Specifies whether a color on the form appears transparent. TransparentColorValue Indicates the color on the form that appears transparent when TransparentColor is

True. UseDockManager Specifies whether the docking manager is used in drag-and-dock operations. The


VertScrollBars An object that encapsulates the vertical scroll bar for the scrolling windowed control.

WindowMenu Window menu for an MDI parent form. WindowState Returns or sets the visual state of a form window at run time.

291 - 390


Iris Version 3.0

9.75 Scrollbar

With the scrollbar the user can scroll the contents of a window, panel or control box. Many objects are standard already equipped with a scrollbar.


Scroll bar properties

292 - 390


Iris Version 3.0

Explanation of the Scrollbar properties: Property Description

Appearance

Ctl3D Returns or sets whether or not an object is painted at runtime with 3-D effects. Cursor Specifies the image used to represent the mouse pointer when it passes into the




















DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword.

293 - 390


Iris Version 3.0

Kind Which kind of scrollbar, horizontal of vertical.

LargeChange Is the change of position when the user clicks on either side of the thumb. This

change will also apply when the user uses the PgDn or PgUp keys. Max Specifies the maximum position represented by the scrollbar. Min Specifies the minimum position represented by the scrollbar. PageSize Specifies the size of the thumb tab. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is

checked, the object’s BiDiMode property is always equal to that of its parent. ParentCtl3D Determines where an object looks to determine if it should appear three-


Position Indicates the current position of the scrollbar. SmallChange Represents the change of position when the user clicks on the small arrows on both

sides of the scrollbar. This change will also apply when the user uses the arrow keys on the keyboard.

294 - 390


Iris Version 3.0

9.76 Scroll box

The Scroll box represents a scrolling area (a scroll box) in a window. One use of a scroll box is to prevent areas of a window, such as a toolbar or status bar built with Panel objects, from scrolling.


Scroll box properties

295 - 390


Iris Version 3.0

Explanation of the Scroll box properties: Property Description

Appearance






















296 - 390


Iris Version 3.0

AutoScroll Indicates whether scroll bars appear automatically on the scrolling windowed object

if it is not large enough to display all of its objects. BevelEdges Specifies which edges of an object are bevelled. The BevelInner and BevelOuter




object with a three-dimensional look. BevelWidth Determines the width, in pixels, of both the inner- and outer bevel of an object. BiDiMode Specifies the bi-directional mode for an object. Use BidiMode to enable the object




DockSite When checked the object can be a target of a drag-and-dock operation. DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. HorzScrollBars An object that encapsulates the horizontal scroll bar for the scrolling windowed

control. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is

checked, the object’s BiDiMode property is always equal to that of its parent. ParentCtl3D Determines where an object looks to determine if it should appear three-


VertScrollBars An object that encapsulates the vertical scroll bar for the scrolling windowed control.

297 - 390


Iris Version 3.0

9.77 Shape

With the shape object it is possible to draw on a screen. The basic shape is a square but the properties can be adapted so that the shape becomes a line, rectangular, ellipse or circle.


Shape properties

298 - 390


Iris Version 3.0

Explanation of the Shape properties: Property Description

Appearance



dragged. Enabled Returns or sets a value that determines whether an object can respond to user-












Brush Defines the style and color of the fill of the shape. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Pen Defines the color and style of the line used to outline the shape. Shape Defines the shape of the object.

299 - 390


Iris Version 3.0

9.78 Speed button

Speed buttons a mostly used within a group of buttons like in toolbars. For the layout of the button a picture can be used although text is also possible.


Speed button properties

300 - 390


Iris Version 3.0

Explanation of the Speed button properties: Property Description

Appearance

Caption Returns or sets the text displayed in an object’s title bar or below an object’s icon. Color Returns or sets the background color of the component Flat Determines whether the borders of an object appear three-dimensional. Glyph Selects a picture to display within the Speed button.

Clicking on the three dots button in the field will make the Picture Editor appear.

Transparent When checked the background of the object is transparent. When unchecked the



generated events. GroupIndex Indicates the group of buttons. Buttons that have the same GroupIndex belong to

the same group. Visible Returns or sets a value that determines whether an object is visible or hidden.









301 - 390


Iris Version 3.0



Action Designates the action associated with the object. Actions allow an application to centralize the response to user commands. For creating actions, see the object Action list.

AllowAllUp When used in a group of buttons and the AllowAllUp property is set to true the button will act like radio buttons. So, when one button is selected all the other buttons will be unselected. The AllowAllUp works only when the GroupIndex is not 0.




Down Specifies whether the button is selected (down) or unselected (up). HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Layout Determines where the image or text appears on the speed button.

blGlyphLeft: The image or caption appears near the left side of the button. blGlyphRight: The image or caption appears near the right side of the button. blGlyphTop: The image or caption appears near the top of the button. blGlyphBottom: The image or caption appears near the bottom of the button.

Margin Specifies the number of pixels between the edge of the button and the image or caption drawn on its surface.

NumGlyphs A Speed button can have a maximum of 4 pictures. NumGlyph sets the number of pictures. Note that all the pictures must have the same size.


Spacing Determines where the image and text appear on a speed button.

302 - 390


Iris Version 3.0

9.79 Splitter

With the splitter function it is possible to resize at runtime controls like panels or group boxes. This makes it possible to have several controls in one panel of group box.

Basic layout when placed on a Panel.

Splitter properties

303 - 390


Iris Version 3.0

Explanation of the Splitter properties: Property Description

Appearance







Position Align Determines how an object aligns within its parent object. Use the align property to

align the object on the top, left, bottom or right of a parent (e.g. panel or page) and have it remain there even if the size of that parent changes.




Other AutoSnap When set to true the size of the splitter is adapted when the size of the panel is

changed. Beveled When set to true the splitter has a 3-D look. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. MinSize Specifies the minimum size, in pixels, of the panes on either side of the splitter. ResizeStyle There are several options to show the splitter when resizing a panel or group box.

None

Line

Update

Pattern

304 - 390


Iris Version 3.0

9.80 Static text

The StaticText is a windowed control that displays text on a form.

Static text properties

305 - 390


Iris Version 3.0

Explanation of the Static text properties: Property Description

Appearance






















306 - 390


Iris Version 3.0

BevelEdges Specifies which edges of an object are bevelled. The BevelInner and BevelOuter




object with a three-dimensional look. BiDiMode Specifies the bi-directional mode for an object. Use BidiMode to enable the object





checked, the object’s BiDiMode property is always equal to that of its parent. ShowAccelChar If ShowAccelChar is checked, an ampersand in the object’s Caption text appears as

an underline and makes the character after it into an accelerator key.

307 - 390


Iris Version 3.0

9.81 Status bar

The Status Bar object is a row of panels, usually aligned at the bottom of a form, that display information about an application as it runs

Basic layout when first placed on the screen. (at the bottom of the screen covering the whole width)

Static bar properties

308 - 390


Iris Version 3.0

Explanation of the Static bar properties: Property Description

Appearance





















AutoHint Specifies whether the status bar’s text is set automatically to the current hint. BiDiMode Specifies the bi-directional mode for an object. Use BidiMode to enable the object


309 - 390


Iris Version 3.0

BorderWidth Specifies the distance, in pixels, between the outer- and inner bevels. Use



DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Panels Lists the panels (StatusPanel objects) in the status bar. The Status Panel object is

discussed later on in this section. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is

checked, the object’s BiDiMode property is always equal to that of its parent. SimplePanel Determines whether the status bar displays a single panel or multiple panels. SimpleText Contains the string that is displayed in the status bar when SimplePanel is set to

True. SizeGrip Determines whether the status bar is resizable at runtime. UseSystemFont Specifies whether the status bar uses the system font.

The Status Panel objects: Pressing on the three dot button in the field of the Panels property on the status bar object will make the following screen appear.

Static Panel properties

310 - 390


Iris Version 3.0

Explanation of the String grid properties: Property Description

Appearance

Alignment Specifies how text is aligned within the status panel. taLeftJustify: Align text on the left side of the panel. taCenter: Center the text in the panel. taRightJustify: Align text on the right side of the panel.

Position Width Returns or sets the width of an object.

Other Bevel Determines the style of the panel’s border.

pbNone: The panel has no bevel and appears flat. pbLowered: The panel appears recessed. pbRaised: The panel appears raised.



Style Determines how the status panel’s text is displayed. Text Specifies the text appearing in the status panel.

311 - 390


Iris Version 3.0

9.82 String grid

The String Grid represents a grid object designed to simplify the handling of strings and associated objects. Use a String Grid object to present textual data in a tabular format.


String grid properties

312 - 390


Iris Version 3.0

Explanation of the String grid properties: Property Description

Appearance























313 - 390


Iris Version 3.0

BorderStyle Returns or sets the border style for an object. ColCount Specifies the number of columns in the grid. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DefaultColWidth Determines the width (in pixels) of all columns that have not been explicitly resized.

DefaultDrawing Determines whether the Cells are painted when the grid is drawn. DefaultRowHeigth Specifies the height (in pixels) of all rows that have not been explicitly resized. DragKind Specifies whether an object is being dragged normally of for docking. FixedColor Specifies the background color of the fixed rows and columns in the grid. FixedCols Specifies the number of columns on the left of the grid that cannot be scrolled. FixedRows Specifies the number of rows on the top of the grid that cannot be scrolled. GridLineWidth Specifies the width (in pixels) of the lines that separate the cells of the grid. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Options Specifies various display and behavioural properties of the grid.

goFixedVertLine: Vertical lines are drawn to separate the fixed (nonscrolling) columns in the grid. goFixedHorzLine: Horizontal lines are drawn to separate the fixed (nonscrolling) rows in the grid. goVertLine: Vertical lines are drawn to separate the scrollable columns in the grid. goHorzLine: Horizontal lines are drawn to separate the scrollable rows in the grid. goRangeSelect: Users can select ranges of cells at one time. goRangeSelect is ignored if Options includes goEditing. goDrawFocusSelected: Cells with input focus are drawn with a special highlight color, just like selected cells without input focus. If goDrawFocusSelected is not included, the cell with input focus is distinguished by a focus rectangle, not by a special background color. goRowSizing: Scrollable rows can be individually resized. goColSizing: Scrollable columns can be individually resized. goRowMoving: Scrollable rows can be moved using the mouse. goColMoving: Scrollable columns can be moved using the mouse. goEditing: Users can edit the contents of cells. When goEditing is included in Options, goRangeSelect has no effect. goTabs: Users can navigate through the cells in the grid using Tab and Shift+Tab. goRowSelect: Entire rows are selected rather than individual cells. If goRowSelect is included in Options, goAlwaysShowEditor has no effect. goAlwaysShowEditor: The grid is locked into edit mode. The user does not need to use Enter or F2 to turn on EditorMode. If Options does not include goEditing, goAlwaysShowEditor has no effect. If Options includes goRowSelect, goAlwaysShowEditor has no effect. goThumbTracking: The grid image updates while the user is dragging the thumb of the scrollbar. If goThumbTracking is not included, the image does not update until the user releases the thumb in a new position.



RowCount Specifies the number of rows in the grid. ScrollBars Returns or sets a value indicating whether an object has vertical or horizontal scroll

bars. VisibleColCount Indicates the number of scrollable columns visible in the grid. VisibleRowCount Indicates the number of scrollable rows visible in the grid.

314 - 390


Iris Version 3.0

9.83 Switch

The switch is a selector slide. The switch can have more than two positions whereby every position a value represents.


Switch properties

315 - 390


Iris Version 3.0

Explanation of the switch properties: Property Description

Appearance



















BackImageIndex The index of the Bitmaplist’s imagelist for the background of the switch. Bevel Specifies the bevel to be used on the switch borders. BitmapList Specifies the Imagelist for the background of the switch. BorderColor Specifies the color of the border of the switch. BorderWidth Specifies the width of the border of the switch. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DragKind Specifies whether an object is being dragged normally of for docking. FocusColor Specifies the color of the switch when it has focus.

316 - 390


Iris Version 3.0

HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Offset Indicated the status of the switch. When offset is 0 the switch is in his first position. Options Several options can be set for the Iris Switch; ActiveClick, MouseClip, HandPoint and

ThumpOpaque. Orientation Indicates the direction of the switch, vertical (default) or horizontal. Positions The number of positions possible for the switch. Style Specifies the direction style of the switch. ThumbImageIndex The index of the Thumb image of the switch. ThumbIndent Represents the position of the thump. ThumbStates Specifies the thumb state of the switch. Version Represents the version of the object. It has no functionality.

317 - 390


Iris Version 3.0

9.84 Tab control

The Tab Control is a control with multiple tab settings to a form. Unlike a page control, Tab Control is not made up of several pages that contain different objects. Instead, the Tab Control is a single object. When the current tab changes, the tab control must directly update its contents to reflect the change in an OnChange event handler.

Basic laytou when first placed on the screen.

Tab control properties

318 - 390


Iris Version 3.0

Explanation of the Tab control properties: Property Description

Appearance









MultiSelect Specifies whether multiple tabs can be selected. Font














319 - 390


Iris Version 3.0



DockSite When checked the object can be a target of a drag-and-dock operation. DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. HotTrack Determines whether labels on the tab under the mouse are automatically

highlighted. Images Specifies the images drawn in tabs. MultiLine Determines whether the tabs can appear on more than one row. OwnerDraw Specifies whether the tab control handles its own painting. ParentBiDiMode Specifies whether an object uses its parent’s BiDiMode. When ParentBiDiMode is

checked, the object’s BiDiMode property is always equal to that of its parent. RaggedRight Specifies whether rows of tabs stretch to fill the width of the object. ScrollOpposite Determines how the rows of tabs are scrolled in a muliline tab control. Style Specifies the style of the tab object. It can appear as notebook tabs or as buttons. TabHeigth Specifies the height, in pixels, of the tabs in the tab object. TabIndex Returns or sets the tab order of an object within its parent object. TabPosition Determines whether tabs appear at the top or bottom. TabWidth Specifies the horizontal size, in pixels, of the tabs in the tab object. Tabs Contains the list of text strings that label the tabs of the tab object.

320 - 390


Iris Version 3.0

9.85 Tabbed notebook

The Tabbed Notebook contains multiple pages, each with its own set of objects.


Tabbed Notebook properties

321 - 390


Iris Version 3.0

Explanation of the Tabbed Notebook properties: Property Description

Appearance
















Other ActivePage Determines which page displays in the tabbed notebook object. Anchors Specifies how the control is anchored to its parent. Use this property to ensure that



HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. TabIndex Returns or sets the tab order of an object within its parent control. Pages Contains the strings that identify the individual pages of the tabbed notebook

object. TabFont Returns the current value of font used on the tabs of the tabbed notebook. TabsPerRow Determines the number of tabs that can appear in a row at the top of the tabbed

notebook object.

322 - 390


Iris Version 3.0

9.86 Tab set

The Tab Set object presents horizontal tabs users can click to initiate actions. You create a set of tabs for the tab set object when you specify a list of strings as the value of the Tabs property. One tab is created for each string.


Tab set properties

323 - 390


Iris Version 3.0

Explanation of the Tab set properties: Property Description

Appearance







attributes and color. Misc











AutoScroll Determines if scroll buttons automatically appear in a tab set object if there isn’t room in the control to display all the tabs.

BackGroundColor Determines the background color of the tab set object. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DitherBackground Determines whether the background color set with the BackgroundColor property is dithered.

DragKind Specifies whether an object is being dragged normally of for docking. EndMargin Determines how far, in pixels, the rightmost tab appears from the right edge of the

tab set object. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword.

324 - 390


Iris Version 3.0

ParentBackground Specifies whether the object’s backgroundcolor is of its parent control. SelectedColor Determines the color of the selected tab in the tab set object. StartMargin Determines how far, in pixels, the first tab appears from the left edge of the tab set

object. Style Determines whether the tab set is owner-drawn.

tsStandard: Each tab has the standard size and look. tsOwnerDraw: Each tab has the height specified with the TabHeight property and width needed to hold the text or glyph.

TabHeigth Determines the height of the tabs in an owner-drawn tab set object. TabIndex Returns or sets the tab order of an object within its parent control. Tabs Contains the list of text strings that appear on the tabs. UnselectedColor Determines the color of the tabs that aren’t currently selected in the tab set object. VisibleTabs Contains the number of tabs currently visible in the tab set object.

325 - 390


Iris Version 3.0

9.87 Tank

Graphical representation of the status of a tank. The fill of the tank depends on the value of a Tag. The format as well as the colors of the tank can be completely adapted.


Tank properties

326 - 390


Iris Version 3.0

Explanation of the Iris Tank specific properties: Property Description

Appearance


















Container The appearance of the tank. DragKind Specifies whether an object is being dragged normally of for docking. EmptyColor The Color of the empty part of the tank. FillColor The Color of the filled part of the tank. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Max Specifies the maximum of the Tank object. Min Specifies the minimum of the Tank object. Position Represents the percentage of the filling of the tank.

327 - 390


Iris Version 3.0

Shape The shape of the tank can be adapted:

Triangle

Ellipse

Rectangular with

rounded edges

Rectangular


328 - 390


Iris Version 3.0

9.88 Timer

The timer object is a simple trigger object with a selectable interval. You can use the timer for all objects in the application. The interval property determines how often the timer’s OnTimer event occurs.


Timer properties

Explanation of the Timer properties: Property Description

Behaviour


Misc Name Returns or sets the name used in code to identify an object. Tag Stores any extra data needed for your program.

Other Interval Determines the amount of time, in milliseconds, that passes vefore the timer

component initiates another OnTimer event.

329 - 390


Iris Version 3.0

9.89 Toolbar

The Toolbar manages tool buttons and other objects, arranging them in rows and automatically adjusting their sizes and positions. It provides an easy way to arrange and manage visual objects.

Basic layout when first placed on the screen. (on top of the screen covering the whole width)

Toolbar properties

330 - 390


Iris Version 3.0

Explanation of the Toolbar properties: Property Description

Appearance


covered by an object. Flat Determines whether the borders of an object appear three-dimensional. ParentColor To have a control use the same color as its parent control, check the ParentColor




















331 - 390


Iris Version 3.0




ButtonHeigth Specifies the height of the objects in the toolbar. ButtonWidth Specifies the width of the tool buttons in the toolbar. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


Customizable Determines whether the Toobar could be customized. DisabledImages Lists the images that can appear on disabled tool buttons. DockSite When checked the object can be a target of a drag-and-dock operation. DragKind Specifies whether an object is being dragged normally of for docking. EdgesBorders Determines which sides of the toolbar have borders. EdgeInner Determines the border style for the toolbar's inner edge. EdgeOuter Determines the border style for the toolbar's outer edge. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. HotImages Lists the images that can appear on tool buttons when the mouse points to them. Images Lists the images that can appear on tool buttons. Images in the list should be 16x16.

To accommodate every system on which your application runs, it is recommended that you do not use 256 colors.

Indent Specifies the margin on the left side of the toolbar. List Aligns captions on the right and images on the left in tool buttons. Menu Specifies the main menu for the toolbar. ShowCaptions Determines whether text captions are displayed on tool buttons. Wrapable Enables automatic line-wrap for components in the toolbar.

332 - 390


Iris Version 3.0

9.90 Track bar

A track bar represents a position along a continuum using a slider and, optionally, tick marks. A track bar can also display a selected range marked by triangular ticks at the starting and ending positions of the selection.


Track bar properties

333 - 390


Iris Version 3.0

Explanation of the Track bar properties: Property Description

Appearance

Ctl3D Returns or sets whether or not an object is painted at runtime with 3-D effects. Cursor Specifies the image used to represent the mouse pointer when it passes into the region




















DragKind Specifies whether an object is being dragged normally of for docking. Frequency Specifies the increment between tick marks on the track bar. HelpKeyword Specifies the keyword for an object’s help topic.

334 - 390


Iris Version 3.0

HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. LineSize Indicates the amount the value of Position changes when the user presses the arrow

keys. Max Specifies the maximum position of a Track bar. Min Specifies the minimum position of a Track bar. Orientation Specifies whether the track bar is horizontal or vertical.

tbHorizontal: The long edge of the track is parallel to the top of the form. The Min position is on the left and the Max position is on the right. tbVertical: The long edge of the track is parallel to the side of the form. The Min position is on the top and the Max position is on the bottom.

PageSize Specifies the amount Position is changed when the PageUp or PageDown key is pressed, or when the bar is clicked.


Position Contains the current position of the slider of a Track bar. SelEnd Contains the current position of the slider of a Track bar. SelStart Specifies the position of the starting point of the selection range. SliderVisible Specifies whether the track bar’s slider is visible. ThumbLength Specifies the length of the track bar’s slider. TickMarks Specifies the location of the tick marks.

tmBottomRight: Tick marks are on the bottom or right of the track bar, depending of the value of Orientation. tmTopLeft: Tick marks are on the top or left of the track bar, depending of the value of Orientation. tmBoth: Tick marks are on both sides of the track bar.

TickStyle Specifies how tick marks are placed on the track bar. tsAuto: Tick marks are automatically displayed at increments equal to the value of the Frequency property. tsManual: Tick marks are displayed at the Min and Max values. Additional tick marks can be set using the SetTick method. tsNone: No tick marks are displayed.

335 - 390


Iris Version 3.0

9.91 Iris Track bar

A track bar represents a position along a continuum using a slider and, optionally, tick marks. A track bar can also display a selected range marked by triangular ticks at the starting and ending positions of the selection.


Track bar properties

336 - 390


Iris Version 3.0

Explanation of the Iris Track bar properties: Property Description

Appearance



















BackImageIndex The index of the Bitmaplist’s imagelist for the background of the Track bar. BitmapList Specifies the Imagelist for the background of the Track bar. BorderWidth Specifies the distance, in pixels, between the outer- and inner bevels. Use




337 - 390


Iris Version 3.0

Frequency Specifies the increment between tick marks on the track bar. GutterBevel Specifies the bevel of the gutter on the track bar GutterColor Specifies the color of the gutter on the track bar GutterWidth Specifies the width, in pixels, of the gutter on the track bar HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. LineSize Indicates the amount the value of Position changes when the user presses the arrow

keys. MaxValue Specifies the maximum value of a Track bar. MinValue Specifies the minimum value of a Track bar. Options Speficies some options for the track bar e.q. the appearance of the mouse on the track

bar. Orientation Specifies whether the track bar is horizontal or vertical.

TbHorizontal: The long edge of the track is parallel to the top of the form. The Min position is on the left and the Max position is on the right. TbVertical: The long edge of the track is parallel to the side of the form. The Min position is on the top and the Max position is on the bottom.

ScaleOffset Defines the offset, in pixels, between the scale and the gutter of the track bar. Style Specifies the direction of the trackbar in eather horizontal or vertical orientation. ThumbImageIndex The index of the Thumb image of the Track bar. ThumbStates Specifies the thumb state of the switch. TickColor Specifies the color of the ticks on the track bar. TickMarks Specifies the location of the tick marks.

tmBottomRight: Tick marks are on the bottom or right of the track bar, depending of the value of Orientation. tmTopLeft: Tick marks are on the top or left of the track bar, depending of the value of Orientation. tmBoth: Tick marks are on both sides of the track bar.


338 - 390


Iris Version 3.0

9.92 Tree view

The Tree View object represents a window that displays a hierarchical list of items, such as the headings in a document, the entries in an index, or the files and directories on a disk.


Tree view properties

339 - 390


Iris Version 3.0

Explanation of the Tree view properties: Property Description

Appearance







TabOrder Indicates the position of the object in its parent’s tab order. It’s the order in which the child windows are visited when the user presses the Tab key. The object that has focus has a TabOrder value of 0. Initially, the tab order is always the order on which the objects were added to a form.



Items Lists the individual nodes that appear in the tree view object. MultiSelect When set to true and ExtendedSelect is set to false the user can select several item

(without using the Shift- or Ctrl-key). Font



Help Context Specifies the default help file context ID for an object. Name Returns or sets the name used in code to identify an object. PopupMenu Identifies the pop-up menu associated with the control. Tag Stores any extra data needed for your program.








340 - 390


Iris Version 3.0

Other


AutoExpand Specifies whether the nodes in the tree view automatically expand and collapse depending on the selection.









ChangeDelay Specifies the delay between when a node is selected and when the OnChange event occurs.


DragKind Specifies whether an object is being dragged normally of for docking. HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. HideSelection Determines whether the list view gives a visual indication of which item is selected

when focus shifts to another object. HotTrack Specifies whether list items are highlighted when the mouse passes over them. Images Refers to image list associated with the view. Indent Specifies the amount of indentation in pixels when a list of child nodes is expanded. MultiSelectStyle Determines how multiple node selections work.

msControlSelect: Clicking on any node with the Control key pressed toggles the selection of that node. msShiftSelect: Clicking on any node with the Shift key press selects that node, the last single node selected, and the nodes in between. All other nodes are deselected. msVisibleOnly: Multiple selections with the Shift key do not include child nodes of collapsed nodes. msSiblingOnly: Selected nodes are restricted to a single set of siblings.



ReadOnly Determines whether the user can edit the node labels. RightClickSelect Determines whether the Selected property returns nodes that are selected using the

right mouse button. RowSelect Determines whether selection is by row. ShowButtons Specifies whether to display plus (+) and minus (-) buttons to the left side of each

parent item. ShowLines Specifies whether to display the lines that link child nodes to their corresponding

parent nodes.

341 - 390


Iris Version 3.0

ShowRoot Specifies whether lines connecting top-level nodes are displayed. SortType Determines if and how the nodes in a tree view are automatically sorted.

stNone: No sorting is done. stData: The items are sorted when the Data object or SortType is changed. stText: The items are sorted when the Caption or SortType is changed. stBoth: The items are sorted when either the Data object, the Caption or SortType is changed

StateImages Determines which image list to use for state images. ToolTips Specifies whether the items in the tree view have tooltips.

342 - 390


Iris Version 3.0

9.93 UpDown

The Up-Down object consists of a pair of arrow buttons, such as the arrows that appear in a spin box. Up-down controls allow users to change the size of a numerical value by clicking on arrow buttons.


UpDown properties

343 - 390


Iris Version 3.0

Explanation of the UpDown properties: Property Description

Appearance














Other AlignButton Specifies the position of the up-down object relative to its companion object.

udLeft: Position the up-down control on the left edge of the companion control. udRight: Position the up-down control on the right edge of the companion control.


ArrowKeys Determines whether the up-down object receives input from the Up arrow and Down arrow keys.

Associate Specifies a companion control for the up-down object. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. Increment Specifies the amount the position value changes each time the up or down button is

pressed. Max Specifies the maximum value of the Position property. Min Specifies the minimum value of the Position property.

344 - 390


Iris Version 3.0

Orientation Specifies the direction that the arrow keys point.

udHorizontal: The arrow buttons point to the left and right, and appear side by side. udVertical: The arrow buttons point up and down and are stacked vertically.

Position Specifies the current value represented by the up-down object. Thousands Determines whether a thousands separator appears between every three digits of a

decimal string. Wrap Specifies how the up-down object handles attempts to exceed the value of Max or

Min.

345 - 390


Iris Version 3.0

9.94 User led

The Iris led works like a normal LED. Depending on the value of a Tag the LED will be active of inactive. The colors of the LED can be adapted. There are two colors for each status (High1, High2 / Low1, Low2)


User led properties

346 - 390


Iris Version 3.0

Explanation of the User Led properties: Property Description

Appearance













Other Active Represents the status of the LED. ActiveTag Specifies the Tag from which the object gets its actual value. The tag is specified

using the Tag selector function as described earlier in this chapter. Anchors Specifies how the control is anchored to its parent. Use this property to ensure that a


Bevel Specifies the bevel appearance on the User led. Constraints Specifies the constraints of an object. Use it to specify the minimum and maximum


DragKind Specifies whether an object is being dragged normally of for docking. DragStyle Specifies the style for dragging the user led HelpKeyword Specifies the keyword for an object’s help topic. HelpType Specifies whether the object’s help topic identifies by ID or by Keyword. OutlineColor The color of the border of the LED. OutlineWidth The width of the border of the LED. PaletteEx The representation of the LED.

347 - 390


Iris Version 3.0

10 Events With Iris you are programming event-driven, the user events are a key part of the application. User events correspond to the objects in the graphical interface. Most objects contain an OnClick event that can be programmed to respond when the user clicks the object. Other events, such as OnActivate are not triggered by the user, but by the application. The code you write to respond to events is called an event handler. All the events handlers are categorized in the following topics:

• Keyboard; • Mouse; • DragDrop; • Behaviour; • Others.

This chapter describes the possible events that are used within Iris.

348 - 390


Iris Version 3.0

10.1 Keyboard events Keyboard events are events that the user makes with the keyboard. The following table shows all possible keyboard events. Event Description

Keyboard

OnKeyDown Occurs when a user presses any key while the object has focus.

OnKeyPress Occurs when key pressed.

OnKeyUp Occurs when the user releases a key that has been pressed.

349 - 390


Iris Version 3.0

10.2 Mouse events Mouse events are events that the user makes with the mouse. The following table shows all possible mouse events. Event Description

Mouse

OnClick Occurs when the user clicks an object. Use the OnClick event handler to respond when the user clicks the object. Usually OnClick occurs when the user presses and releases the left mouse button with the mouse pointer over the control. This event can also occur when:

• The user selects an item in a grid, outline, list, or combo box by pressing an arrow key.

• The user presses Spacebar while a button or check box has focus. • The user presses Enter when the active form has a default button (specified

by the Default property). • The user presses Esc when the active form has a cancel button (specified by

the Cancel property). • The user presses the accelerator key for a button or check box. For example,

if the value of the Caption property of a check box is '&Bold', the B is underlined at runtime and the OnClick event of the check box is triggered when the user presses Alt+B.

• The Checked property of a radio button is set to True • The value of the checked property of a check box is changed. • The Click method of a menu item is called.

For a form, an OnClick event occurs when the user clicks a blank area of the form or on a disabled component.

OnDblClick Occurs when the user double-clicks the left mouse button when the mouse pointer is over the object.

OnMouseDown Occurs when the user presses a mouse button with the mouse pointer over an object.

OnMouseMove Occurs when the user moves the mouse pointer while the mouse pointer is over an Object.

OnMouseUp Occurs when the user releases a mouse button that was pressed with the mouse pointer over a object.

350 - 390


Iris Version 3.0

10.3 DragDrop events DragDrop events are events that the user makes with the mouse. The following table shows all possible DragDrop events. Event Description

DragDrop

OnDragDrop Occurs when the user drops an object being dragged.

OnDragOver Occurs when the user drags an object over a control.

OnEndDrag Occurs when the dragging of an object ends, either by dropping the object or by canceling the dragging.

OnStartDrag Occurs when the user begins to drag the object it contains by left-clicking on the object and holding the mouse button down.

351 - 390


Iris Version 3.0

10.4 Behaviour events Behaviour events are events that the user makes on an object. The following table shows all possible Behaviour events. Event Description

Behaviour

OnEnter Occurs when an object receives the input focus. The OnEnter event does not occur hen switching between forms or between applications. When switching between objects in separate container objects such as the Panel or Groupbox objects, an OnEnter event occurs for the container before the OnEnter event of the contained object.

OnExit Occurs when the input focus shifts away from one control to another. The OnExit event does not occur when switching between forms or between another application and your application. When switching between controls in separate container controls such as the Panel and the Groupbox objects, an OnExit event occurs for the control inside the container before the OnExit event of the container.

352 - 390


Iris Version 3.0

10.5 Other events Other events are events that are specific to an object. The following table shows all other events. Event Description

Other

OnActivate Application Occurs when the application becomes active. An Application becomes active when it is initially run or when focus moves from another application back to any window of the application. Form Occurs when the form becomes active. A form becomes active when focus is transferred to it (when the user clicks on the form, for example).

OnCanResize Occurs when an attempt is made to resize an object.

OnClose Occurs when a form or dialog closes.

OnCloseQuery Occurs when the Close method is called or when the user chooses Close from the form's System menu.

OnConstrainedResize Adjust resize constraints.

OnContextPopup Occurs when the user right-clicks the control or otherwise invokes the popup menu (such as using the keyboard).

OnCreate Occurs when the form is created.

OnDeactivate Occurs when an application or a form becomes inactive.

OnDestroy Occurs when the form is destroyed.

OnDockDrop Occurs when another control is docked to the control.

OnDockOver Occurs when another control is dragged over the control.

OnEndDock Occurs when the dragging of an object ends, either by docking the object or by cancelling the dragging.

OnGetSiteInfo Returns the control’s docking information. It only occurs only if the property DockSite is True.

OnHelp Occurs when the form or application receives a request for help. HelpType property indicates whether the help topic is identified by context ID or by keyword. HelpContext property identifies the help topic to display when HelpType is htContext. HelpKeyword property identifies the help topic to display when HelpType is htKeyword. HelpFile property identifies the help file that contains the specified topic.

353 - 390


Iris Version 3.0

OnHide Occurs when the form is hidden (that is, when its Visible property is set to False).

OnMouseWheel Occurs when the mouse wheel is rotated.

OnMouseWheelDown Occurs when the mouse wheel is rotated downward.

OnMouseWheelUp Occurs when the mouse wheel is rotated upward.

OnPaint Occurs when an object is redrawn, e.g. a form or paint box.

OnResize Occurs immediately after the object is resized.

OnShortCut Occurs when the user presses a key (before the OnKeyDown event).

OnShow Occurs when the form, dialog, menu item or tab sheet is shown (that is, when its

Visible property is set to True).

OnStartDock Occurs when the user begins to drag a object with a the property DragKind of dkDock.

OnUnDock Occurs when the application tries to undock an object that is docked to the windowed control.

OnUserChange Occurs when the user change the state of the control.

354 - 390


Iris Version 3.0

10.6 Example This example will show how to program an event. We want to program a button that will start to move an object over the screen and we want to program a button that will stop the object of moving over the screen. The object will move every second 10 pixels to the left of the screen. After reaching the left position of 500 (= 500 pixels from the left size of the screen) the object will start at position 0 again. To do this we first have to put al the object we need to the screen. That are two Buttons, a timer and an object to move, we will use for that an Image. Now we select the timer and configure it. The only property we have to configure for the timer is the interval. In our case we need to enter 1000 while the interval time is in ms. Then we will go to the Event tab of the timer and double click on the OnTimer event. This will open the window where we can program our Event handler (code). We program the code as follows. Code for OnTimer event

begin Image1.left:=Image1.left+10; if image1.left>500 then image1.left:=0 end; Where Image1 is the name of the image we want to move. The first line in the code will add every OnTimer event 10 pixels to the left position of Image1. The second line will check every OnTimer event if the left position is greater than 500. If so, he will make the left position 0. For the button we do the following: The Caption property of one button we call “Start”, the Caption property of the other we call “Stop”. We program the following code behind the OnClick event of the buttons. Code for OnClick events of the buttons

Button Start begin Timer1.enabled:=true; end; Button Stop begin Timer1.enabled:=false; end;

355 - 390


Iris Version 3.0

Clicking on the Start button will enable the timer and clicking on the Stop button will disable the timer. After programming these codes the windows will look as follows.

When executing the program the image will start moving to the left when the button “Start” is pressed, the image will move completely to the left when he reaches the 500 pixels position and will stop moving is the “Stop” button is pressed.

The language in which the code is written is the Pascal Language. Detailed information about the Pascal language you’ll find in Appendix A of this manual.

356 - 390


Iris Version 3.0

10.7 Special Iris statements This section will discuss the special Iris statement used in the code for the event handlers. The statements are used for controlling the application.

10.7.1 ChangePage(‘PageName’) With this command there can be changed to a defined page within the application. Example:

ChangePage(‘Page1’) The application will change to Page1.

10.7.2 CloseWindow() With this command the active window will be closed. It is often used to close pop-up windows.

CloseWindow()

10.7.3 Popup(‘PopupName’) This command will call up a pop-up screen. Example:

Popup(‘Limits’) When this code is applied to for example a button, the button will call up the pop-up screen ‘InputLimits’.

357 - 390


Iris Version 3.0

11 Alarming In this chapter alarming is discussed. The chapter will discuss the setup of Alarm groups and Alarm blocks and how to link specific points to alarms.

11.1 Alarm groups Iris gives the possibility to create alarm groups. An alarm group is a definition of how an alarm will appear for a certain group of inputs. For instance, you can make an alarm group for the alarms that deal with a certain part of the process and another alarm group for another part of the process. In this way the operator can easily notice in which area of the process an alarm occurs. To create an alarm group you click on the application in the tree panel and click on the right mouse button. Go to the [Insert] option and choose the option [Alarm Groups]. A unique name is asked for the alarm group item.

After this you can insert an alarm group within the alarm group item in the same way.

358 - 390


Iris Version 3.0

After the alarm group is created the settings for the alarm group can be made in the detail panel. The next pictures show the available settings for the alarm groups.

11.1.1 General The following picture shows the General tab within the Detail panel when an alarm group is selected. Within this tab you can make the general setting for the alarm group.


Definition

Description A brief description of the alarm group. Name Defines the name of the alarm group to be used in the Application Editor. DisplayName The name of the alarmgroup which will be displayed in the column Alarmgroup

within the Alarm grid panel. Behaviour

Auto Remove When checked the alarms will be removed from the alarm grid panel automatically. Auto Acknowledge When checked the alarms will be acknowledged automatically.

359 - 390


Iris Version 3.0

11.1.2 Screen Colors The following picture shows the Screen Colors tab within the Detail panel when an alarm group is selected. Within this tab you can make settings on how the alarms for this alarm group will appear in the alarm grid panel.

The following table explains the different options within the Screen Colors tab. Screen Colors Description

Screen colors

Hot Defines the colors for the Hot alarms. Cold Defines the colors for the Cold alarms. Ack Hot Defines the colors for the Acknowledged Hot alarms. Ack Cold Defines the colors for the Acknowledged Cold alarms. Foreground color Defines the foreground color of the line. Background color Defines the background color of the line.

360 - 390


Iris Version 3.0

Flash Pattern Defines the flash pattern to be used for the line. Available patterns are:

Fast Flash ForeColor: The foreground color will flash fast. Fast Flash BackColor: The background color will flash fast Fast Swap ForeColor: The foreground color will be swapped fast with the background color Fast Swap BackColor: The background color will be swapped fast with the foreground color Fast Reverse Colors: The background and foreground colors will swap fast. Med Flash ForeColor: The foreground color will flash medium. Med Flash BackColor: The background color will flash medium. Med Swap ForeColor: The foreground color will be swapped medium with the background color Med Swap BackColor: The background color will be swapped fast with the foreground color Med Reverse Colors: The background and foreground colors will swap medium. Slow Flash ForeColor: The foreground color will flash slowly. Slow Flash BackColor: The background color will flash slowly. Slow Swap ForeColor: The foreground color will be swapped slow with the background color Slow Swap BackColor: The background color will be swapped fast with the foreground color Slow Reverse Colors: The background and foreground colors will swap slowly.

11.1.3 Printer Settings The following picture shows the Printer settings tab within the Detail panel when an alarm group is selected. Within this tab you can make settings for printing the alarms. Iris will use the default printer of the system to print the alarms.

361 - 390


Iris Version 3.0

The following table explains the different options within the Printer Settings tab. Printer Settings Description

Printer Settings

Print Hot Events When checked all the Hot alarms will be printed. Print Cold Events When checked all the Cold alarms will be printed. Print Ack Events When checked all the Acknowledged alarms will be printed. Line Color Defines the line color for the different events to be printed. You can choose a color by

using the dropdown list of by opening the color palette by clicking on the three dot button.

Iris will collect all to be printed lines and will print a page when it is full with lines.

362 - 390


Iris Version 3.0

11.2 Alarm blocks With an alarm block you can define the actual alarms. The locations from which the alarm gets its data from, the description of the alarms and to which locations iris should write acknowledged data to. An alarm block can have a maximum of 100 words; this means a total of 1600 alarms within one alarm block. To create an alarm block you click on the application in the tree panel and click on the right mouse button. Go to the [Insert] option and choose the option [Alarm Blocks]. A unique name is asked for the alarm block item.

After this you can insert an alarm block within the alarm block item in the same way.

After the alarm block is created the settings for the alarm block can be made in the detail panel. The next pictures show the available settings for the alarm blocks.

363 - 390


Iris Version 3.0

11.2.1 Block Settings The following picture shows the Block settings tab within the Detail panel when an alarm block is selected. Within this tab you can make the settings for the device from which the data comes from and the alarm area’s.

The following table explains the different options within the Block Settings tab. Block Settings Description

Device Base Settings

Description A brief description of the alarm block. BlockSize Defines the size, in words, of the alarm block.

Data References Device Defines the device defined under the device drivers from which the alarms gets the

data. Interval Defines the update time for the alarms. Alarm Area Defines the first address within the device form which the alarm block will start. Ack Read Area Defines the first address within the device from which iris will read his acknowledged

data. Ack Write Area Defines the first address within the device to which iris will write his acknowledged

data.

364 - 390


Iris Version 3.0

11.2.2 Alarm Definitions The following picture shows the Alarm Definitions tab within the Detail panel when an alarm block is selected. Within this tab you can define the actual alarms.

The following table explains the different options within the Alarm Definitions tab. Alarm Definitions Description

Alarm bit Shows the bit to be used for the alarm. When on the Block Settings an Alarm area is

defined the alarm bit will be shown including the actual address in the device. The following picture shows an example of this using address 400001.

Alarm Group Within this field the alarm group is defined to which the specific alarm should be linked.

Message Within this field the actual alarm text for the specific alarm is entered.

365 - 390


Iris Version 3.0

11.3 Value alarms When you define an Alarm block, you define a certain group of bits within the device that will control the alarms. It’s also possible to connect an alarm directly to a point within the application. Those alarms are called ‘value alarms’; it’s related to the value of that point. To define a value alarm for a point you have to fill out the Alarms tab in the detail panel when a point is selected.

The following table explains the different options within the alarms tab. Alarms Description

Definition

Message The message to be shown in the alarm grid panel. Group Defines the alarm group to which the alarm belongs. Deadband Defines the deadband to be used to on the point in relation to the alarm message.

Alarm Limits High-High Defines the value for the High-High alarm state. This value can be a constant value of

aother point. Using the three-dot button in the field you can select a point defined in the application.

High Defines the value for the High alarm state. This value can be a constant value of aother point. Using the three-dot button in the field you can select a point defined in the application.

Low Defines the value for the Low alarm state. This value can be a constant value of aother point. Using the three-dot button in the field you can select a point defined in the application.

Low-Low Defines the value for the Low-Low alarm state. This value can be a constant value of aother point. Using the three-dot button in the field you can select a point defined in the application.

366 - 390


Iris Version 3.0

11.4 Alarm grid panel The alarm grid panel is used to make the alarms visible in an application. The panel can be placed on a screen and can be adapted to the needs of the user. It is also possible to place more than one panel on one screen and it is also possible to place the alarm grid panel on more than on screen. By using the filtering functions of the panel one can make a very clear overview of the alarms showing only the alarms that have to be visible for a certain part of the process.

The following table explains the meanings of the different columns within the Alarm grid panel. When a column is not needed in an application it can be switched off within the Object Inspector of the Alarm grid panel. Alarm panel columns Description

Ack Shows a Check box to acknowledge an alarm. HotTime Shows the time when the alarm becomes active. ColdTime Shows the time when the related value (both bit and value) of the alarm becomes

‘normal’ again. AckTime Shows the time when the alarm was acknowledged. AlarmGroup Shows the name of the alarmgroup to which the alarm belongs to. Priority Shows the priority of the alarm. Message Shows the message of the alarm.

367 - 390


Iris Version 3.0

The following picture shows an Alarm grid panel in runtime.

368 - 390


Iris Version 3.0

12 Trending In this chapter the trend function of Iris is discussed. Iris offers a very powerful trend function offering a huge amount of graphical styles in 2D and 3D, multi axis operation and printing and exporting possibilities. For the trend function the object Iris Chart is used which is described in the chapter 9 Objects.

12.1 Trend Designer The Trend Designer will appear when you double click on the Iris Chart object when it is placed on a screen. The Trend Designer is used to generate very quickly the trend object into an application; only standard settings for the trend object can be made. The following screen shows the Trend Designer.

Trend Designer Description

Orientation Defines the orientation of the chart. Time Span Defines the total span time of the chart. The format to be used is hh:mm. 3D Style When checked the chart will be displayed in 3D style.

369 - 390


Iris Version 3.0

Add Plot Line Adds a Plot Line to the chart. The following picture shows an example of a Plot Line

in 3D style.

Add Plot Bars Adds a Plot Bars to the chart. The following picture shows an example of a Plot Bars

in 3D style.

Add Plot Area Adds a Plot Area to the chart. The following picture shows an example of a Plot Area

in 3D style.

Extended The Extended button will make the Iris Chart Editor appear. Within the Iris Chart

Editor you can make very detailed settings for the chart, like changing axis, colors, plot styles, grid settings, etc… The Iris Chart Editer is discussed in the Chapter Objects.

370 - 390


Iris Version 3.0

When you have chosen a Plot style, a series is added in the Trend Designer. You can use the combobox behind the series to select a numerical point that should be displayed in the chart.

371 - 390


Iris Version 3.0

12.2 The Chart Editor Because the Iris Chart is a complex object it is available with a Chart Editor. The Chart Editor makes it a lot easier to define and edit charts. The Chart Editor can be called at Runtime by double clicking on the Iris Chart. The following screen shows the Chart Editor.

372 - 390


Iris Version 3.0

12.2.1 The Chart tab Within this tab the general chart parameters are defined. The parameter can be changed before, during or after series has been added. The Chart tab has the following sections.

. Series tab Here are the series defined to be used in the chart

Un-checking a series in the series tab will remove the series from that specific chart.

By clicking on the [Add…] button the Chart gallery will appear. Here can the user select the type of chart that will be used for the series.

373 - 390


Iris Version 3.0

General tab This tab allows general settings for Printing, Zooming and Scrolling.

Axis tab All the parameters for the Axes can be set in this tab. Some parameters depend on the type of series connected to the axis.

Titles tab Settings for the Title and Footer for the Iris Chart.

Legend tab Within this tab settings can be made for displaying a legend for the Iris Chart. Very useful when more than one series is displayed in one chart.

374 - 390


Iris Version 3.0

Panel tab In this tab the settings of the panel wherein the Iris Chart is displayed can be changed.

Paging tab The number of point per chart page can be defined in this tab.

Walls tab Within this tab the walls of the chart can be defined.

3D The 3D settings for the chart can be done within this tab.

375 - 390


Iris Version 3.0

12.2.2 The series tab Within this tab the Series parameters are defined. The Combobox on top of the page shows the series that will be editing. With the pull-down list all the series defined in the chart tab canbe selected for editing. The Series tab has the following sections.

Format tab This tab specifies series specific parameters for formatting the series.

Point tab Within this tab it is possible to specify if the series should have points and which type of point should be used.

376 - 390


Iris Version 3.0

General tab Within the general tab its specified on which axes the series is associated to and in which format the values of the series will be displayed. On the right-bottom corner the Tag (TrendDef) can be specified to which series is associated with.

Marks tab This tap defines if the series should show marks. The format of the marks can be adapted through several parameters.

Data Source tab Selects the type of data source.

377 - 390


Iris Version 3.0

12.2.3 The data tab The Data tab shows values of the defined series within the chart. The values can be manipulated manually to ‘test’ a series.

12.2.4 The tools tab In this tab the user can select different tools for working with the chart.

Clicking on the [Add…] button will make the following screen appear. In this screen the different tools can be selected.

378 - 390


Iris Version 3.0

12.2.5 The export tab The Export tab gives the user the possibility to export a chart in picture form of in data form. The picture or data can be copied to the clipboard, saved in a file of send directly with e-mail. Picture tab Export of the chart in picture form. The user can select if he want to export to a Metafile or to a bitmap.

Native tab The chart can also be saved of send as a chart native file.

Data tab The export of the chart data. Different formats can be selected as a file.

379 - 390


Iris Version 3.0

12.2.6 The print tab In this tab the user can directly print the chart graphically to a selected printer.

Example: The next figure shows an example of a Chart.

LT 3254 LT 3261 PT 33282

10095908580757065605550454035302520151050

11:42:1011:42:0511:42:0011:41:5511:41:5011:41:4511:41:4011:41:3511:41:3011:41:2511:41:2011:41:1511:41:1011:41:0511:41:0011:40:5511:40:5011:40:4511:40:4011:40:3511:40:3011:40:2511:40:2011:40:15

PT 332821514131211109876543210

380 - 390


Iris Version 3.0

13 On line changing an application A big advantage of using Iris is that it gives you the possibility to change the application on line. This means that is can be changed without stopping the application thus without stopping the process. On line changes can be made on the graphical screens as well as on the tag database, device drivers and alarms. When using Iris in a Client / Server configuration changes can also be made on line and remotely. This chapter will describe how to make changes on line to an application.

13.1 Changing screens As mentioned before, the Screen Editor works completely independent from an application. This means that the editor can be opened while an application is running. With the screen editor you can open a screen of the running application, change it, and save it. After saving the screen, the changes will be available in the application the next time the screen is called. When an application is running you will have the iris icon in the tray bar showing a green arrow.

When an application is not running the icon will be shown as follows:

You can op the Screen Editor by clicking on the icon with the right mouse button and choosing the option [Start Screen Editor].

381 - 390


Iris Version 3.0

When the Screen Editor is started you can open the screen to which you want to make the changes. You can change the graphical layout of the screen or you can change the connected points to the objects. When the changes are made to the screen, the screen can be saved under the same name. After refressing the screen in the application, the changes are directly visible in the application. In the same way it is also possible to add screens to the application.

13.2 Changes in the application editor First of all, when the application is running, the Application Editor will show the status of the application and the application items by means of colored boxes in front of the different items. The following picture shows an example.

The following table explains the meanings of the colored boxes. Colored boxes Description

There is a problem (error) with that item or an item under its tree. As you can see in

the example picture the point Alarmer has and error. This means that the upper lying items will show also a red box.

There is a warning with that item or an item under its tree. The item is set offline The item is set on line

A numerical point is disabled.

382 - 390


Iris Version 3.0

The following sections will describe how to make changes to the Application Editor on line. When you have made changes in the Detail panel you always have to validate with the [OK] button. If you don´t validate with [OK] the changes will not be applied to the application.

13.2.1 Changing or adding points You can change or add points in the Application Editor when the application is running. For example, we have a point in our application that is getting his data from address 40001 from a PLC but we want to change that to address 40002. In the Detail panel we change the address to 40002.

After we have validate the changes in the Detail panel with the [OK] button, the point will be set offline showing a blue box in front of the point in the tree panel.

383 - 390


Iris Version 3.0

To set the point on line, select the point in the Tree panel and click on the right mouse button and select the option Set On line.

The point will be set on line to the application and when the point was changed correct it will shown a green box in front of the point in the Tree panel indicating that it is working correct.

384 - 390


Iris Version 3.0

To add a point to an application that is already running, you work in exactly the same way as described in section 7.3.2 Add Points. After adding a point to a running application you will see that there is no box displayed in front of the new point in the Tree panel.

You can set the new point on line in the same way as described earlier, clicking on with the right mouse button on the point and choose the option Set On line.

When the point was configured correct it will show a green box in front of the point.

385 - 390


Iris Version 3.0

13.2.2 Change or add device drivers To change the settings of a device driver on line you simply change the parameters you want to change in the detail panel of a device driver, and validate the changes with the [OK] button. The changes will be directly applied to the running application. To add a device driver on line you follow the steps described in section 7.3.1 Add a Device Driver and Device. After adding the new device driver and device you have to set them on line by clicking on the device driver with the right mouse button and choosing the option Set On line.

If the driver and device are configured correct they will show a green box in front of the driver and device.

386 - 390


Iris Version 3.0

13.2.3 Changing or adding Alarm blocks and groups Adding or changing Alarm blocks and Alarm groups on line follows the same structure as changing and adding Device Driver on line. For how to add Alarm block and Alarm groups to an Application we refer to the following sections:

• 11.2 Alarm groups • 11.3 Alarm blocks

387 - 390


Iris Version 3.0

14 Index

A

Ack Cold 389 Ack Events 390 Ack Hot 389 Ack Read Area 392 Ack Write Area 392 AckTime 75, 396 ActiveControl 311 ActivePage 248, 261, 346 ActiveTag 85, 374 ActiveX 6, 59, 62, 63 Alarm Area 392 Alarm bit 393 Alarm blocks 9, 386, 391, 417 Alarm Definitions 9, 393 Alarm groups 9, 386, 417 AlloBy 194, 223 AllowActiveDoc 251 AllowAllUp 324 AllowClick 187 Allowed Actions 24 AllowGrayed 117, 124 AllowInPlace 252 AllowPanning 109 AllowResize 183 AlphaBlend 311 AlphaBlendValue 311 Always Scan 42 AngelOffset 78 Angle 78, 241 Application Editor 5, 20, 27, 388, 412, 413 Application File 21 ArrowKeys 371 Associate 371 Auto Acknowledge 388 Auto Remove 388 AutoActivate 252 AutoCheck 73, 228 AutoComplete 124, 131, 156, 162, 168, 172, 219 AutoDock 138 AutoDrag 138 AutoEditor 208 AutoHotKeys 226, 228, 273 Automatic 21, 112 AutoPopup 273 AutoRewind 234 AutoScroll 265, 311, 318, 348 AutoVerbMenu 252

B

BackColorFalse 95 BackColorTrue 95

Background color 389 BackImage 101, 110, 134, 241 BackImageIndex 339, 363 BackImageInside 110 BackImageMode 110 BackImageTransp 110 BarColor 276 BarWidth 276 BaudRate 37 Behaviour events 9, 379 BitmapIndex 98 BitmapIndexTag 98 BitmapList 339, 363 BitNumber 95 BkColor 194 BlendColor 195 Block Settings 9, 392, 393 BlockSize 392 BottomOffset 276, 277 Break 142, 228 Brush 321 ButtonColor 302

C

CalColors 145, 245 Category 73 CenterDotColor 78 CenterDotWidth 78 ChangePage 9, 385 CharCase 131, 166, 232 Chart Editor 9, 111, 115, 399, 401 CheckHeigth 120 CheckStyle 120 CloseWindow 9, 385 ColAckNowledge 75 ColAckTime 75 ColAlarmGroup 75 ColColdTime 75 ColCount 159, 336 Cold Events 390 ColdTime 75, 396 ColHotTime 75 Collate 278 ColMessage 75 Colored boxes 412 ColoredButtons 234 ColPriority 75 Columns 29, 124, 149, 150, 220, 224, 291 Conversion 44 CoolBands 140, 141 Copies 278 CustomColors 126

388 - 390


Iris Version 3.0

D

DateFormat 146 DateMode 146 Deadband 45, 47, 395 Decimals 79, 152, 209, 276 Detail panel 5, 28, 32, 33, 34, 35, 37, 38, 40, 41, 42,

43, 44, 45, 46, 47, 387, 388, 389, 392, 393, 413 device driver 5, 35, 36, 37, 416 DeviceType 234 Digits 152, 209 DirLabel 156 DirList 163 DockSite 102, 110, 138, 141, 180, 261, 265, 271,

312, 319, 343, 357, 381 Dongle 16 DragDrop events 9, 378 DragReorder 185

E

elements 146, 226, 273 EmptyColor 352 EndColor 178 EndDate 246 EndMargin 348 event page 6, 66 ExtendedSelect 171, 172, 219, 220, 223, 245, 366

F

FileEdit 172 FileList 156, 169 FileName 82, 234, 254, 257, 305, 307 FileType 172 FillColor 276, 352 filter 29, 30, 31, 169, 254, 257, 305, 307 FilterIndex 254, 257, 305, 307 FirstDayOfWeek 246 FixedOrder 141 FixedSize 141, 142 Flash Pattern 389 FlatScrollBars 224 FocusColor 299, 339 ForeColorFalse 96 ForeColorTrue 96 Foreground color 389 form designer 6, 55 FormDrag 178 Frequency 360, 363 FullDrag 185, 224 FullRepaint 102, 105, 271

G

Grid Color 22 Grid Settings 22 GroupIndex 73, 228, 323, 324

H

HideSelection 166, 224, 238, 296, 367 HorzScrollBars 312, 319 Hot Events 390 Hotkey 7, 188, 189 HotTime 75, 396 HotTrack 186, 224, 262, 343, 367

I

Iconic 252 ImageIndex 65, 71, 73, 143, 186, 187, 228 Increment 112, 276, 371 Indent 357, 367 IndicatorStates 199 InitialDir 254, 257, 305, 307 Installation 5, 12 IntegralHeigth 123, 155, 171, 218 Interval 37, 42, 45, 354, 392 InvalidKeys 190 ItemHeigth 123, 125, 130, 155, 171, 218 ItemIndex 131, 291

K

Keyboard events 9, 376

L

LargeChange 315 LargeImages 224 Layout 6, 54, 91, 121, 202, 206, 209, 324 LeadingZero 152, 209 Legend 110, 403 License Info 20, 26 Limits 43, 172, 385, 395 Line Color 390 Lines 150, 238, 296 LineSize 360, 363 Locked 102, 111, 271 Logger 47, 48

M

MaxDate 146, 246 MaxLength 131, 166, 232, 238, 296 MaxSelectRange 246 MenuAnimation 273 Message panel 5, 28, 32 MinDate 146, 246 ModalResult 91, 92, 105 Modbus 3, 11, 36, 37, 38 Modifiers 190 Monitor 50 Mouse events 9, 377 MPI 3, 11 MultiLine 262, 343

389 - 390


Iris Version 3.0

N

navigation buttons 6, 55 NeedleBaseWidth 79 NeedleColor 79, 135, 242 NeedleLength 79, 135 NeedlePosition 79 NeedleWidth 135, 242 NumGlyphs 91, 324

O

Object buttons 6, 55, 59 Object Inspector 6, 23, 54, 59, 63, 64, 65, 66, 70, 396 OEMConvert 166, 238 OldStreamFormat 252 On line changing 9, 411 OnActivate 375, 380 OnCanResize 380 OnClick 89, 91, 92, 105, 375, 377, 383 OnClose 380 OnCloseQuery 380 OnConstrainedResize 380 OnContextPopup 380 OnCreate 312, 380 OnDblClick 377 OnDeactivate 380 OnDestroy 312, 380 OnDockDrop 380 OnDockOver 381 OnDragDrop 378 OnDragOver 378 OnEndDock 381 OnEndDrag 378 OnEnter 379 OnExit 379 OnGetSiteInfo 381 OnHelp 381 OnHide 381 OnKeyDown 376, 381 OnKeyPress 376 OnKeyUp 376 OnMouseDown 377 OnMouseMove 377 OnMouseUp 377 OnMouseWheel 381 OnMouseWheelDown 381 OnMouseWheelUp 381 OnPaint 381 OnResize 381 OnShortCut 381 OnShow 381 OnStartDock 381 OnStartDrag 378 OnUnDock 381 OnUserChange 381 OPC 11 Orientation 111, 215, 265, 284, 340, 360, 364, 371,

398

Other events 9, 375, 380 OwnerDraw 224, 227, 262, 273, 343

P

Page Settings 5, 34 PageIndex 249 Palette 86, 121, 152 PaletteEx 374 ParseInput 146 password 24, 49 PasswordChar 166, 232 PlainText 296 Plot Area 399 Plot Bars 399 Plot Line 399 points 5, 9, 29, 39, 40, 67, 68, 110, 111, 112, 114,

357, 386, 405, 412, 413 Points 29, 35, 39, 415 Popup 8, 9, 272, 273, 385 Preferences 5, 20, 21 Printer Settings 9, 389, 390 PrintToFile 279 Priority 75, 396 Profibus 11 properties page 6, 64 Proportional 193

R

Radius 79, 303 RaggedRight 262, 344 Read Ref 42 ReadOnly 41, 150, 166, 224, 232, 238, 297, 367 Repetitions 82 ResizeStyle 326 RowCount 160, 337

S

ScaleOffset 364 Screen Editor 6, 19, 20, 54, 411, 412 Scrollbars 160, 238, 297 ScrollBars 337 ScrollOpposite 262, 344 Sections 183, 184, 186, 187 Security 5, 21, 24 SelectedColor 349 SelEnd 360 SelStart 360 ShareImages 195 ShowCaption 202 SimplePanel 332 SimpleText 332 SizeGrip 332 SmalImages 225 SmallChange 315 Smooth 284 Snap to grid 22

390 - 390


Iris Version 3.0

Spacing 79, 91, 121, 212, 215, 242, 324 SpanDays 111 SpanHours 111 SpanMinutes 111 SpanPeriod 111 Special Iris statements 9, 384 SQL server 48 Start Application 19, 20, 21, 27 StartColor 178 StartFrame 82 StartMargin 349 StateFormat 199 StateTag 199 StateValue 96, 199 StopFrame 82, 83 Stretch 99, 193, 196 SwapColors 178 System Settings 5, 35

T

TabFont 346 TabIndex 262, 344, 346, 349 Table panel 5, 28, 29, 30 TabsPerRow 346 Tag connector 6, 67 TextCase 163 ThumbImageIndex 340, 364 ThumbIndent 340 ThumbStates 340, 364 Time Span 398 ToolTips 368

TrackButton 273 TrackMouse 86 Tree panel 5, 28, 29, 414, 415 Trend & Data Logging 45 Trend Designer 9, 114, 115, 398, 400

U

UnitsText 277 UnselectedColor 349 UseDockManager 102, 111, 271, 312

V

Value alarms 9, 394 ValueTag 95, 153, 203, 277 VertScrollBars 312, 319 viewframe 51, 52, 53 Viewport 47, 49, 50 ViewStyle 224, 225 VisibleButtons 235 VisibleTabs 349

W

WantReturns 238, 297 WantTabs 238, 297 WeekNumbers 246 Windows locks 5, 25 Wrapable 357 Write Ref 42

Iris Reference Manual · 2006. 3. 28. · 3 - 390 Iris Reference Manual Iris Version 3.0 Abstract...

Documents

Transcript of Iris Reference Manual · 2006. 3. 28. · 3 - 390 Iris Reference Manual Iris Version 3.0 Abstract...