Sie sind auf Seite 1von 288

Version 7.

Process Analyst

September 2007
DISCLAIMER
Schneider Electric SA makes no representations or warranties with respect to this manual and, to the maximum extent permitted by law, expressly
limits its liability for breach of any warranty that may be implied to the replacement of this manual with another. Further, Schneider Electric SA reserves
the right to revise this publication at any time without incurring an obligation to notify any person of the revision.

COPYRIGHT
© Copyright 2007 Schneider Electric SA. All rights reserved.

TRADEMARKS
Schneider Electric SA has made every effort to supply trademark information about company names, products and services mentioned in this manual.

Citect, CitectHMI, and CitectSCADA are registered trademarks of Citect Pty. Ltd.

IBM, IBM PC and IBM PC AT are registered trademarks of International Business Machines Corporation.

MS-DOS, Windows, Windows NT, Microsoft, and Excel are either registered trademarks or trademarks of Microsoft Corporation in the United States
and/or other countries.

DigiBoard, PC/Xi and Com/Xi are trademarks of Digi International Inc..

Novell, Netware and Netware Lite are are either registered trademarks or trademarks of Novell, Inc. in the United States and other countries..

dBASE is a trademark of dataBased Intelligence, Inc.

All other brands and products referenced in this document are acknowledged to be the trademarks or registered trademarks of their respective holders.

GENERAL NOTICE
Some product names used in this manual are used for identification purposes only and may be trademarks of their respective companies.

September 2007 edition for Vijeo Citect Version 7.0

Manual Revision Version 7.0.

For further information, contact your local Schneider Electric representative.


Contents

About this Documentation

Part I Process Analyst for Operators

Chapter 1 The Process Analyst: An Overview

Chapter 2 Using the Main Toolbar

Chapter 3 Understanding Process Analyst Pens


Pens: An Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Data Compaction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Data Quality. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Date/Time (Horizontal) Axis. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Vertical (Value) Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Gridlines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Pen Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Pen Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Analog pens. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Digital pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Alarm pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Chapter 4 Interacting with the Process Analyst


Pen Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Locking/Unlocking Pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Scrolling the Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Scaling the Chart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Using the Navigation Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Specifying a start time and end time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
About time spans. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Span Lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Navigating time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Synchronize to Now. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Toggle Autoscrolling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Zoom In/Zoom Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
ii Contents

Undo Last Zoom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21


Toggle Box Zoom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Edit Span . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Edit Vertical Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Reset to Default Span . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Using Cursors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Using Cursor Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Using the Right-click Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Understanding Mouse Pointers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Adding and Deleting Pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Adding Pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Deleting Pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Viewing Pen Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Chapter 5 Using the Object View


Object View Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Using Object View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Chapter 6 Printing and Exporting


About Process Analyst Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Configuring Process Analyst Report Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Setting up report legends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Setting up report options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Exporting Pen Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Copying data to the Clipboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Copying data to file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Chapter 7 Configuring the Process Analyst


Using the Process Analyst Properties Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Main page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Toolbars. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Object View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Configuring Chart-wide Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Configuring general properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Configuring server paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Configuring Chart Panes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Configuring Pens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Configuring pen appearance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Configuring pen gridlines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Configuring pen axes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Configuring pen quality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Configuring the pen data connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Configuring cursor labels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Contents iii

Configuring Cursors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Configuring Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Configuring Toolbars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Adding or removing toolbar commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Changing the order of toolbar commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Configuring the Object View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Object View properties page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Working with Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Saving a view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Loading a view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Chapter 8 Operator Command Reference


View Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Zoom Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Navigation Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Export Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Interface Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
General Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Part II Process Analyst for Users

Chapter 9 Integration with Vijeo Citect


Configuring the Process Analyst Control from Graphics Builder . . . . . . . . . . . . . . . 65
Tag association . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Security and Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Administration privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Command privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Write privilege . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Multi-language Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Understanding the Process Analyst resources . . . . . . . . . . . . . . . . . . . . . . . 67
Using Vijeo Citect to switch the Process Analyst language. . . . . . . . . . . . . . 67
Manually switching languages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Specifying languages for the Web Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Creating your own Process Analyst resource.dll . . . . . . . . . . . . . . . . . . . . . . 68
Persistence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Saving while using the Citect Graphics Builder . . . . . . . . . . . . . . . . . . . . . . . 73
Using the Save View toolbar button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Using the SaveToFile automation method . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Saving between Vijeo Citect page transitions (Run-time) . . . . . . . . . . . . . . . 74
Resetting back to the default state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Backing up Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
iv Contents

Chapter 10 Configuring Process Analyst Design Time Properties


Adding New Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Editing Existing Custom Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Creating or Editing Object View Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Process Analyst View Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Chapter 11 Using the Process Analyst Command System


Command System Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Custom Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
CommandExecuted . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
UpdateCommand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Chapter 12 Automation Model


Execution Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Enumerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
IAlarmPen Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
IAlarmPen.LineColor [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
IAlarmPen.LineWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
IAlarmPen.AlarmType [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . 87
IAlarmPen.GetFillColor [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
IAlarmPen.SetFillColor [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
IAlarmPen.GetHatchColor [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
IAlarmPen.SetHatchColor [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
IAlarmPen.GetHatchStyle [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
IAlarmPen.SetHatchStyle [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
IAnalogPen Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
IAnalogPen.LineColor [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . 92
IAnalogPen.LineInterpolation [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . 93
IAnalogPen.LineWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . 94
ICommand Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
ICommand.CommandId [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
ICommand.ButtonType [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
ICommand.Enabled [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
ICommand.Pressed [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
ICommand.Tooltip [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
ICommand.Privilege [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
ICommandSystem Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
ICommandSystem.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . 100
ICommandSystem.Item [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
ICommandSystem._NewEnum [Property][Get] . . . . . . . . . . . . . . . . . . . . . . 101
Contents v

ICommandSystem.ItemById [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . 101


ICommandSystem.Create [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
ICommandSystem.Execute [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
ICommandSystem.Remove [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
ICursors Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
ICursors.Create [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
ICursors.RemoveAll [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
ICursors.Item [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
ICursors._NewEnum [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
ICursors.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
ICursors.ItemByName [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
IDigitalPen Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
IDigitalPen.FillColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
IDigitalPen.LineColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . 109
IDigitalPen.LineWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . 110
IDigitalPen.Fill [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
IObjectView Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
IObjectView.Visible [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
IObjectView.Height [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
IObjectView.BackgroundColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 113
IObjectView.ForeColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . 114
IObjectView.Columns [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
IObjectView.Items [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
IObjectView.SelectedItem [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . 116
IObjectViewColumn Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
IObjectViewColumn.Name [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . 117
IObjectViewColumn.Text [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . 117
IObjectViewColumn.Width [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . 118
IObjectViewColumns Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
IObjectViewColumns.Add [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
IObjectViewColumns.Hide [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
IObjectViewColumns.Remove [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
IObjectViewColumns.Show [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
IObjectViewColumns.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . 122
IObjectViewColumns.Item [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . 122
IObjectViewColumns.ItemByName [Property][Get] . . . . . . . . . . . . . . . . . . . 123
IObjectViewColumns._NewEnum [Property][Get] . . . . . . . . . . . . . . . . . . . . 124
IObjectViewItem Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
IObjectViewItem.GetField [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
IObjectViewItem.PutField [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
IObjectViewItem.Expanded [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . 126
IObjectViewItem.Tag [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . 127
IObjectViewItem.Items [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
IObjectViewItems Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
IObjectViewItems.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
vi Contents

IObjectViewItems.Item [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129


IObjectViewItems._NewEnum [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . 130
IObjectViewPenItem Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
IObjectViewPenItem.BlockColor [Property][Get] . . . . . . . . . . . . . . . . . . . . . 130
IObjectViewPenItem.Checked [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 131
IObjectViewPenItem.Selected [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . 132
IPane Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
IPane.Delete [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
IPane.Height [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
IPane.Collection [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
IPane.Name [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
IPane.BackgroundColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . 136
IPane.FixedHeight [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
IPane.Pens [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
IPanes Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
IPanes.Create [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
IPanes.RemoveAll [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
IPanes.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
IPanes.Item [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
IPanes._NewEnum [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
IPanes.ItemByName [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
IPen Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
IPen.AddSample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
IPen.Clear [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
IPen.Delete [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
IPen.GetDefaultSpan [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
IPen.GetHorizontalAxisTimeSpan [Method] . . . . . . . . . . . . . . . . . . . . . . . . 146
IPen.GetInformation [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
IPen.GetStatistic [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
IPen.GetVerticalAxisSpan [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
IPen.GoToNow [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
IPen.HorizontalScrollBy [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
IPen.HorizontalZoom [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
IPen.PointsVisible [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
IPen.PutHorizontalAxisTimeSpan [Method] . . . . . . . . . . . . . . . . . . . . . . . . 153
IPen.PutVerticalAxisSpan [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
IPen.RefreshData [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
IPen.ResetToDefaultSpan [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
IPen.Select [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
IPen.SetDefaultSpan [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
IPen.SetQualityCompactionPointType [Method] . . . . . . . . . . . . . . . . . . . . . 158
IPen.SetQualityLineStyle [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
IPen.SetVerticalAxisLabelValue [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . 159
IPen.VerticalScrollBy [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
IPen.VerticalZoom [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Contents vii

IPen.AxisBackgroundColor [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . 162


IPen.BlockRepaint [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
IPen.Collection [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
IPen.DataPoint [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
IPen.DataServer [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
IPen.Height [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
IPen.HorizontalAxisColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . 166
IPen.HorizontalAxisResize [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . 167
IPen.HorizontalAxisScroll [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . 168
IPen.HorizontalAxisWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . 168
IPen.HorizontalGridlinesColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 169
IPen.HorizontalGridlinesStyle [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . 170
IPen.HorizontalGridlinesWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 171
IPen.HorizontalMinorGridlinesColor [Property][Get/Set] . . . . . . . . . . . . . . . 171
IPen.HorizontalMinorGridlinesStyle [Property][Get/Set] . . . . . . . . . . . . . . . 172
IPen.IsDeleted [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
IPen.IsSelected [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
IPen.LocalTime [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
IPen.Name [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
IPen.RequestMode [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
IPen.Stacked [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
IPen.TrendCursorLabelFillColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . 177
IPen.TrendCursorLabelLineColor [Property][Get/Set] . . . . . . . . . . . . . . . . . 178
IPen.TrendCursorLabelTextColor [Property][Get/Set]. . . . . . . . . . . . . . . . . 178
IPen.VerticalAxisAutoscale [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . 179
IPen.VerticalAxisColor [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . 180
IPen.VerticalAxisLabelType [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . 181
IPen.VerticalAxisResize [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . 181
IPen.VerticalAxisScroll [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . 182
IPen.VerticalAxisWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . 183
IPen.VerticalGridlinesColor [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . 184
IPen.VerticalGridlinesStyle [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . 185
IPen.VerticalGridlinesWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . 185
IPen.VerticalMinorGridlinesColor [Property][Get/Set] . . . . . . . . . . . . . . . . . 186
IPen.VerticalMinorGridlinesStyle [Property][Get/Set] . . . . . . . . . . . . . . . . . 187
IPen.Visible [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
IPens Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
IPens.Create [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
IPens.RemoveAll [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
IPens.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
IPens.Item [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
IPens._NewEnum [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
IPens.ItemByName [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
IPens.Pane[Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
IProcessAnalyst Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
viii Contents

IProcessAnalyst.BlockUpdates [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . 194


IProcessAnalyst.UnBlockUpdates [Method] . . . . . . . . . . . . . . . . . . . . . . . . 194
IProcessAnalyst.CopyToClipboard [Method]. . . . . . . . . . . . . . . . . . . . . . . . 195
IProcessAnalyst.CopyToFile [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
IProcessAnalyst.FreezeEvent [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
IProcessAnalyst.LoadFromFile [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . 197
IProcessAnalyst.PrintAll [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
IProcessAnalyst.SaveToFile [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
IProcessAnalyst.ShowProperties [Method] . . . . . . . . . . . . . . . . . . . . . . . . . 200
IProcessAnalyst.SubscribeForPropertyChange [Method] . . . . . . . . . . . . . . 200
IProcessAnalyst.SynchroniseToNow [Method] . . . . . . . . . . . . . . . . . . . . . . 201
IProcessAnalyst.UnsubscribePropertyChange [Method]. . . . . . . . . . . . . . . 202
IProcessAnalyst.AdminPrivilegeLevel [Property] [Get] . . . . . . . . . . . . . . . . 203
IProcessAnalyst.AutoScroll [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . 204
IProcessAnalyst.BackgroundColor [Property][Get/Set] . . . . . . . . . . . . . . . . 204
IProcessAnalyst.CommandSystem [Property][Get]. . . . . . . . . . . . . . . . . . . 205
IProcessAnalyst.ContextMenu [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 206
IProcessAnalyst.Cursors [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . 207
IProcessAnalyst.DataRequestRate [Property][Get/Set] . . . . . . . . . . . . . . . 207
IProcessAnalyst.DisplayRefreshRate [Property][Get/Set] . . . . . . . . . . . . . . 208
IProcessAnalyst.Language [Property] [Get/Set] . . . . . . . . . . . . . . . . . . . . . 209
IProcessAnalyst.LastSelectedPen [Property][Get] . . . . . . . . . . . . . . . . . . . 210
IProcessAnalyst.LockedPens [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . 211
IProcessAnalyst.ObjectView [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . 212
IProcessAnalyst.NumberofSamples[Property][Get/Set] . . . . . . . . . . . . . . . 212
IProcessAnalyst.Panes [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
IProcessAnalyst.PrimaryPath [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . 214
IProcessAnalyst.SecondaryPath [Property][Get/Set] . . . . . . . . . . . . . . . . . 215
IProcessAnalyst.Toolbars [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . 216
IProcessAnalyst.WritePrivilegeLevel [Property][Get]. . . . . . . . . . . . . . . . . . 216
IProcessAnalyst.ZoomMode [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . 217
MouseDoubleClick [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
MouseClick [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
PenCreated [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
PenDeleted [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
PenRenamed [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
PenSelectionChanged [Event]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
HorizontalAxisChanged [Event]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
VerticalAxisChanged [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
CursorMoved [Event]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Error [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
PropertyChanged [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
OVItemAdded [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
OVItemRemoved [Event]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
OVItemSelected [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Contents ix

OVItemChecked [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226


OVColumnAdded [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
OVColumnRemoved [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
CommandExecuted [Event]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
UpdateCommand [Event] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
AlarmType [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
AxisLabelType [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
LineStyle [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
HatchStyle [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
PenNameMode [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
PenType [Enumeration]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
PointType [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
RequestMode [Enumeration]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
ToolbarButtonType [Enumeration]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
LineType [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
ErrorNotifyCode [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
QualityType [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
QualityCompactionType [Enumeration]. . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
FileLocation [Enumeration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
IToolbar Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
IToolbar.Visible [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
IToolbar.Buttons [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
IToolbars Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
IToolbars.Count [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
IToolbars.Item [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
IToolbars._NewEnum [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
IToolbarButton Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
IToolbarButton.CommandId [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . 239
IToolbarButtons Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
IToolbarButtons.Add [Method]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
IToolbarButtons.Remove [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
IToolbarButtons.RemoveAll [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
IToolbarButtons.Count [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
IToolbarButtons.Item [Property][Get]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
IToolbarButtons._NewEnum [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . 243
ITrendCursor Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
ITrendCursor.GetValue [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
ITrendCursor.Delete [Method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
ITrendCursor.Color [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
ITrendCursor.Width [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
ITrendCursor.Position [Property][Get/Set]. . . . . . . . . . . . . . . . . . . . . . . . . . 247
ITrendCursor.Visible [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
ITrendCursor.Collection [Property][Get] . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
ITrendCursor.Name [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
ITrendCursor.PenLabelVisible [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 250
x Contents

ITrendCursor.PenLabelWidth [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . 251


ITrendCursor.PenLabelHeight [Property][Get/Set] . . . . . . . . . . . . . . . . . . . 251
ITrendCursor.PenLabelX [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . 252
ITrendCursor.PenLabelY [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . . . 253
ITrendCursor.LabelsLocked [Property][Get/Set] . . . . . . . . . . . . . . . . . . . . . 254

Chapter 13 Cicode Programming Reference


Automation Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Handling an Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Enumerating collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Implementing a custom command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Implementing a custom column. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

Index 265
About this Documentation

The information presented here is intended for two types of user, Operators and
Users:
„ Operator - a person who uses the Process Analyst in a runtime environment
to monitor plant operations. An Operator might configure the properties of
various Process Analyst components during runtime to facilitate their work.
An Operator is not expected to possess in-depth technical knowledge about
the Process Analyst components. For details about using the Process Analyst
as an Operator, see “Process Analyst for Operators”.
„ User - a person who uses the Process Analyst during design time to engineer
a view for an Operator. A User possesses in-depth technical knowledge
about Vijeo Citect and Cicode, and understands how these components
interact. For details about using the Process Analyst as a User, see “Process
Analyst for Users”.
2
Part 1
Process Analyst for Operators

This section contains information for Operators and describes the


following:
“The Process Analyst: An Overview”
“Using the Main Toolbar”
“Understanding Process Analyst Pens”
“Interacting with the Process Analyst”
“Using the Object View”
“Printing and Exporting”
“Configuring the Process Analyst”
“Operator Command Reference”
Chapter 1: The Process Analyst: An Overview

The Process Analyst control allows Operators to view trend and/or alarm tag
data (both real-time and historical) for comparison and analysis during run time
through their existing Vijeo Citect server architecture. Users can configure
certain properties of the Process Analyst control during design time.
A typical Process Analyst view might look like the one shown here. Your
Process Analyst views will probably look different to this example.

5 7 8

10

The Process Analyst control interface typically consists of the following


components:
1 Main toolbar: Contains commands for performing general operations in the
Process Analyst, such as opening views, printing reports, and so on. You can
configure this toolbar to contain different items.
2 Pens: A Process Analyst pen represents your trend and/or alarm data. The
Process Analyst supports three types of pen: analog pen, digital pen, and
alarm pen. Each pen has its own graphical representation. You can configure
most pen properties during run time.
3 Panes: Panes are used to group pens visually in the Process Analyst and are
stacked vertically on the Process Analyst display. Every pen belongs to a
single pane. You can configure chart panes.
4 Chart background (not shown): The panes are drawn over the chart
background. Depending on the layout of the pens, the background may be
partially visible. You can configure the chart background.
2

5 Date/time axis: Located at the top of a pane, the date/time (horizontal) axis
displays the date or time (or both) of the data for the primary selected pen
within a pane. You can configure the axis.
6 Vertical axis: Analog pens have a vertical axis on the left-hand side of the
pane to indicate data values. You can configure this axis.
7 Cursor: A cursor allows an Operator to determine value at a given point in
time by dragging the cursor line to the point required. You can configure the
cursor.
8 Cursor labels: Display the value where the cursor intersects the trend value
line.
9 Navigation toolbar: Contains commands to allow an Operator to travel
forward or backward through trends, as well as other navigation-related
tasks. You can configure this toolbar to contain different items.
10 Object View: When displayed, the Object View appears under the
navigation toolbar and displays information about your Process Analyst
pens, such as name, color, scale, and so on. You can configure the Object
View.
Chapter 2: Using the Main Toolbar

The Process Analyst main toolbar is located above the top pane. The main
toolbar contains commands that allow you to perform general operations, such
as save and load Process Analyst views, print trend reports, add or remove pens,
display or hide cursors and labels, and so on.
Toolbar commands can be customized; for details, see “Configuring Toolbars”.
The table below describes the items that are included on the main toolbar by
default.
Item Description
Load View. Loads a saved view from file. For details, see “Loading a view”.

Save View. Saves a view to file. For details, see “Saving a view”.

Print. Displays the standard Windows Print dialog box for printing trend reports. For
details, see “Printing and Exporting”.
Copy to Clipboard. Copies visible pens to the Windows Clipboard. For details, see
“Copying data to the Clipboard”.
Export to File. Exports visible pens to an Excel-compatible file. For details, see “Copying
data to file”.
Add Pen. Displays the Add New Pen(s) dialog box for adding a pen. For details, see
“Adding Pens”.
Remove Pen. Deletes the currently selected pen from the trend display. For details, see
“Deleting Pens”.
Lock/Unlock Pens. Toggles the locking of pens. For details, see “Locking/Unlocking
Pens”.
Show/Hide Points. Toggles the display of points representing where sample data was
recorded in the archive. For details, see “Pens: An Overview”.
Show/Hide Cursors. Toggles the display of cursors. For details, see “Using Cursors”.

Show/Hide Cursor Labels. Toggles the display of cursor labels. For details, see “Using
Cursor Labels”.
Toggle Object View. Toggles the display of the Object View. For details, see “Using the
Object View”.
Properties. Displays the Properties dialog box for configuring the Process Analyst control.
For details, see “Configuring the Process Analyst”.
Help. Displays the Process Analyst online Help.

See Also “Using the Navigation Toolbar” | “Operator Command Reference”


4
Chapter 3: Understanding Process Analyst
Pens

The Process Analyst pens allow you to analyze and compare both real-time and
historical data from trend and alarm servers.
See Also “Pens: An Overview” | “Pen Types”

Pens: An Overview
Process Analyst pens are drawn against time. Each pen has its own colored line
(and can contain other graphical elements). Sample markers (or points) are
drawn on the line to indicate where data was recorded in the archive. The style
of the line indicates the quality of the data; the style of the sample marker
indicates the compaction of the sample.

Data Compaction Data compaction is the visual grouping of multiple data points into a single data
point when the data in the archive is too dense to be displayed as individual
data points for the selected time span.
Data is compacted by grouping raw samples together to form a multiple sample.
Sample compaction is indicated on the graph by using different sample markers.
For example, in the illustration below, the two sample markers that appear as
squares actually represent multiple raw samples. However, because the data
points in this view are too dense to display as individual points, the multiple
samples appear as one data point.

The following illustration zooms in on the second multiple sample, and shows
that what appeared to be a single raw sample actually consists of several raw
samples:

The Process Analyst uses the following default point styles for single and
multiple samples:
Sample compaction Point type
Single Ellipse
Multiple Rectangle
Interpolated Triangle (see “Interpolated samples”).
6

Interpolated samples
Normally samples are only single or multiple. But there is a specific situation in
which an interpolated sample is used to correct a graph that only occurs with
event trends.
The frequency of the data stored in an event trend can vary dramatically; for
example, where several samples are within one display period, followed by no
samples for a long time. A multiple sample will be drawn with a value
calculated from the samples within the period. But the value after that period
will be whatever the last sample in the period was. So an interpolated sample is
added at the start of the next display period to correct the graph.
See Also “Interpolation”

Request modes
Because the Process Analyst Control makes requests for a range of data using a
display period, Vijeo Citect needs to perform calculations on data if it becomes
too dense in order to calculate the value of a multiple sample. The Process
Analyst provides the following options for this calculation:
„ Average - The value will be an average of all the individual samples within
the multiple sample, as will the timestamp. This is the default calculation
method.
„ Maximum: The value will be the maximum value out of all the individual
samples within the multiple sample. The timestamp will be that of the
individual sample that was the maximum. The timestamp will be the
average of all the individual samples within the multiple sample.
„ Minimum: The value will be the minimum value out of all the individual
samples within the multiple sample. The timestamp will be that of the
individual sample that was the minimum. The timestamp will be the
average of all the individual samples within the multiple sample.
„ Newest: The value will the latest arrived value out of all the individual
samples within the multiple sample. The timestamp will be that of the
individual sample that was the newest. The timestamp will be the average of
all the individual samples within the multiple sample.

Data Quality Process Analyst pens use the same quality system as Vijeo Citect trend and
alarm data. There are four data quality states:
„ Good - Samples were recorded in the trend archive as good.
„ NA - When Vijeo Citect is unable to obtain a sample or the data retrieved
was invalid, an N/A sample will be recorded in the trend archive.
„ Gated/Disabled - For trends, when the trigger of a trend is off, a value of
"Gated" is recorded in the trend archive. For alarms, this data quality state
indicates that the alarm has been disabled.
The Process Analyst uses the following default line styles to indicate data
quality:
Quality Line style
Good Solid
7

Quality Line style


NA None
Gated
Dot
Consider the following examples:
Data sample Description
This example shows several single samples. The third sample has a quality of N/A,
indicated by the break in the trend line.

Here the quality of the third sample is gated, indicated by the broken line connecting these
samples.

With multiple samples, the quality of the last sample in the group determines how the line is drawn. Consider
the following examples:
This example shows that the third sample is actually a multiple sample. The quality of the
third (multiple) sample and the next sample is N/A, again indicated by the break in the
trend line.

Here the quality of the third multiple sample is gated, again indicated by the broken line
connecting the samples.

The line style indicating the data quality is configurable during run time and
design time; for details, see “Configuring pen quality”.

Date/Time (Horizontal) All Process Analyst pens have a date/time axis, located at the top of the pane.
Axis

The date/time axis displays time using the current locale format specified in
your computer date/time settings. If the millisecond component is required, it is
appended to the end in the format “<xxx>ms.” Since the local time zone is
determined from the current computer settings, these settings must be
configured accurately.
The date/time axis can also display data using the universal time coordinate
(UTC) format. You can switch between local or UTC time as you like (see
“Configuring pen axes”). If the current time is 10.00p.m. UTC, in the Sydney
(GMT+10) time-zone, local time will be 8.00p.m.
The date/time axis is divided into major and minor time intervals, which change
dynamically depending upon the time span. In the illustration above, the major
intervals are 1 minute apart, and the minor are 5 seconds apart.
Note the following:
„ When the axis time span is 1 minute or less, the format of the axis labels
includes milliseconds and the date is removed.
„ When the axis time span is 1 week or above, the time is removed and only
the date is displayed.
8

By default, the date/time axis displays a time span of 10 minutes; the major
intervals represent 5 minutes, and the minor intervals 30 seconds.

Daylight savings (local time)


The date/time axis can also accommodate daylight savings transitions. For
example, when entering daylight savings, the axis will indicate the transition as
11a.m., 12a.m., 1a.m., 3a.m., 4a.m., 5a.m., if this transition occurred at 2a.m.
Likewise, in the out transition, when 1 hour is removed from daylight savings
time, the axis will display 11a.m., 12a.m., 1a.m., 2a.m., 2a.m., 3a.m., 4a.m., 5a.m.

Now indicator
The Now indicator is a small white circle on the date/time axis that indicates the
current computer time based on the computer’s time settings.

The position of the Now indicator is refreshed according to the value specified
in the Display Refresh Date text box in the Process Analyst Control Properties
dialog box.
Note: If you have used the Vijeo Citect trend page feature, note the following: In
Vijeo Citect the right-hand side of the screen always represents Now (when
looking at real-time data). In the Process Analyst control, “Now” is represented
only by the Now indicator, which may be located anywhere on the trend
display, even off screen, since it is possible to scroll into the future, or back into
the past.
You can scroll and scale the date/time time axis to interact with your Process
Analyst pens; for details, see “Interacting with the Process Analyst”. You can
also configure the date/time axis to suit your preferences; for details, see
“Configuring pen axes”.

Vertical (Value) Axis The vertical (value) axis is located at the left-hand edge of the pane.
Like the date/time axis, the value axis consists of major and minor intervals, but
they represent value intervals rather than date and time. The intervals are
calculated automatically by the Process Analyst.
The value axis is shown only for analog pens; the axis displayed reflects the
values for the primary selected pen.
By default the vertical axis will use the engineering scale from the tag of the
selected pen. The vertical axis also supports autoscaling. When autoscaling is
enabled, the vertical axis automatically adjusts its limits to accommodate new
samples as they are added to each individual pen.
9

In this example, there are two panes, each of which has a differently scaled
vertical axis.
You can scroll and scale the vertical axis; for details, see “Scrolling the Chart”
and “Scaling the Chart”. You can also configure the appearance of the vertical
axis; for details, see “Configuring pen axes”.

Gridlines The Process Analyst pens use gridlines as a visual guide to help an Operator
determine the value of trends. Major gridlines are solid lines; minor gridlines are
broken lines. Analog pens have vertical and horizontal gridlines; alarm and
digital pens only have vertical gridlines. The display of gridlines changes
dynamically according to the selected time span.
You can configure vertical gridlines at run time for all pen types; you can
configure horizontal gridlines for analog pens. For details, see “Configuring pen
gridlines”.

Pen Layout You can are display pens in the Process Analyst by stacking or overlaying.
„ In stacked mode, a user-specified amount of vertical real-estate is allocated
to the pen, and with this, stacked pens are laid out under each other on the
pane, starting from the top of the pane under the date/time axis, like this:

Here, three pens (one analog and two digital) are stacked under each other.
Stacking applies to all types of pens.
„ In unstacked mode, pens are drawn on top of each other. The order in
which the pens were added to the pane governs the drawing order: the last
10

pen added is the topmost pen drawn. When a pen is selected, it is brought to
the front of any other pens displayed

Here, two analog pens are overlaid. You can also overlay digital and alarm
pens.
You can have any mix of stacked and unstacked pens on a pane.

Pen Types
The Process Analyst control supports three types of pen: analog pens, digital
pens, and alarm pens. Analog and digital pens are associated with trend tags;
alarm pens are associated with alarm tags.

Analog pens The Process Analyst control typically uses analog pens to represent nonbinary
data. Only analog pens have a value (vertical) axis, which the data is plotted
against, as shown here:

Interpolation
Analog pens have two types of interpolation that allow you to specify how to
connect data samples on a trend line: straight and stepped:
„ Straight - a line is drawn directly between the points like this:

„ Stepped - the lines drawn always maintain the value of the previous sample
until a sample with a different value arrives, in which case a vertical line is
drawn:
11

The Process Analyst allows analog pens to be configured at run time and design
time. For details, see “Configuring Pens”.
See Also “Interpolated samples”

Digital pens The Process Analyst control typically uses digital pens to represent binary data.
Values on the pen are clamped to a range of 0 to 1. Any value equal to or greater
than 0.5 is clamped to 1; all other values are clamped to 0. A fill color is used to
indicate where the data is 1, as shown here:

By default, the layout of digital pens is stacked. For details, see “Pen Layout”.
The Process Analyst allows the appearance of digital pens to be configured
during run time and design time. You can configure the trend line color, width,
and fill color. For details, see “Configuring pen appearance”.

Alarm pens The Process Analyst uses alarm pens to graphically display the history of a Vijeo
Citect alarm over time. The Process Analyst supports seven different types of
alarm pens.
The alarm’s on/off transition state changes and acknowledgements are all
represented graphically in the alarm pen display. To achieve this, the alarm pen
consists of three elements: the alarm state, on/off, and acknowledgement.
The diagram below illustrates how an alarm pen displays the information of an
alarm tag:

1
3

on/off

2 4

1 The alarm is turned on in its initial state and is unacknowledged.


2 The alarm changes to a different state, but is still unacknowledged.
3 The alarm is acknowledged.
4 The alarm is turned off.
12

Like other types of pen, alarm pens can represent variations in data quality and
data compaction.
The Process Analyst allows alarm pens to be configured at run time and design
time. For details, see “Configuring alarm pens”.

On/off
When an alarm is off, the alarm pen will draw the line low. When the alarm
transitions to on, the line is drawn high.

Alarm states
When an alarm transitions to on, it enters a particular state. The states of an
alarm are dictated by the type of Vijeo Citect alarm tag. The Process Analyst
supports all Vijeo Citect standard alarm types.
Note: For multi-digital alarms, the state descriptions are retrieved from the Vijeo
Citect alarm record.
The Process Analyst uses a different color, shading style, and description to
represent each alarm state; these properties are configurable. For details, see
“Configuring alarm pens”.

Alarm acknowledgment
Process Analyst alarm pens can represent when alarms are acknowledged.
„ The Process Analyst indicates the period for which the alarm has been left
unacknowledged by drawing a line above the trend line. A new
unacknowledged period begins whenever the alarm transitions to an on
state.

unacknowledged periods

acknowledgements

„ The unacknowledged period ends when an Operator acknowledges an


alarm. The Process Analyst identifies this by placing a sample marker to
indicate the exact time the alarm was acknowledged, and by drawing an
unacknowledged line down to that sample marker, as shown here:

acknowledgement
marker
13

Alarm types
The Process Analyst uses the following types of alarm pen:
Alarm type Alarm pen representation
Digital

Analog

Advanced

Argyle Analog

Multi-digital

Timestamped

Timestamped analog

Timestamped digital

For multiple samples in an alarm, the alarm state value is the last recorded value
in the group.
14
Chapter 4: Interacting with the Process
Analyst

This section discusses how to interact with the Process Analyst.


See Also “Pen Selection”
“Locking/Unlocking Pens”
“Scrolling the Chart”
“Scaling the Chart”
“Using the Navigation Toolbar”
“Using Cursors”
“Using Cursor Labels”
“Using the Right-click Menu”
“Understanding Mouse Pointers”
“Adding and Deleting Pens”
“Viewing Pen Details”

Pen Selection
Each pane on the Process Analyst can have one selected pen. The axes that are
displayed on a pane are that of the selected pen. The last pen selected across all
panes is referred to as the primary selected pen.
You can select a Process Analyst pen in several ways:
„ By clicking on the pen’s graphical elements (i.e., the pen line).
„ If the pens are stacked, by clicking the background under the pen line.
„ By selecting the pen in the Object View.
The selection of a pen is indicated by a subtle halo effect surrounding the pen
line. In the example shown here, the top (green) pen is selected, indicated by the
halo surrounding the pen:
16

Note that the halo does not appear if there is only one pen on the pane. Selecting
a pen on a pane also causes the same pen to be highlighted in the Object View.
Selecting a pen causes that pen to be drawn in front of other pens on the pane.

Locking/Unlocking Pens
By default, the Process Analyst locks together the time span and position in time
(horizontal axis) of all pens. However, you can unlock the pens, allowing the
pens to be displayed across different positions in time and/or time spans.
For example, you could unlock pens to compare a previous month’s data for a
tag with the data for this month. You would do this by adding two pens to a
pane that represent the same tag, then unlocking the pens, and adjusting the
time positions for each pen as required.
To control pen locking and unlocking, you use the Lock/Unlock Pens button on
the main toolbar.

This option is also available on the right-click (context) menu.


Locking and unlocking has the following behavior:
„ When pens are locked, all time-related operations are applied to all pens.
„ When pens are unlocked, all time-related operations are applied to the
primary selected pen.
„ Synchronization applies to all pens regardless of their being locked or
unlocked.
When transitioning from locked to unlocked, the time span and position in time
of all pens are synchronized to match that of the primary selected pen.

Scrolling the Chart


The Process Analyst allows you to scroll through data in both the horizontal and
vertical directions by dragging the mouse or spinning the mouse wheel.
To scroll by dragging:
1 Click and hold down the left mouse button on the pen (or background) that
you want to scroll.
2 Drag the mouse in the direction you want to scroll:
„ Horizontal axis: drag right to move backward in time, drag left to move
forward.
„ Vertical axis: drag up to scroll down the axis, drag down to scroll up the
axis.
3 Release the left mouse button to complete the scrolling.
To scroll by using the mouse wheel:
1 Click the pen or background that you want to scroll.
2 Spin the mouse wheel in the direction you want to scroll:
17

„ Horizontal axis: spin up to move backward, spin down to move


forward.
„ Vertical axis: spin up to scroll up the axis, spin down to scroll down.
You can disable scrolling in the horizontal direction, the vertical direction, or
both by using the Property dialog box or the right-click (context) menu; see
“Configuring pen axes” and “Using the Right-click Menu” for details.
The Process Analyst indicates whether scrolling is enabled or disabled by
displaying a different-shaped mouse pointer; for details, see “Understanding
Mouse Pointers”.

Scaling the Chart


The Process Analyst allows you to change the scale of the data in both the
horizontal and vertical direction by dragging the mouse or spinning the mouse
wheel.
To scale the data by dragging:
1 Click and hold down the left mouse button on the axis that you want to
scale.
2 Drag the mouse in the direction you want to scale:
„ Horizontal axis: drag left to expand the scale, drag right to shrink.
„ Vertical axis: drag up to expand the scale, drag down to shrink.
3 Release the left mouse button to complete the scaling.
To scale by using the mouse wheel:
1 Click the axis that you want to scale.
2 Spin the mouse wheel in the direction you want to scale:
„ Horizontal axis: spin up to shrink the axis, spin down to expand.
„ Vertical axis: spin up to expand the axis, spin down to shrink.
You can disable scrolling in the horizontal direction, the vertical direction, or
both by using the Property dialog box or the right-click (context) menu; see
“Configuring pen axes” and “Using the Right-click Menu” for details.
The Process Analyst indicates whether scaling is enabled or disabled by
displaying a different-shaped mouse pointer; for details, see “Understanding
Mouse Pointers”.

Using the Navigation Toolbar


Using the navigation toolbar you can:
„ Specify a start time and end time.
„ Select predefined time spans.
„ Lock time spans on the display.
„ Navigate backward or forward through your data.
„ Synchronize all pens to “Now.”
18

„ Toggle autoscrolling of the display.


„ Zoom in on or out of data.
„ Undo the last zoom operation.
„ Toggle between Zoom mode and normal mode.
„ Set nonstandard time spans.
„ Edit the vertical (value) scale.

Specifying a start time You can specify a start time and an end time for the trend display by using the
and end time date/time pickers. The start time picker is located on the left-hand side of the
navigation toolbar, the end time picker on the right.

The date/time picker formats the date and time using the settings obtained from
your computer for the currently logged in user. The date/time picker displays
time in 24-hour format (dd/mm/yyyy hh mm:ss nnn) where:
„ dd represents days
„ mm represents months
„ yyyy represents years
„ hh represents hours
„ mm represents minutes
„ ss represents seconds
„ nnn represents milliseconds (added automatically to the time)
To change the date or time in the date/time picker:
1 Click the element of the date or time you want to change in the start time
picker or the end time picker.
2 Do either of the following:
„ Type in a time explicitly.
„ Press the Up arrow key or Down arrow key to increment or decrement
the value respectively.
Note: You can use the Left arrow and Right arrow keys to move between
time elements.

Working with Daylight Savings


To indicate whether the time in the time picker control is Standard time or
Daylight Savings time, the clock to the left of the control has a shaded segment if
the time is in a Daylight Savings period. When in Standard time, the clock does
not have a shaded segment.
For example, this icon appears when the time picker’s value is within the local
Daylight Savings period:
19

This icon appears when the time picker’s value is within the local Standard time
period:

If the Daylight Savings transition involves duplicate hours, you can use the spin
controls (or Up and Down arrow keys) to select the hour you want.
Note: In order for the Process Analyst to be able to indicate that Daylight
Savings is in effect, the Automatically adjust clock for daylight saving changes
option on the Date and Time Properties dialog box must be enabled, as indicated
below:

See Also “Daylight savings (local time)”

Shifting and fitting time units


You can manipulate the start time and end time by using special keyboard
shortcuts. Using these shortcuts, you can do the following:
„ Shift by unit
„ Fit to unit
Shift by unit Shifting date or time by unit allows you to change the opposite date/
time element to the one selected by the corresponding date or time component.
For example, if you shift by unit the month time element in the start time, the
month time element in the end time increments by one month exactly, including
days, minutes, and seconds. This also works for months that have different end
days.
To shift by unit:
1 Press and hold down the Shift key.
20

2 Click a date or time element in the date/time picker. The opposite time
picker changes by the base time amount of the selected time element.
Fit to unit Fitting date or time to unit allows you to synchronize the selected time
element to the zero position of that time element in the start time and end time.
For example, an Operator clicks on the hh time element of the Start picker, which
shows 19:30:05.123. After Ctrl + click, the Start hour time element shows
19:00:00.000, and the End time element shows 20:00:00.000. Now the time span
represents exactly one hour, synchronized on the hour.
To fit to unit:
1 Press and hold the Ctrl key.
2 Click a date or time element in the date/time picker. Both the start time and
end time element are synchronized to zero based on the date/time element
selected.

About time spans The time span of the trend display is the difference between the start time and the
end time. The start time appears on the left-hand side of the trend display, the
end time on the right. The Span Picker (shown below) indicates the current span
being used; it also contains commonly used predefined time spans. Selecting a
time span adjusts the start time, leaving the end time as-is.

See Also “Span Lock”

Span Lock When the time span is locked and the start time and/or end time picker changed,
the current time span is maintained. If the time span is unlocked, the time span
is not maintained when any of the time pickers are changed.

By default, the span is locked. You can toggle span locking on or off by using the
Span Lock button.
See Also “About time spans”

Navigating time The navigation controls allow an Operator to navigate backwards or forwards
through time. The amount of time moved depends upon the time currently
selected in the Span Picker. For example, if 10 minutes is selected in the Span
Picker and Back One Span is clicked, the display moves back 10 minutes into
the pen’s history.
The following navigation controls are available:
Navigation control Description
Back One Span - moves back one time span.

Back Half a Span - moves back half a time span.

Forward Half a Span - moves forward half a time span.


21

Navigation control Description


Forward One Span - moves forward one time span.

Synchronize to Now The Synchronize to Now command synchronizes all pens such that the date/
time reflects “Now,” which is positioned on the right-hand edge of the screen.
“Now” is calculated using the current system time.

The Synchronize to Command is also available from the right-click (context)


menu.
See Also “Now indicator”

Toggle Autoscrolling When Autoscroll is turned on, as time passes the position in time of all pens
moves by the same amount to keep pace; by default, the display is updated
every second. The refresh rate of the display can be controlled by using the
Display Refresh Rate property.
When Autoscroll is turned off, as time passes the position in time of all pens
remain fixed.
By default, Autoscroll is on. You can toggle Autoscrolling on or off by using the
Toggle Autoscrolling button.

Using the navigation controls, including the Time Span picker, causes
Autoscrolling to be turned off
The Autoscroll command is also available from the right-click (context) menu.

Zoom In/Zoom Out Use the Zoom In 50% and Zoom Out 50% commands like this:
Command Icon Description
Zoom In 50% Zooms in on the displayed data, halving the span of both axes.

Zoom Out 50% Zooms out of the displayed data, doubling the span of both axes.

Note: The midpoint of each axis is maintained during these zoom operations.

Undo Last Zoom Undo Last Zoom allows you to undo the last zoom operation, returning the
display to the previous state.

Toggle Box Zoom The Toggle Box Zoom button switches between Box Zoom mode and normal
interaction mode. In Box Zoom mode, you can define an area of the chart to
zoom in on for more detail.
To use Box Zoom:
1 Select the pen to zoom in on.
22

2 Click Toggle Box Zoom on the navigation toolbar.

The cursor changes to a cross.


3 Click and drag the bounding box to enclose the part of the data you want to
zoom in on, as shown below.

4 Release the mouse button. The display changes to a close-up of the selected
data.

5 To exit Zoom mode, click the Toggle Box Zoom button.


Depending on whether the pens are locked or unlocked, the Toggle Box Zoom
commands works differently:
„ For locked pens, the zoom is applied to all pens in the horizontal date/time
axes. If an analog pen is being zoomed, the zoom is applied to the vertical
(value) axis of all non-autoscaled analog pens in the pane in which the zoom
box was initiated.
„ For unlocked pens, the zoom is applied only to the selected pen in both the
date/time and vertical (value) axes. The value axis is only affected if
autoscale is off.
Note: Vertical zoom is only applied to analog pens, since it has no effect with
alarm or digital pens.

Edit Span Click the Edit Span button to display the Edit Span dialog box, which allows
you to set non-standard time spans.

To edit a time span:


1 Click Edit Span on the navigation toolbar. The Edit Span dialog box
appears.
23

The fields provided are: w = weeks, d = days, hr = hours, min = minutes, sec
= seconds, and ms = milliseconds.
2 Enter a New span. Click the element of the time span that you want to
change, then either type in a new value, or use the Up arrow or Down arrow
to specify a new value. You can use the Right arrow and the Left arrow key
to move between the time elements.
3 Click OK. The new time span is applied.

Edit Vertical Scale The Process Analyst allows Operators to edit the vertical scale of a selected
analog pen to display more appropriate values, if required. The vertical scale for
digital or alarm pens cannot be edited.
To edit the vertical scale:
1 Click Edit Vertical Scale on the navigation toolbar. The Edit Vertical Scale
dialog box appears.

2 Click the Limits or Engineering Scale option. The Limits values displayed
are the current values used by the vertical scale. The Engineering Scale
values are obtained from the trend tag.
3 Enter a new Minimum value and Maximum value, and then click OK.

Reset to Default Span Use the Reset to Default Span button to reset the time span to the default time
span of the primary selected pen. The default span can be configured by using
the Property dialog box. For details, see “Configuring pen axes”.
24

See Also “Configuring Defaults” | “Pen Selection”

Using Cursors
A cursor enables an Operator to determine the value of a pen at a given point in
time by dragging the cursor to the specific point on the pen line. A cursor label is
used to display the value.
An Operator can define many of the properties of cursors and cursor labels. For
details, see “Configuring Cursors”.

In this example the cursor intersects three pens; the cursor labels (the yellow
rectangles) display the corresponding pen values.
To move a cursor, drag the cursor line left or right. As the cursor moves, the
cursor labels move with the cursor and are updated continuously, reflecting the
position of the cursor.
Note: The cursor extends across all configured panes.
A line connects the cursor label to the associated pen line. The line has three
main states:
State Style Example
Intersection within pen data Line

Intersection before or after pen Line with indicator


data
25

State Style Example


No intersection and no data Invisible line

To show/hide a cursor:
„ Click Show/Hide Cursor on the main toolbar. You can display additional
cursors by using the Properties dialog box.

You can display as many cursors as you want. To add a cursor, right-click the
root item (Process Analyst View) in the property tree in the Properties dialog
box, and choose Add Cursor.

Using Cursor Labels


Each cursor has one cursor label for each pen displayed. The cursor label
displays the value of the pen at the point where the cursor intersects with the
pen data.
To display cursor labels:
„ Click Show/Hide Cursor Labels on the main toolbar.

This table summarizes how to use cursor labels:


Task Description
Move a cursor label Click the cursor label and drag the label to a new location.
Change the size of cursor labels Click the cursor label you want to resize. Place the mouse cursor on one
of the sizing boxes, and drag the label to the new size. If you drag the
corner of the label, the label text resizes to an optimal size for the label.
Lock or unlock the cursor labels Click the Lock/Unlock Cursor Labels. When on, this command causes
cursor labels to be “frozen” in the position.

The cursor label displays the following information:


Cursor field Applies to Description
Pen Name All Pen types Displays the non-unique Process Analyst pen name
Value/Quality All Pen types Displays the value of the pen at the point the cursor intersects with the
pen data
Date-Time Stamp All Pen types Displays the date/time stamp at the point the cursor intersects with the
date/time axis.
Alarm Sample Alarms Comment bound to an alarm sample.
Comment

The fields are displayed in the cursor label using the order defined above using
the format specified for the vertical axis. For example, if your vertical axis format
is “km/h”, the label reads “<value> km/h”.
26

The label displays the following values when the quality of the data is not good:
Cursor value Description
NA At the point of intersection the pen has no available data for display.
Gated At the point of intersection the pen’s data has been gated.
Disabled At the point of intersection the alarm tag of the pen was disabled.

The label value can also contain a directional indicator that functions as follows:
Cursor value Description
<value> -> The cursor is to the left of the first available sample for this pen.
<- <value> The cursor is to the right of the last available sample for this pen.

Alarm label value


The alarm label value has the following format:
state [acknowledgement]
where state refers to the alarm state at the point of intersection (see “Alarm
pens”) and acknowledgement refers to the acknowledged state of the alarm at the
point of intersection; i.e., Acknowledged or Unacknowledged.

Using the Right-click Menu


Use the right-click (context) menu to quickly access frequently used commands.
This menu is context-sensitive, providing relevant commands for different
regions of the display. The right-click menu appears when you click any of the
following regions:
„ Horizontal axis
„ Vertical axis
„ Background
„ Pen
The Properties command is always available on the right-click menu; this
command displays the Properties dialog box. For details, see “Using the Process
Analyst Properties Dialog Box”.

Understanding Mouse Pointers


When using the Process Analyst, the mouse pointer changes shape to indicate
the operations you can perform at that time.
Mouse pointer Region Description
Pen line The mouse pointer looks like this when the pointer is on a pen. Clicking the
mouse at this point selects the pen.

Pen line/pen The mouse pointer looks like this when the mouse is over a pen’s
background background and both horizontal and vertical scrolling are enabled. Clicking
and dragging at this point results in the free movement of the pen. Scrolling
the mouse wheel results in horizontal-only movement.
27

Mouse pointer Region Description


Horizontal The mouse pointer looks like this when the pointer is on the horizontal axis
axis and horizontal scaling is enabled. Clicking and dragging (or scrolling the
mouse wheel) will result in the axis being scaled.
Pen line/pen The mouse pointer looks like this when the pointer is on the horizontal axis
background and only horizontal scrolling is enabled. Clicking and dragging (or scrolling
the mouse wheel) will result in the axis being scrolled.
Vertical axis The mouse pointer looks like this when the pointer is on the vertical axis
and vertical scaling is enabled. Clicking and dragging (or scrolling the
mouse wheel) will result in the axis being scaled.
Vertical axis The mouse pointer looks like this when the pointer is on the vertical axis
and only vertical scrolling is enabled. Clicking and dragging (or scrolling the
mouse wheel) will result in the axis being scrolled.
Box Zoom The mouse pointer looks like this when Box Zoom mode is enabled. See
mode “Toggle Box Zoom”.

Adding and Deleting Pens


Pens can be added to or removed from any pane. The Process Analyst allows
Operators to search the trend tags and alarm tags that are defined on their trend
and alarm servers and add pens that represent these tags to the current trend
display.

Adding Pens You use the Add New Pens dialog box to add a new pen to your trend display.
To display the Add Pens dialog box, click Add Pens on the main toolbar.
To add a new pen:
1 Select the Type of server you want to search: Trends or Alarms.
2 Type in a Tag Filter and/or Cluster Filter to apply to the search (optional).
If you leave either of the Filter text boxes blank, all tags or clusters of the
selected server type will be retrieved. The filters have basic wildcard and
Boolean search functionality. You can use the keywords AND, OR and NOT
with wildcard strings, as well as group Boolean terms using parentheses.
For example, entering 'L*' in the Tag Filter returns all tags beginning with
the letter “L” in all clusters. Entering ‘L* OR H*’ will find all tags beginning
with “L” or “H”. More complex examples include ‘L* OR (H* AND NOT
*G)’. This would return all tags that start with “L” or any that start with “H”,
but do not end in “G”.
3 Click Search. The search results are returned in the Search list. The results
are not sorted: the tags appear in the order they were configured in Vijeo
Citect.
The cluster associated with each tag is also displayed. The Process Analyst
displays only the tags in clusters that this client has access to. In a system
with more than one cluster, if a tag is not configured with a cluster, it is
listed once for each cluster.
The Search Result list displays a maximum of 100 entries at a time. If your
search returns more than 100 results, use the First, Prev, Next, and Last
buttons to navigate your search results.
28

4 Select one or more tags from the Search Results list. You can use the Ctrl
and/or Shift keys to select multiple tags.
5 Select the destination pens to Add Add pens to. Pens can be added to any
existing pane, or to a new pane.
6 Select a Pen Type. A trend tag can be represented by an analog or digital
pen. An alarm tag can be represented by an alarm pen only.
7 Select how to resolve the pen name:
„ Comment - applies the tag comment as the pen name. Note that if the
tag does not have a comment specified, a name is automatically
generated.
„ Tag - applies the tag name as the pen name.
„ Auto -applies an automatically generated name to the pen using the
format Pen<X> where X is an incremented number, starting with the
first available number.
8 Click Add. This moves all the selected items in the Search Results list into
the Selected Items list. The Selected Items list contains all the tags that will
be added as pens to the Process Analyst. You can perform multiple searches
to add tags into the Selected Items list.
Note: To remove a tag from the Selected Items list, highlight the item you
want to move, and then click Remove.
9 To view details about a selected tag, click Show Detail. The Pen Detail box
appears, showing defined information for the selected tag.
10 Click OK. Your selected tags appear on the trend display as pens.
See Also “Deleting Pens”

Deleting Pens Operators can delete pens from the trend display at any time.
Note: Deleting a pen is different than hiding the pen from display by using the
Visibility check box in the Object View. For details, see “Using Object View”.
To remove a pen:
1 Select the pen you want to delete.
2 Click Remove Pen in the main toolbar. The pen is deleted from the display.

See Also “Adding Pens”

Viewing Pen Details


You can use the Pen Details box to view tag properties information for a selected
pen. You access this box from the Add Pens dialog box.
To view pen details:
1 Click Add Pens. The Add Pens dialog box appears.
2 Navigate to the tag you want to view details for. For details on searching
tags, see “Adding Pens”.
29

3 Select the tag in the Selected Items list, and then click Show Detail. The Pen
Details dialog box appears, showing the system information for the selected
tag.
30
Chapter 5: Using the Object View

The Object View provides a structured view of the pens displayed in the Process
Analyst. You use the Object View to view information about the pens on the
chart, along with information about associated tags.
See Also “Object View Basics” | “Using Object View” | “Configuring the Object View”

Object View Basics


The Object View displays a hierarchically arranged view of the panes and pens
on the chart, in the Object Tree column. The Object View lists information about
each pen. When displayed, the Object View is located under the navigation
toolbar.
The Object View (as it appears in a default configuration) is shown below; your
Object View might look different depending on how it has been customized in
your system.

By default, all items in the Object View are expanded (that is, all pens for all
panes are shown). Clicking a pen in the Object View selects that pen. There is
always one pen selected in each pane; in the example above, the primary
selected pen is highlighted in blue; all other selected pens are highlighted in
gray.
See Also “Pen Selection”
The Object View displays the following items:
Icon Object
Analog pen

Digital pen

Alarm pen

Pane

The check box controls whether the pen is visible on the chart. The gradient-
filled color box to the left of the pen name indicates the pen’s line color as it
appears on the chart.
32

The Object View always mirrors the items that are displayed on a chart. For
example, if you add a pane to the chart, a new pane is added simultaneously to
the Object View. Similarly, if a new pen is added to or deleted from a pane, or if
a pen’s properties are changed, these changes are reflected in the Object View.
The table below shows the predefined default columns, which are displayed in
addition to the object tree. These columns are arranged by default from left to
right in the Object View.
Column Description
Zero Scale Vertical axis start position of the pen.
Full Scale Vertical axis end position of the pen.
Engineering Units Engineering units associated with the pen.

You can configure the Object View to display other predefined columns that
show different information about your pens; for details, see “Configuring the
Object View”.

Using Object View


The table describes how to perform basic functions with Object View.
Task Description
Toggle the display of Object View on or off Click Toggle Object View on the main toolbar.
Change the size of Object View Drag the splitter bar that is located between the chart area and
the Object View up or down.
Expand or collapse a tree node in the Either click the (+) box to expand the node or the (-) box to
Object Tree column collapse the node; or double-click the item to toggle between
expanded and collapsed states. This does not affect the display
of panes in the chart.
Select a pen Click the pen in the Object View table. Selecting a pen in the
Object View gives the focus in the chart to the selected pen, and
vice versa. You can only select one pen per pane at a time (you
cannot select a pane).
Display or hide a pen Click to clear the check box to hide the pen; click the check box
again to display the pen.
Dynamically change the width of a column Drag the column divider left or right.
during display Note: You can quickly resize a column to fit the size of the
widest item in a column by double-clicking a column separator.
To resize the column back to its original size, double-click the
separator again. You can also configure the width of a column
via the Process Analyst Properties dialog; for details, see
“Configuring the Object View”.
See Also “Configuring the Object View”
Chapter 6: Printing and Exporting

You can print detailed reports of your Process Analyst trends for management
reports and other purposes. You can configure Process Analyst reports to
include other print options designed to maximize the business value of your
reports. You can also export pen data to the Windows Clipboard or to Microsoft
Excel.
Note: For details about general print options in Windows, refer to your
Windows documentation.
See Also “About Process Analyst Reports” | “Configuring Process Analyst Report
Options” | “Exporting Pen Data”

About Process Analyst Reports


Process Analyst reports are formatted automatically by the system to make
optimal use of the paper size and orientation. For example, if the page is small
and the report contains a lot of information, the reports will use a smaller font to
try to fit the information to the page. For larger pages, a larger font will be used.
Reports use an Arial font between 8-14 points.
34

A typical Process Analysis report looks like this:

This example shows a report of a chart titled Citect Process Analyst; the chart has
only one pane, which contains three analog pens. The topmost pen in the report
legend is highlighted, indicating that this pen is selected; consequently, the axes
shown in the report are associated with this pen. You can see that this pen is
selected in the chart by the “halo” effect surrounding the pen. The color boxes on
the left-hand side of the legend help you to distinguish between the pens.
To print a report:
„ Click Print. The Print dialog box appears. Click the Print button, or choose
Print from the right-click (context) menu.

Configuring Process Analyst Report Options


You can configure Process Analyst reports to contain such things as specific
items on a report legend (pen names, durations, engineering units, for example).
You can also include header information and page numbers.
You use the Print dialog box to configure Process Analyst reports. To display the
Print dialog box, click Print on the main toolbar. After configuring your reports,
click Print on the General panel of the Print dialog box to print your report.
See Also “Setting up report legends” | “Setting up report options”
35

Setting up report You can configure your reports to include report legends. The information in the
legends report legend is derived from the information properties of the underlying tag
that is associated with a pen. If there are no information properties defined for a
tag, this information isn’t available for a legend.
You set up your report legends by using the Legend panel of the Print dialog
box.
To set up a report legend:
1 In the Print dialog box, click the Legend tab. The Legend panel appears.

2 The panel shows, by default, the Pen Options, Statistical Analysis Options,
and Cursors lists (if there is a cursor currently displayed on the chart). The
options available to you might differ from the ones shown here.
3 Select the check box of the Pen Options you want to include in your report.
For details about these options, see “Configuring the Object View”.
4 Select the Statistical Analysis Options you want to include. Note that this
section is available only if the chart contains at least one analog or digital
pen.
„ Minimum - causes the minimum value from cache to be returned. Note
that this value might not be a real logged sample if the sample found is a
multiple calculated sample.
36

„ Maximum - causes the maximum value from cache to be returned. Note


that this value might not be a real logged sample if the sample found is a
multiple calculated sample.
„ Average - uses time-weighted averaging to determine the average for
both stepped and interpolated lines. This means that if a trend stays at a
value of 10 for 1 hour and then spikes quickly at a value of 50 for a
minute, the average will not be significantly affected.
5 Select the Cursors you want to include.
6 If you want to include a report legend, make sure the Include Legend check
box is selected.
7 Click Apply.

Setting up report You can configure your reports to include a report header, which can include a
options report title and comment. For multiple-page reports, you can include page
numbers, which appear at the bottom of each report page.
You set up your report options by using the Report panel of the Print dialog box.
To set up report options:
1 In the Print dialog box, click the Report tab. The Report panel appears.

2 In the Header Information area, type a Title for the report. If necessary,
include a Comment. Comments are printed under the report title on each
report page.
37

3 To include a header, make sure the Include Header check box is selected.
4 To include page numbering, make sure the Include Page Numbers check
box is selected.
5 Click Apply.

Exporting Pen Data


You can export Process Analyst data for pens that are visible to either the
Windows Clipboard (by using the Copy to Clipboard command) or to an
Microsoft Excel-compatible file (Copy to File).
When you export data, it is exported using a standard format of columns that
represent time, milliseconds, and then a column per pen, as shown here:
Time Milliseconds Pane1-Pen1 Pane1-Pen2 Pane1-Pen3
15/06/2004 01:17:25 100 NA 10 Off
15/06/2004 01:17:26 100 1 20 Low [Unacknowledged]
15/06/2004 01:17:27 100 Low [Acknowledged]
15/06/2004 01:17:28 100 3 25 Low [Acknowledged]

Export functionality doesn’t simply return the sample markers displayed on the
graph. Instead, it exports an interpolated value per display period from the start
time to the end time of the pen. The display period can be calculated by dividing
the time span of the pen by the
“IProcessAnalyst.NumberofSamples[Property][Get/Set]” property.
Before exporting the data, the Process Analyst sorts all the timestamps for all
pens from the earliest to the latest sample. When the pens are unlocked and have
different time spans, the data for each pen might have different timestamps. As
each entry is added to a row in the table, the value of the pen at that particular
timestamp is exported. If a pen does not have a sample for that timestamp, the
column for that pen is left blank.
An export will also write values of NA, GATED and all alarm states as localized
text when required.
Pen columns use the format <pane>-<pen> where pane is the name of the pane
that contains the pen, and pen is the name of the pen.
See Also “Copying data to the Clipboard” | “Copying data to file”

Copying data to the Copying pen data to the Clipboard allows you to paste the data into another
Clipboard application, such as an Excel spreadsheet.
To copy data to the Clipboard:
1 Select the pen(s) you want to copy data for.
2 Click Copy to Clipboard, or select Copy from the right-click (context) menu.

Copying data to file Copying pen data to Microsoft Excel allows you to manipulate the data using
spreadsheet application capabilities.
Notes
38

„ The Time column is an encoded (OLEDATE) double value, which holds the
date and time in seconds in local time. When exporting pen data to Excel,
you should change the format of the Time column to dd/mm/yyyy hh:mm:ss
so that the time is displayed correctly. Because the OLEDATE data type
excludes milliseconds, a separate column is provided, which exports the
millisecond component for each timestamp.
„ The results exported are in Unicode format. You should use Excel 2000 and
later, which support this format.
To copy data to file:
1 Select the pen(s) you want to copy data for.
2 Click Copy to File. The Save As dialog box appears.
3 Enter a filename and click Save. The data is exported in a delimited format.
4 Open the file you just created, and complete the Text Import Wizard.
Chapter 7: Configuring the Process Analyst

Many of the Process Analyst control’s properties can be configured at run time
to allow an Operator to customize the control to suit their working preferences.
To configure the Process Analyst, you use the Properties dialog box.
See Also “Using the Process Analyst Properties Dialog Box”
“Configuring Chart-wide Properties”
“Configuring Chart Panes”
“Configuring Pens”
“Configuring Cursors”
“Configuring Defaults”
“Configuring Toolbars”
“Configuring the Object View”
“Working with Views”

Using the Process Analyst Properties Dialog Box


You use the Process Analyst Properties dialog box to configure Process Analyst
views. You can also configure chart-wide properties.
The Properties dialog box has three tabs, “Main page”, “Toolbars”, and “Object
View”.

Main page You use the Main page of the Properties dialog box to configure general
properties and access the server path properties. The Main page looks like this:

The list on the left-hand side contains the property tree, a hierarchical list of
Process Analyst interface components. Selecting an item displays the property
40

controls for that component on the right. The pens in the property tree indicate
the information that the pen is trending.

Using the property tree right-click menu


Right-clicking an item in the property tree displays the shortcut menu for that
item, as shown below.

The tasks you can perform vary depending on your privilege level: if you don’t
have the required privilege at run time to perform an action, that control is
disabled/removed. For example, the right-click menu removes the Add Pen
option at run time if you don’t have the privilege to add a pen. Commands that
are unavailable appear “grayed-out.” The right-click menu contains the
following options:
Right-click this item... Actions
Chart Add Pane - add a new pane.
Add Cursor - add a new cursor.
Pane Add Digital - adds a new digital pen.
Add Analog - adds a new analog pen.
Add Alarm - adds a new alarm pen.
Note: After adding a pen from this menu, configure the data connection by
clicking the Connection tab and typing the name of the tag into the Tag text box.
Delete - deletes the pane.
Pen Delete - deletes the pen.
Cursor Delete - deletes the cursor.

Use the Main page for the following:


„ “Configuring Chart-wide Properties”
„ “Configuring Chart Panes”
„ “Configuring Pens”
„ “Configuring Cursors”
„ “Configuring Defaults”

Toolbars You use the Toolbars page to configure the main toolbar and navigation toolbar.
Operators and Users can configure the toolbars at run time and design time. Use
the Toolbars page to configure the toolbars; for details, see “Configuring
Toolbars”.

Object View You use the Object View page to configure the Object View. Operators and Users
can select (at run time and design time) the columns they want to display, as
well as change the column width and display order. Users can define new
columns and edit existing columns at design time.
41

Use the Object View page for the following:


„ “Configuring the Object View”
„ “Creating or Editing Object View Columns”

Configuring Chart-wide Properties


You use the Main page of the Process Analyst Properties dialog box to configure
chart-wide properties. Select Process Analyst at the top of the property tree to
display the Process Analyst properties page. This page contains two tabs,
General and Server Paths, used to modify the following configurations:
„ “Configuring general properties”
„ “Configuring server paths”

Configuring general You can configure general properties such as the background color of the chart,
properties the refresh rate, data request rate, number of samples for pens, and specify
whether chart pens should be locked. The Administration area indicates the
privilege setting for the current Operator.
To configure general properties:
1 Click the General tab on the Main page.

2 Click the color swatch and select a Background color.


3 Specify a Display refresh rate.
This value determines the rate at which the display data is refreshed on the
display; it also controls how often the position of the Now indicator is
refreshed. This control is disabled if you do not have appropriate privilege.
The default value is 1000 milliseconds. The permitted range is between 10
milliseconds to 60,000 milliseconds. Note that specifying a rate below 500 is
not recommended if your chart contains many pens, since this may
negatively affect performance.
4 Specify a Data request rate.
42

This value determines the maximum frequency of data requests. The


Process Analyst internally determines when a request is required, but you
can use this property to cap the Process Analyst’s performance.
This control is disabled if you do not have appropriate privilege. The default
value is 1000 milliseconds. The permitted range is between 10 to 60,000
milliseconds. Note that this property affects trend server performance.
5 Specify a Number of Samples.
This specifies the date/time axis span of each pen in number of samples. This
control is disabled if you do not have the appropriate privilege. The default
value is 300. The permitted range is between 10-5000. Also see “Exporting
Pen Data”.
Note: This value is closely tied to your display resolution. The default
setting is ideal for screen resolutions from 1024x768 to 1280x1024. The
association between Number of Samples and the display resolution occurs
because for each sample shown on screen the Process Analyst attempts to
leave a small gap to allow for sample markers. Because the Process Analyst
shows samples when they occur, it requires less data than a traditional trend
client. Retrieving data is expensive and the more data you retrieve the more
time the request takes. It is recommended that this parameter not exceed 500.
The chart has a minimum resolution of one millisecond per sample. If the
time span is reduced enough so that the number of samples exceeds the
number of milliseconds in the time span, the number of milliseconds in the
time span is used instead of the number of samples.
6 Select the Lock pens check box to lock your pens, or clear the check box to
turn off pen-locking. For details on pen locking, see “Locking/Unlocking
Pens”.
7 Click Apply.

Configuring server You can configure the file server locations that the Process Analyst uses to load
paths and save Process Analyst views, and displays the current Vijeo Citect run path if
the Process Analyst is embedded in a running Vijeo Citect system. This
command is disabled at run time if you do not have the appropriate privilege.
For details about saving and loading views, see “Working with Views” and
“Process Analyst View Synchronization”.
The Process Analyst uses four possible storage locations:
„ User - maps to the client machine’s logged-in user’s My Documents folder.
This option is available for any possible privilege and Vijeo Citect mode.
„ Primary - User-definable.
„ Secondary - User-definable.
„ Local - displays the current Vijeo Citect run path (read-only). This text box
only gets populated when the Process Analyst is running in Vijeo Citect
V6.0 or higher. This path is an Analyst Views subdirectory under the Vijeo
Citect current Run directory.
To configure server paths:
1 Click the Server Paths tab on the Main page.
43

2 Enter the location of the Primary file server.


3 Enter the location of the Standby file server (optional). This specifies the file
server to use if the primary file server is unavailable.
4 Click Apply.

Configuring Chart Panes


You use the Properties dialog box to configure chart panes. After adding a pane,
you can configure its size relative to other panes, as well as select a different
color. All pane properties can be configured during run time.
To add a pane:
„ In the property tree of the Properties dialog box, right-click the Process
Analyst view item at the top of the tree, and then select Add Pane. (To
remove a pane, right-click a pane in the tree and choose Delete.)
To configure the chart pane:
1 In the property tree of the Properties dialog box, select the pane you want to
configure. The properties for that pane appear.

Note: To configure defaults for your panes, select the Pane item in the
Default Settings node of the property tree, not a specific pane.
2 Click the color swatch and select a new Background color.
3 Select a Height option:
44

„ Variable - Automatically calculates the pane height based on the value


in the Size control. For example, if the chart contains two panes,
selecting this option and using a Size value of 110 will set this pane to
110% of the size of the other pane in the chart. Note that fixed height
panes have precedence of variable-size panes.
„ Fixed - Sets the pane height to the value specified in the Size control.
4 Specify a Size for the pane.
5 Click Apply.

Configuring Pens
The Process Analyst allows you to configure your pens to suit your preferences.
Pen configuration tasks are performed by using the Properties dialog box, which
is used for:
„ “Configuring pen appearance”
„ “Configuring pen gridlines”
„ “Configuring pen axes”
„ “Configuring pen quality”
„ “Configuring the pen data connection”
„ “Configuring cursor labels”

Configuring pen You use the Process Analyst Properties dialog box to configure the appearance
appearance of pens. Pen appearance can be configured at run time by Operators and Users
(and at design time by Users).
For details about pen appearance, see “Pen Types”.
Note: To configure default settings for pen appearance, select Analog, Digital,
or Alarm in the property tree under Default Settings, and then complete the
procedure below for the type of pen you want to configure.

Configuring analog and digital pens


Configuring the appearance of analog or digital pens involves selecting the line
color, stack property, line width, and either the method of interpolation (analog
pens) or fill color (digital pens).
To configure pen appearance:
1 Select the pen you want to configure.
2 Click the Appearance tab to display the appearance property controls.
45

3 Select a Line color using the color swatch.


4 Specify a Line width.
5 To stack a pen, select the Stacked option and then specify a Height in pixels
for the stack.
6 Do one of the following:
„ For analog pens, choose an Interpolation method. Straight causes a line
to be drawn directly between two data points. Stepped causes a line to
be drawn between points maintaining the value of the previous sample
until a sample with a different value arrives, in which case a vertical line
is drawn.
„ For digital pens, select the Filled check box, and then select a fill color
from the color swatch.
7 Click Apply.

Configuring alarm pens


Configuring the appearance of alarm pens involves selecting the line color, stack
property, line width, alarm type, and the properties for that alarm type.
To configure alarm pen appearance:
1 Select the pen you want to configure.
2 Click the Appearance tab to display the appearance property controls for
the selected alarm pen.
46

3 Select a Line color using the color swatch.


4 Specify a Line width.
5 To stack a pen, select the Stacked option and then specify a Height in pixels
for the stack.
6 Select an Alarm type. For details about the different types of alarm pen
available, see “Alarm pens”. For information about alarm states, see “Alarm
states”.
7 For each Label for the alarm type you selected, select a Style, a Fill color,
and/or a Hatch color by using the swatches.
8 Click Apply.

Configuring pen You use the Process Analyst Properties dialog box to configure the gridlines for
gridlines a selected pen. Pen gridlines can be configured at run time by Operators, and at
design time by Users.
For more information about pen gridlines, see “Gridlines”.
Note: To configure defaults for pen gridlines, select the All pens item in the
property tree under Default Settings, and then complete the procedure below.
To configure pen gridlines:
1 Click the Main Page tab.
2 From the property tree list, select the pen you want to configure gridlines
for.
3 Click the Gridlines tab to display the gridlines property controls.
47

4 In the Vertical: Major area, select a Style, specify a Width, and then select a
Color.
5 In the Vertical: Minor area, select a Style, specify a Width, and then select a
Color.
6 In the Horizontal area (analog pens only), select a Style for the minor
gridline, specify a Width, and then select a Color for the major gridline.
7 Do the same if necessary for the minor gridline.
8 Click Apply.

Configuring pen axes You use the Process Analyst Properties dialog box to configure the axis of the
selected pen. A pen axis can be configured at run time by Operators, and at
design time by Users.
You can configure the color, line width, label type, scroll and scale properties for
the date/time and value axes. You can also choose whether to display time on
the date/time axis using local or UTC format.
For more information about pen axes, see “Date/Time (Horizontal) Axis” and
“Vertical (Value) Axis”.
Note: To configure defaults for pen axes, select the All pens item in the property
tree under Default Settings, and then complete the procedure below.
To configure a pen axis:
1 Click the Main Page tab.
2 From the property tree list, select the pen you want to configure axes for.
3 Click the Axis tab to display the axis property controls.
48

4 In the Vertical area, select a Color by using the color swatch.


5 Enter a new Line width.
6 Select a Label type. This specifies the format to use for axis values.
7 Do one of the following (analog pens only):
„ Select the Autoscale option to autoscale the vertical axis.
„ Select the Interactive option, and then select Scale to be able to
interactively scale the vertical axis; and/or select Scroll to be able to
scroll the axis.
Note: These options are also available on the right-click (context) menu.
8 In the Horizontal area, select a Color by using the color swatch.
9 Select a Background color by using the color swatch.
10 Enter a new Line width.
11 Enter a Default Span to define the span you want to use for a new pen.
The default span is used by the Process Analyst when the Operator or User
clicks the Reset to Default Span button, or if the pen is added in pen
unlocked mode, or if the pen is the first one added to a display.
If you’re setting the span value as a default setting for all new pens, the new
span value is inherited by all news pens created.
12 Select the Local Time option to display the date/time axis in local time using
your machine settings. If this option is not selected, the time is displayed in
UTC format. For details about time display on the date/time axis, see “Date/
Time (Horizontal) Axis”.
13 Select Scale to be able to interactively scale the vertical axis.
14 Select Scroll to be able to scroll the axis.
49

Note: The Scale and Scroll options are also available on the right-click
(context) menu.
15 Click Apply.

Configuring pen quality You use the Process Analyst Properties dialog box to configure the quality of the
selected pen. Pen quality can be configured at run time by Operators, and at
design time by Users.
Configuring the pen quality allows you to define the appearance of sample
markers on a selected pen, as well as the line styles of the pen, based upon the
quality of the data being trended by the Process Analyst.
For details about how the Process Analyst represents data quality, see “Data
Quality”.
To configure pen quality:
1 Click the Main Page tab.
2 Select the pen you want to configure.
3 Click the Quality tab to display the quality property controls.

4 To enable points for the pen to be visible, select the Points Visible option.
5 In the Point Styles area, select a Single point style to represent a single data
sample.
6 Select a Multiple point style to represent multiple data samples.
7 Selected an Interpolated point style for interpolated data samples.
8 In the Line Styles area, select a line style to represent a Good sample.
9 Select a line style to represent a Gated/Disabled sample.
10 Select a line style to represent an NA sample.
11 Click Apply.
50

Configuring the pen You use the Process Analyst Properties dialog box to configure the pen data
data connection connection. This allows you to define the server, trend tag, and request mode for
the selected pen.
Pen connection can be configured at run time by Operators and Users that have
the appropriate privileges.
To configure pen data connection:
1 Select the pen you want to configure.
2 Click the Connection tab to display the connection property controls.

3 For the Server data connection, a <localhost> connection is selected by


default, indicating that the Process Analyst will connect to the Vijeo Citect
run time client running on the same computer, and pass its requests through
to the client, which will pass them onto the server.
4 In the Trend tag field, enter the trend tag for the pen. In a system with more
than one cluster, you should specify both the cluster and tag using the
format <cluster name.tag name>. Omitting the cluster name will cause an
error. If the system has only one cluster configured, you can just enter the
tag name. The configured cluster will be assumed.
5 Select a Request mode. The default is Average.
The request mode defines how multiple samples are treated by the Process
Analyst. Regardless of the request mode used, the timestamp for a sample is
always averaged.
6 Click Apply.
See Also “Data Compaction”

Configuring cursor You use the Process Analyst Properties dialog box to configure the pen cursor
labels labels. Configuring the pen cursor labels allows you to specify the color used for
51

the lines, background, and text on the cursor label. Note that the information
shown on a cursor label is predefined and cannot be changed.
For details about cursor labels, see “Using Cursor Labels”.
Pen cursor labels can be configured at run time by both Operators and Users that
have the appropriate privileges.
To configure cursor labels:
1 Select the pen you want to configure.
2 Click the Cursor Label tab to display the connection property controls.

3 Select a Line color from the color swatch.


4 Select a Background color from the color swatch.
5 Select a Text color from the color swatch.
6 Click Apply.

Configuring Cursors
You can configure the line width and line color of a selected cursor. Changes to
the cursor line color apply only to the currently selected cursor. For details on
cursors, see “Using Cursors”.
To configure the cursor:
1 In the property tree of the Citect Process Analyst Properties dialog box, click
the cursor you want to configure. The Appearance property controls appear.
52

2 Type in a new Width value, and/or select a new Color.


3 Click Apply.

Configuring Defaults
The defaults are a collection of properties that are inherited by each item (pane,
pen, cursor, and so on) when that item is created. These default properties are
maintained for the lifetime of the item until its properties are modified.
You configure these defaults in the same way as you configure the individual
components. The Default Settings node on the property tree contains the
following items:
„ All pens - configure the gridlines, axis, quality, connection, and cursor label
properties for all pen types. See “Configuring pen gridlines”, “Configuring
pen axes”, “Configuring pen quality”, “Configuring the pen data
connection”, and “Configuring cursor labels”.
„ Cursor - configure cursor defaults. See “Configuring Cursors”.
„ Analog - configure the appearance of analog pens. See “Configuring pen
appearance”.
„ Digital - configure the appearance of digital pens. See “Configuring pen
appearance”.
„ Alarm - configure the appearance of alarm pens. See “Configuring pen
appearance”.
„ Pane - configure the pane height and appearance defaults. See “Configuring
Chart Panes”.
53

Configuring Toolbars
The Process Analyst has two toolbars, the main toolbar and the navigation
toolbar. You use the Properties dialog box to configure the toolbars.

Operators can configure the Process Analyst toolbars by:


„ “Adding or removing toolbar commands”
„ “Changing the order of toolbar commands”
Users can perform additional tasks such as:
„ “Adding New Commands”
„ “Editing Existing Custom Commands”

Adding or removing Operators can add or remove toolbar commands during run time.
toolbar commands To add or remove commands from a toolbar:
1 From the Toolbar menu, choose the toolbar you want to customize (Main
Toolbar or Navigation Toolbar).
2 To add a command to the toolbar: In the Available toolbar buttons list,
select the command you want to add to the toolbar, and then click Add. The
selected command moves to the Current toolbar buttons list.
The Available toolbar buttons list contains all the command buttons
available in your system, including predefined as well as user-defined
commands.
3 To remove a command from the toolbar: In the Current toolbar buttons
list, select the command you want to remove from the toolbar, and then click
Remove. The selected command moves to the Available toolbar buttons
list.
54

Changing the order of Operators can change the order of toolbar commands during run time.
toolbar commands To change the order of commands:
„ Select a command in the Current toolbar buttons list and click Move Up or
Move down to move the selected command up or down the list as required.

Configuring the Object View


Operators can configure the Object View to display additional pen information
to the columns that are displayed by default. You configure the Object View by
using the Properties dialog box.
Operators can select which columns to display, as well as change the size of
existing columns and the column display order. Users can define new columns,
or edit or delete existing columns; for details, see “Creating or Editing Object
View Columns”.
You can configure the Object View to display these predefined columns:
Column Description
Scale Vertical axis start and end position of the pen.
Engineering Units Engineering units associated with the pen.
Comment The trend/alarm comment defined for the pen.
Start Time Date/time axis start position of the pen.
End Time Date/time axis end position of the pen.
Duration Difference between the start time and the end time.
Tag Pen’s associated trend or alarm tag.
Trend Type Trend type of associated tag.
Sample Period Sampling period of the associated trend tag.
Engineering Scale Engineering scale for associated trend tag.
Raw Scale Raw scale for associated trend tag.
Alarm Category Category of associated alarm tag.
Alarm Description Description of associated alarm tag.
Alarm Area Area of associated alarm tag.
Alarm Name Name of associated alarm tag.
Alarm Type Alarm type of associated alarm tag.
Error Displays the error of the last data request. Blank if last data request succeeded.
Minimum Lowest displayed value (trend tags only).
Maximum Highest displayed value (trend tags only).
Average Average of all displayed values (trend tags only).

For information on columns that are displayed by default, see “Object View
Basics”.

Object View properties The Object View properties page allows you to show or hide existing columns,
page create custom columns, edit existing columns, and re-order columns.
55

The Properties page displays all the available columns for the Object View and
their properties:
„ NameID - Internal identifier, which must be unique.
„ Width - Default width of the column in pixels.
„ Display Text - Title displayed in the column header.
The check boxes in the NameID column are bound to a column’s visibility: a
column is visible only if the associated checkbox is selected.
The Move Up and Move Down buttons to the right of the Available Columns
list box allow you to reorder columns. The order of the columns from top to
bottom in the list dictates their display order from left to right in the Object
View. Clicking Move Up or Move Down shifts the currently selected item up or
down respectively.
See Also “Creating or Editing Object View Columns”

Working with Views


An Operator can save the visual setup of a Process Analyst control by saving a
view, which is saved as a Process Analyst View (.pav) file. They can also load
views that have been created previously. A view saves the state of all
commands, as well as properties for all the Process Analyst components (panes,
pens, axes, backgrounds, and so on).
To save a view or to load a view, you use the Save View and Load View
commands, respectively, on the main toolbar.
56

Saving a view A Process Analyst view stores the trends and alarms that are being displayed,
the columns being viewed in the Object View, the toolbar buttons that are
available, as well as the “look and feel” of the view.
To save a view:
1 On the main toolbar, click Save View. The Save Process Analyst View dialog
box appears, showing the location where you can save views.

2 Choose a location to save your view to.


Note: It is your administrator’s responsibility to set up the correct directories
for saving views.
3 Enter a File name for your view, and then click OK.
To support redundancy, if the Local option is available and selected, Vijeo Citect
attempts to save the view to the primary, standby and local locations.

Loading a view When loading a view, the start time and end time of a view is restored only
autoscroll is off. If autoscroll is on, pens are synchronized to “Now.”
When loading a view, the only locations that are available (My Documents,
Primary, and Standby) are those that have been configured by your
administrator.
To load a view:
1 On the main toolbar, click Load View. The Load dialog box appears.
57

2 Select a view to load, and then click OK. The view is loaded.
58
Chapter 8: Operator Command Reference

You use the toolbar commands on the main toolbar and navigation toolbar to
perform commonly used functions for viewing and interacting with Process
Analyst data, such as adding or removing pens, displaying cursors, and so on.
Process Analyst has predefined commands, grouped into the following
categories:
„ “View Commands”
„ “Zoom Commands”
„ “Navigation Commands”
„ “Export Commands”
„ “Interface Commands”
„ “General Commands”
The toolbars in your run time environment might have been customized during
implementation, so not all these commands might appear on your toolbars.
Additionally your toolbars might have custom commands not described here.
The tables describe the default set of commands delivered with the Process
Analyst.

View Commands
The Process Analyst has the following view commands by default:
Icon Tooltip Description
Save View Displays the Save File dialog box allowing an Operator to save a Process
Analyst view to a specified location. For details, see “Saving a view”.
Load View Displays the Load View dialog box allowing the operator to specify a view
to load. For details, see “Loading a view”.

See Also “Zoom Commands” | “Navigation Commands” | “Export Commands” |


“Interface Commands” | “General Commands”

Zoom Commands
The Process Analyst has the following zoom commands by default:
Icon Tooltip Description
Toggle Box Zoom Toggles the Process Analyst into box zoom mode. The mouse cursor
changes to a crosshair used to define an area to zoom in on. Zoom may
be cancelled by right-clicking or toggling the Zoom command off. For
details, see “Toggle Box Zoom”.
Zoom in 50% Executes a horizontal and vertical zoom in of 50% of the current span(s)
of the pen(s). For details, see “Zoom In/Zoom Out”.
Zoom out 50% Executes a horizontal and vertical zoom out of 50% of the current
span(s) of the pen(s). For details, see “Zoom In/Zoom Out”.
60

Icon Tooltip Description


Undo Last Zoom Undoes the last zoom operation. For details, see “Undo Last Zoom”.

Reset to Default Span Restores the pen(s) spans to their original default settings. For details,
see “Reset to Default Span”.
Edit Span Displays the Edit Span dialog box allowing an operator to explicitly enter
a time span to apply to the display. For details, see “Edit Span”.
Edit Vertical Scale Enabled when an analog pen is selected. For details, see “Edit Vertical
Scale”.
See Also “View Commands” | “Navigation Commands” | “Export Commands” |
“Interface Commands” | “General Commands”

Navigation Commands
The Process Analyst has the following navigation commands by default. For
details about these commands, see “Navigating time”.
Icon Tooltip Description
Toggle Span Lock Toggles the locking of the time span. A time span is the “distance” in time
between the start time and end time of the chart. For details, see “Span
Lock”.
Back One Span Moves the pen(s) back in time exactly one time span. For details, see
“Navigating time”.
Back Half a Span Moves the pen(s) back half a span. For details, see “Navigating time”.

Forward One Span Moves the pen(s) forward in time exactly one span. For details, see
“Navigating time”.
Forward Half a Span Moves the pen(s) forward half a span. For details, see “Navigating time”.

Synchronize to Now Synchronizes pen(s) such that the end date time reflects “now” which is
positioned on the right-hand edge of the screen. “Now” is calculated
using the current system time. For details, see “Synchronize to Now”.
Toggle Auto-Scrolling Toggles the automatic scrolling off and on for all pens. For details, see
“Toggle Autoscrolling”.

See Also “View Commands” | “Zoom Commands” | “Export Commands” | “Interface


Commands” | “General Commands”

Export Commands
The Process Analyst has the following export commands by default:
Icon Tooltip Description
Export to File Copies visible pens to an Excel compatible file. For details, see “Copying
data to file”.
Copy to Clipboard Copies visible pens to the clipboard.Interface Commands. For details, see
“Copying data to the Clipboard”.

See Also “View Commands” | “Zoom Commands” | “Navigation Commands” |


“Interface Commands” | “General Commands”
61

Interface Commands
The Process Analyst has the following interface commands by default:
Icon Tooltip Description
Show/Hide Cursor Toggles the display of cursors. For details, see “Using Cursors”.

Show/Hide Cursor Labels Toggles the display of cursor labels. Enabled only when a cursor is
visible and when a pen exists. For details, see “Using Cursor
Labels”.
Show/Hide Points Toggles the display of points representing where sample data was
recorded in the archive. For details, see “Pens: An Overview”.
Lock/Unlock Cursor Labels Toggles the locking/unlocking of cursor labels. Enabled only when a
cursor is visible and when a pen exists. For details, see “Using
Cursor Labels”.
Lock/Unlock Pens Toggles the locking/unlocking of pens. For details, see “Locking/
Unlocking Pens”.
Add Pane Adds a new pane to the view. For details, see “Configuring Chart
Panes”.
Remove Pane Removes the pane of the primary selected pen. A dialog confirms
the delete. For details, see “Configuring Chart Panes”.
Autoscale Vertical Axis for Toggles autoscaling for the selected pen on a per-pen basis. For
Analog Pens details, see “Scaling the Chart”.
Lock/Unlock Vertical Axis Toggles interactive scrolling of the vertical axis and disables
Scrolling autoscaling. For details, see “Scrolling the Chart”.
See Also “View Commands” | “Zoom Commands” | “Navigation Commands” | “Export
Commands” | “General Commands”

General Commands
The Process Analyst has the following general commands by default:
Icon Tooltip Description
Add Pen Displays the add pen dialog. For details, see “Adding Pens”.

Remove Pen Removes the selected pen from the display. For details, see “Deleting
Pens”.
Toggle Object View Toggles the display of the Object View. For details, see “Using the Object
View”.
Print Displays the print dialog, allowing the user to print the current state of the
Process Analyst. For details, see “Printing and Exporting”.
Refresh Data Refreshes the data for the selected pen, or all pens (if locked).

Show Properties Displays the Process Analyst Properties dialog box. For details, see “Using
the Process Analyst Properties Dialog Box”.
Help Displays the Process Analyst Help.

See Also “View Commands” | “Zoom Commands” | “Navigation Commands” | “Export


Commands” | “Interface Commands”
62
Part 1I
Process Analyst for Users

This section contains information for Users and describes the following:
“Integration with Vijeo Citect”
“Configuring Process Analyst Design Time Properties”
“Using the Process Analyst Command System”
“Automation Model”
Chapter 9: Integration with Vijeo Citect

The Process Analyst integrates seamlessly into the Vijeo Citect system and is
designed to work primarily with the Vijeo Citect Graphics Builder and the run
time environment. But the Process Analyst can also be embedded in custom
Visual Basic and .NET applications. In these situations Vijeo Citect is still
required.
See Also “Configuring the Process Analyst Control from Graphics Builder” | “Security
and Permissions” | “Multi-language Support” | “Persistence” | “Backing up
Projects”

Configuring the Process Analyst Control from Graphics Builder


Being an ActiveX control, you can insert the Process Analyst onto a Vijeo Citect
graphics page. To do this, do one of the following:
„ In Graphics Builder, choose Edit | Insert ActiveX Control. The Insert
ActiveX dialog box appears. Double-click the Citect Process Analyst
Control item in the ActiveX Controls list box. The control is inserted onto
the graphics page and the Properties dialog box appears.
„ Click the Process Analyst button in the Graphics Builder toolbox.

After inserting the Process Analyst into a page, you can resize it into position. To
view the configuration pages for the Process Analyst, double-click the Process
Analyst control. For details on configuring the design time properties for the
Process Analyst, see “Configuring Process Analyst Design Time Properties”.
See Also “Persistence”

Tag association Vijeo Citect can bind a Vijeo Citect tag to an ActiveX property and update either
the tag or the property, based on a specified ActiveX event. You should note that
the Process Analyst control does not support this feature.

Security and Permissions


The Process Analyst integrates seamlessly into the Vijeo Citect security model by
allowing access to certain Process Analyst features based on the privilege level
of the currently logged in Operator.
The Process Analyst has nine privilege levels. Privilege level zero (0) indicates
there is no security and any user can perform the function. Levels 1-8 map
directly to the eight (8) privilege levels of security provided by Vijeo Citect. The
Process Analyst, by default, assumes the area of the page that it is situated on;
this can be changed in the Graphics Builder. So if an operator has area access for
the page and has privilege level 1, and the function they want to use is level 2,
the function will be unavailable. If the operator had level 2, the function would
66

then become available. The Process Analyst also supports the Vijeo Citect
Hierarchical Privilege security option.
Security can be applied to the following features:
„ Administration; for details, see “Administration privilege”.
„ Commands; for details, see “Command privilege”.
„ Saving Process Analyst views (write privilege); for details, see “Write
privilege”.

Administration privilege The Process Analyst also uses an Administration privilege level to disable
engineer-oriented features at run time. For example, the ability to add new
custom commands and so on are all disabled if the Operator does not meet the
required privilege level. The Administration privilege level should never be zero
on a running system as this would expose properties to an Operator, which
could adversely affect the performance of the client and/or server (e.g., Number
Of Samples property).
The features that are disabled when an operator does not meet the
Administration privilege level include:
„ Add Pen context menu in Property dialog box.
„ New/Edit/Delete command (includes changing the privilege of commands).
„ New/Delete Column.
„ Data Refresh Rate property.
„ Display Refresh Rate property.
„ Number Of Samples property.
„ Server Paths tab.
„ Server field on Connection tab.
„ Tag field on Connection tab.
To modify the Administration privilege level, see “Configuring Chart-wide
Properties”.

Command privilege The Process Analyst allows a privilege level to be assigned to each command
(standard or custom command). If an Operator does not have the required
privilege level to use that command, the associated toolbar button is disabled
and cannot be executed.
See Also “Editing Existing Custom Commands”

Write privilege The Process Analyst uses a concept of “write” privilege level to control whether
an operator can save Process Analyst views to a location other than "My
documents". These views can then be loaded into the Process Analyst later by
any Operator. The write privilege is set at design time on the Server Paths
property page located on the root Process Analyst node in the Property pages
dialog box. If the write privilege level is set to zero (0), any operator can save to
any location. If the write privilege is any other level, the Operator must have that
67

privilege level to be able to save an Analyst view to a location other than "My
Documents".
See Also “Configuring server paths” | “Working with Views” | “Process Analyst View
Synchronization”

Multi-language Support
The Process Analyst supports the Vijeo Citect multilanguage ability of changing
the user interface language dynamically at run time. If the language is changed
in Vijeo Citect, the Process Analyst will change its language to match.
The process of configuring the Process Analyst for multiple languages is
different from that of Vijeo Citect. This section describes how to localize the
Process Analyst user interface and get it to work with Vijeo Citect.

Understanding the The Process Analyst uses a special file, called Resources.dll, to store all of its
Process Analyst display strings and dialog boxes. This file holds the native translations for your
version of the Process Analyst; these native translations are considered the
resources
default language. For example, the Japanese version of the Process Analyst will
contain Japanese resources inside the Resources.dll file.
A separate Resources.dll file must be created for each individual language that
you want to support in your system. The file should be renamed using a special
format to indicate the language. The Process Analyst expects the file to be
named Resources_<LanguageCode>.dll, where <LanguageCode> is the unique
identifier of your dll.
For example, if you are creating French resources, your dll should be named
Resources_fr.dll. Vijeo Citect uses the RFC 1766 standard for specifying culture
names.
See Also “Creating your own Process Analyst resource.dll”
All language Resources*.dll files must be placed in the same directory as the
Analyst.dll file.
The example below shows a system that contains English as the default, and has
alternative languages of French, German and Chinese.
„ Resources.dll (default - any language, e.g. English)
„ Resources_fr.dll (French standard)
„ Resources_zh-CN.dll (Chinese PRC)
„ Resources_de.dll (German)

Using Vijeo Citect to Vijeo Citect uses the Cicode function SetLanguage to switch languages at run
switch the Process time. To allow the Process Analyst to determine the language it should display,
you must map your Vijeo Citect language databases to the Process Analyst
Analyst language
resource files.
To do this, add a new .ini section called [ProcessAnalyst] to the Citect.ini file
on all your Vijeo Citect clients and servers, and create a mapping for each
language. (Note that this section might already exist in your Citect.ini file.) The
mapping must use this format:
68

LanguagePath.<dbf>=<ProcessAnalystLanguage>
where <dbf> is the name of a specific Vijeo Citect language translation database,
and <ProcessAnalystLanguage> is the language code of the resources.dll file
that has the equivalent translations.
For example,
[ProcessAnalyst]
LanguagePath.French=fr
LanguagePath.Chinese=zh-CN
LanguagePath.German=de
The last step is to ensure each of your machines contains the necessary language
fonts. Windows XP and Windows 2000 both provide facilities to add the
necessary languages to your machine via the Regional and Language Options
dialog box, accessible from the Control Panel. This step is essential if you want
to use Asian languages on an English operating system. See “Creating your own
Process Analyst resource.dll” for details on adding languages to your system.
With the .ini file now configured, languages installed, and the Resource.dll files
in place when the SetLanguage Cicode function is called, Vijeo Citect and the
Process Analyst will automatically change into the selected language.

Manually switching The Process Analyst can also switch languages by itself using the
languages IProcessAnalyst.Language property. You can call this property directly from
Cicode, for example.
Note: Using this method will only switch the Process Analyst language and not
the one used by Vijeo Citect. See “IProcessAnalyst.Language [Property] [Get/
Set]”.

Specifying languages A Process Analyst running inside a Vijeo Citect Web Client also supports run
for the Web Client time language switching, but you must configure the languages that the Web
Client will download to the client machine.
To configure the languages to download:
1 Create a zip file in the Vijeo Citect \bin folder called bin.zip.
2 Add to the zip file all the language resource DLL files that you want the
client to download and use. (You can find these files in your \Program
Files\Common Files\Citect folder.)
Note: The bin.zip file and its contents are not version-checked. This means
you must manually remove the bin.zip from the Web Client machines if
your server contains a more recent bin.zip file. To do this:
1 Find the installation directory of the Analyst.dll file on your Web Client
machines and look for a file called bin.zip in this directory.
2 Delete this file.
3 Reconnect to the Web server to download the latest bin.zip file.

Creating your own To create your own resources dll, you need to do the following:
Process Analyst 1 Install the specific languages you are localizing on your Windows system.
resource.dll 2 Set your system to use that specific language.
69

Note: To create your own resources.dll file, you’ll need to use Microsoft
Developer Studio 6 or an equivalent tool.

Setup for localization on Windows XP


You must have Administrator privileges to perform the following setup.
1 Open Control Panel and double-click Regional and Language Options.
2 Click the Languages tab.
3 If localizing for East Asian languages, select the Install files for East Asian
languages check box, then click OK.
4 Once the languages are installed, click the Languages tab in the Regional
and Language Options dialog box.
5 Click Details in the Text services and input languages section to display the
Text Services and Input Languages dialog box.

6 In the Installed services section, ensure that the language you want to
localize with is listed. If not, add it.
1 To add a language, click Add to display the Add Input Language dialog
box.
2 Select the language you want from the Input language menu and click
OK. (You might need your original Windows Installer CD.)
3 You might need to restart your system before the language is available.
If not, click Apply and then OK to close the Text Services and Input
Languages dialog box and return to the main window under the
70

Languages tab. If you need to restart your system, return to the Regional
and Language Options dialog box after logging back into Windows. Be
sure to login as an Administrator.
7 Click the Advanced tab in the Regional and Language Options dialog box.
8 Select the language you want from the menu in the Language for Non-
Unicode Programs section.
9 Click Apply and then OK (you may need to restart your system).

Setup for localization on Windows 2000


You must have Administrator privileges to perform the following setup.
1 Open Control Panel and double-click Regional Options.
2 On the General tab under Language Settings for the System, make sure the
language you want to localize with is in the list and "Checked". If it is not,
you must add it.
1 To add a language, click the Input Locales tab.
2 Click Add to display the Add Input Locale dialog box.
3 Select the language you want from the list.
4 Click OK and follow the on-screen prompts.
Note: You will need your original Windows Installer CD.Once the
language has been installed, repeat steps 1 and 2, and continue on to 3.
3 Click the Input Locales tab.
71

4 Ensure that your language is listed in the Installed input locals list.
5 Click back to the General tab.
6 Click Set default to display the Select System Locale dialog box.
7 From this list, select the language that you want to localize to and click OK.
This step is essential if you are using Asian characters on an English system.
(This may require a system restart.)
Note: When you are finished localizing, you should switch this option back to its
original setting.

Changing the input language


When your system has been configured to use multiple languages, you will find
a new icon in the system tray displayed as "EN" or similar.
To change input language:
1 Click EN to display the input language option menu.

2 Select the language you want to use (to work correctly with Visual Studio,
this should match the language you selected in Step 8 of the Windows XP
setup and Step 7 of the Windows 2000 setup). This might display a
language-specific IME editor, which allows you to select characters to use in
your translations.

Localizing the Process Analyst resource dll


Once you have set up your system to cope with multiple languages, you can
begin localizing. Do the following:
1 Open Microsoft Visual Studio 6.
2 Choose File | Open.
72

3 Browse to the location of the Process Analyst's Resources.dll file. By default


it is located at C:\Program Files\Common Files\Citect\.
4 Ensure that the Files of type menu has Executable Files (.exe;.dll;*.ocx)
selected.
5 Ensure that the Open as menu has Resources selected.
6 Select Resources.dll and click Open.

7 Save the file under a new name. For example, if you are localizing for
Japanese, use Resources_ja-JP.dll. See “Understanding the Process Analyst
resources” for naming conventions.
8 Before changing any string, you must change the language code for each
dialog box and the string table by doing the following:
1 Expand the String Table folder in the tree.
2 Right-click the String Table entry.
3 Choose Properties from the right-click (context) menu (see below).
4 From the Language menu, select the language that you are localizing
for.
5 Click Close in the top-right corner of the dialog.
6 Repeat these steps for each of the dialogs inside the Dialog folder.
Once the language code has been set for all dialogs and the string table, you are
ready to begin changing the text.
Localizing dialog boxes To localize a dialog box, do the following:
1 Expand the Dialogs folder in the tree.
2 Double-click a dialog to edit.
3 Select an item of text and right-click to display the properties for that item.
4 Enter your replacement text into the Caption field.
5 Click the Close button in the top-right corner of the dialog box.
You should note the following:
73

„ Controls can be repositioned or resized if necessary to fit your replacement


text.
„ Never resize a dialog box. The size of a dialog box is set to an optimum size
so that it integrates into Graphics Builder correctly.
„ Dialogs 3028 and 3050 do not require translation.
Localizing the String Table To localize the string table, do the following:
1 Expand the String Table folder in the tree.
2 Double-click the String Table entry. This will display a table showing you
all the strings of the Process Analyst.
3 Double-click an entry to display the Properties dialog box.
4 Type in the replacement text in the Caption box.
5 Click the Close button in the top-right corner of the dialog box.
Note: When translating strings, if a string contains “%s”, “%x”, “%d” and so on,
do not remove or replace those symbols as they are important to the Process
Analyst.

Persistence
Persistence refers to saving the state (properties, pens, and so on) of the Process
Analyst to disk. Vijeo Citect and the Process Analyst provide the following
methods of persistence:
„ Saving as part of a Citect Graphics Builder page (design time)
„ Save View toolbar button on the Process Analyst (run time)
„ SaveToFile automation method on the Process Analyst (run time)
„ Saving between Citect page transitions (run time)

Saving while using the This feature allows you to configure the default look and/or what pens will be
Citect Graphics Builder displayed on the Process Analyst at design time while you are designing your
graphics pages. Design time is the appropriate time to configure the appearance
properties, toolbar buttons and, most importantly, the security of the Process
Analyst since these will become the default settings of the Process Analyst when
your page is displayed at run time.
When a page containing the Process Analyst is saved in the Graphics Builder all
the properties you configured on the Process Analyst will be stored within the
Graphics Builder page.
Note: When defining new custom toolbar buttons, any icon you assign will be
copied and also stored within the Graphics Builder page. This allows your
custom toolbar buttons to work on any machine.

Using the Save View This feature is valid only at run time and allows operators to save the current
toolbar button state of the Process Analyst (called a view) to a standalone file. These files can be
loaded during run time, and are an efficient way to store commonly used pen
configurations.
74

Using the SaveToFile This feature is valid only at run time and allows a user to write Cicode to save
automation method the current state of the Process Analyst to a standalone file, referred to as an
Analyst view. These files can be loaded during run time using the
LoadFromFile automation method (or the Load View toolbar button). Views
and are an efficient way to store commonly used pen configurations.

Saving between Vijeo Using Vijeo Citect run time, if you modify the Process Analyst (for example,
Citect page transitions changing the timespan of a pen) and move off the page, your changes will be
lost. This behavior is not always what you want, so the Citect Graphics Builder
(Run-time)
provides an option Persist ActiveX data between page transitions to save the
state of an ActiveX control when you switch between pages.
Enabling this option causes Vijeo Citect to write a temporary file to the Vijeo
Citect Data directory in the format of <Event class>.stg whenever you leave a
page that contains an ActiveX object (e.g., the Process Analyst). When you
reenter the page, Vijeo Citect looks for that same file and, if found, will load the
settings from it. These files only exist while Vijeo Citect run time is running.
When you shut down Vijeo Citect, the temporary *.stg files are deleted.
To save between page transitions:
1 Double-click the Process Analyst ActiveX control you want to change. The
Properties dialog box appears.
2 Click the Access tab.
3 Click the Identification tab. The Identification panel appears.

4 In the Persistence area, select the Persist ActiveX data between page
transitions check box, and then click Apply.

Resetting back to the You can reset the original configuration of the Process Analyst control by calling
default state the Cicode function ObjectResetState. This function takes the object handle of
the Process Analyst control, which you retrieve by using the Cicode function
ObjectByName.
75

Backing up Projects
When you save views to the Local storage location, the Process Analyst will
create a *.pav file in an Analyst Views subfolder under your project directory. If
your project contains Analyst views, you should ensure that the Save sub-
directories option is selected in Citect Explorer before backing up your project.
76
Chapter 10: Configuring Process Analyst
Design Time Properties

Most Process Analyst properties can be defined or modified during run time
and design time. This section describes properties that can be configured only
during design time, usually by a User.
For information about configuring run time properties, see “Using the Process
Analyst Properties Dialog Box”.
See Also “Adding New Commands” | “Editing Existing Custom Commands” |
“Creating or Editing Object View Columns” | “Process Analyst View
Synchronization”

Adding New Commands


Users can define new toolbar commands during design time if they have the
appropriate privilege level.
To add a new command:
1 On the Toolbars page of the Properties dialog box, click New. The New
Command dialog box appears.

2 The dialog shows the unique, system-generated ID for the new command. If
necessary, enter a new ID for the command. This ID can be used in Cicode
to determine which command has been triggered or to find a specific
command in the Vijeo Citect system.
78

3 Enter the Tooltip text for the new command. You are limited to 64
characters. Tooltip text appears when the mouse pointer is over the toolbar
command.
4 Click Browse and navigate to the icon to represent the new command. The
icon image appears on the toolbar command button.
5 To define how the command behaves, choose a button style from the Button
style menu:
„ Push Button - click the Enabled check box to set the default appearance
of the button when the button is enabled or disabled.
„ Toggle Button - click Enabled or Pressed to specify the “on”
appearance.
See Also “Editing Existing Custom Commands”

Editing Existing Custom Commands


Users can edit existing toolbar commands if they have the appropriate privilege
level. Commands can only be edited during design time, and only fields for
custom commands can be edited.
To edit an existing custom command
1 Open the Properties dialog box and click the Toolbars tab.
2 Select the command you want to edit in the Available toolbar buttons list
box, and then click Edit. The Edit Command dialog box appears.

3 If required. click Browse to navigate to a new icon to use for the command.
4 If required, edit the Tooltip text. The maximum length for Tooltip text is 64
characters.
5 If required, choose a new button style from the Button style menu.
See Also “Adding New Commands”
79

Creating or Editing Object View Columns


Users can create or delete Object View columns (during design time), as well as
edit existing columns (run time or design time). Object View columns display
information about your pens. All these configuration tasks are performed by
using the Citect Process Analyst Properties dialog box.
To create an Object View column:
1 Click the Object View tab. The Object View panel appears.
2 Click New. The New Column dialog box appears.

3 Enter a Name ID for the column. The value is used to reference the column
in code.
4 Specify a Width.
5 Enter the Text to use for the column in the Object View display.
To delete an Object View column:
„ Select the column you want to delete and click Delete.
To edit an Object View column:
1 Select the column you want to edit, and then click Edit. The Edit Column
dialog box appears.
2 Modify the information as required, and then click OK.
See Also “Configuring the Object View”

Process Analyst View Synchronization


The Process Analyst implements a basic level of file synchronization for Process
Analyst views (.pav files). This feature causes the Process Analyst to try and
obtain the latest version of a .pav file before displaying it to the operator.
To achieve this, an engineer must first configure the Process Analyst to support
Primary and Standby server locations for Analyst Views; for details, see
“Configuring server paths”.
With these file servers in place, the Process Analyst now has a central location
from which to obtain Process Analyst views. If one of the locations is
unavailable, the operator can try the alternate location. When a client saves or
80

loads a Process Analyst view, only that view on the Primary and Standby server
locations will be synchronized to ensure they are all the same.
The table below outlines the rules of synchronization and privilege for the
storage locations and client modes when loading and saving Process Analyst
views.
Action Vijeo Citect mode Privilege Available Storage Locations*
Load Normal client Both** The Primary and Standby options appear as configured
as well as My Documents. If either are invalid or
unavailable paths, they do not appear. If both are invalid
or unavailable, the Local option appears. Default order is
Primary, Standby, My Documents, and Local, My
Documents respectively. Synchronization occurs when
loading from a Primary or Standby location.
Load Web client Both** The Local and My Documents options are the only ones
available. Local maps to the project directory\Analyst
Views. The default order is Local, My Documents.
Save Normal client Privileged The Local and My Documents options are the only ones
available. Local however will attempt to save to all server
locations as well as the project directory. The .pav file will
be saved to all available locations from primary, standby
and project directories. Default order: Local, My
Documents.
Save Normal client Unprivileged The My Documents option is the only one available.
Save Normal client Both** The My Documents option is the only one available.

* Refers to the Look in menu on SaveView and Load View dialog boxes.
** Means both privileged and un-privileged.
When setting up file-servers to store Process Analyst views, ensure that each
client machine has privileges enabling it the desired read/write access to those
locations.
See Also “Configuring server paths” | “Working with Views” | “Write privilege”
Chapter 11: Using the Process Analyst
Command System

This section describes how to use the Process Analyst command system.
See Also “Command System Overview” | “Custom Commands” | “Icons”

Command System Overview


The Process Analyst provides an extensive command system allowing
manipulation of common Process Analyst features, as well as providing the
framework for creating custom user-defined commands.
The command system is configurable via the Toolbar property page and the
automation model.
To access the command system via the automation model, call the property
GetCommandSystem() from the IProcessAnalyst interface. For details, see
“IProcessAnalyst Interface”.

Custom Commands
Custom commands are defined in the Process Analyst, but must be
implemented in Cicode. You define commands by using the ICommandSystem-
> Create method, or by using the New button on the Toolbar property page.
To implement the command, you must respond to the event CommandExecuted
(and optionally UpdateCommand). Both of these events notify you of the ID of the
command which needs to be handled.

CommandExecuted When an operator presses the toolbar button representing your command, it will
trigger this event. This is your opportunity to execute the desired functionality
of the command. This will not be triggered if the logged-in user fails to meet the
required privilege level. Be aware that this is an asynchronous operation.

UpdateCommand When the Process Analyst requires the Enable state or pressed states of its
toolbar buttons to be refreshed, this event will be triggered. This will not be
triggered if the logged-in user fails to meet the required privilege level. Note
that this is asynchronous operation.
The state of all commands (custom and pre-defined) will be saved to disk
whenever the Process Analyst configuration is saved.
See Also “Persistence”

Icons
For custom commands, the user can specify their own custom icons by pointing
to a file on their hard drive. As these files may be deleted or moved over time,
the Process Analyst makes an instant copy of the icon into memory when the
82

command is added. This removes any dependence on the original icon file.
When the Process Analyst configuration is saved, the icon data is also saved.
Chapter 12: Automation Model

The automation model allows applications or solutions to programmatically


configure the Process Analyst control’s appearance, performance, and behavior.
The automation model also allows code, via automation events, to be attached to
events fired from the Process Analyst Control and perform custom behavior.
The automation model allows almost every visual aspect of the control to be
configured, as well as performance. It is simple and follows a traditional object-
oriented approach (see below).
To view information for an interface, click the name of the interface in the
illustration below. For example, to view information for the IPens interface, click
IPens.

Execution Results
Each property and method listed in the automation model will return one of the
following results upon execution. The exact meaning is described in the
Execution Result section for each property or method.
Execution Result Cicode VBA C++
InvalidArgument 274 5 E_INVALIARG
GeneralFailure 356 2147500037 E_FAIL
PathNotFound 356 76 STG_E_PATHNOTFOUND
Success 0 - S_OK

Errors are captured differently in Cicode and VBA. The following code
examples show how to trap and handle errors in VBA and Cicode.
[VBA]
Sub VBATest(myObject As Object)
On Error Goto errHandler
myObject.<function>
84

Exit Sub
errHandler:
Print Err.Number, Err.Description
Resume Next
End Sub
[Cicode]
FUNCTION Test1(OBJECT hObject)
ErrSet(1); // Enable User error checking (disabled HW alarm)
IF ObjectIsValid(hObject) THEN
_ObjectCallMethod(hObject, "<function>");
error = IsError();
errorMessage = IntToStr(error)
IF (error <> 0) THEN
Message("An error occured", errorMessage, 0);
END
END
ErrSet(0); // Enable hardware alarm reporting of errors
END

Interfaces
IAlarmPen Interface
IAnalogPen Interface
ICommand Interface
ICommandSystem Interface
ICursors Interface
IDigitalPen Interface
IObjectView Interface
IObjectViewColumn Interface
IObjectViewColumns Interface
IObjectViewItem Interface
IObjectViewItems Interface
IObjectViewPenItem Interface
IPane Interface
IPanes Interface
IPen Interface
IPens Interface
IProcessAnalyst Interface
IToolbar Interface
IToolbars Interface
IToolbarButton Interface
IToolbarButtons Interface
ITrendCursor Interface

Events
CommandExecuted [Event]
CursorMoved [Event]
Error [Event]
HorizontalAxisChanged [Event]
MouseClick [Event]
MouseDoubleClick [Event]
OVColumnAdded [Event]
OVColumnRemoved [Event]
OVItemAdded [Event]
85

OVItemChecked [Event]
OVItemSelected [Event]
PenCreated [Event]
PenDeleted [Event]
PenRenamed [Event]
PenSelectionChanged [Event]
PropertyChanged [Event]
UpdateCommand [Event]
VerticalAxisChanged [Event]

Enumerations
AlarmType [Enumeration]
AxisLabelType [Enumeration]
ErrorNotifyCode [Enumeration]
FileLocation [Enumeration]
HatchStyle [Enumeration]
LineStyle [Enumeration]
LineType [Enumeration]
PenNameMode [Enumeration]
PenType [Enumeration]
PointType [Enumeration]
QualityCompactionType [Enumeration]
QualityType [Enumeration]
RequestMode [Enumeration]
ToolbarButtonType [Enumeration]

IAlarmPen Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IAlarmPen
Methods (6)
IAlarmPen.GetFillColor [Method]
IAlarmPen.SetFillColor [Method]
IAlarmPen.GetHatchColor [Method]
IAlarmPen.SetHatchColor [Method]
IAlarmPen.GetHatchStyle [Method]
IAlarmPen.SetHatchStyle [Method]
Properties (3)
IAlarmPen.LineColor [Property][Get/Set]
IAlarmPen.LineWidth [Property][Get/Set]
IAlarmPen.AlarmType [Property][Get/Set]

IAlarmPen.LineColor Gets or Sets the color that will be used to draw the pen line.
[Property][Get/Set] Defined As
„ [VBA] Long LineColor
„ [Cicode] INT LineColor
86

„ [C++] OLE_COLOR LineColor


Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted the return value will be GeneralFailure.
Remarks
The color value can be calculated using the following formula:
color = (65536 * Blue) + (256 * Green) + (Red)
where red, green, and blue are 0-255.
Calling Syntax
This example assumes there is a valid alarm pen object to be passed into the
example methods.
[VBA]
Sub Example(alarmPen As Object)
Dim lineColor As Long
‘Getting Property value
lineColor = alarmPen.LineColor
‘Setting Property to red
alarmPen.LineColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hAlarmPen)
// Getting property value
INT nLineColor = _ObjectGetProperty(hAlarmPen, "LineColor");
// Setting property to red
_ObjectSetProperty(hAlarmPen, "LineColor", 255);
END

IAlarmPen.LineWidth Gets or sets the width in pixels of the pen line when it is drawn.
[Property][Get/Set] Defined As
„ [VBA] Long LineWidth
„ [Cicode] INT LineWidth
„ [C++] int LineWidth
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted the return value will be GeneralFailure.
Limits
„ Minimum = 0
„ Maximum = 8
Calling Syntax
87

This example assumes there is a valid alarm pen object to be passed into the
example methods.
[VBA]
Sub Example(alarmPen As Object)
Dim lineWidth As Long
‘Getting Property value
lineWidth = alarmPen.LineWidth
‘Setting Property value
alarmPen.LineWidth = 5
End Sub
[Cicode]
FUNCTION Example(OBJECT hAlarmPen)
// Getting property value
INT nLineWidth = _ObjectGetProperty(hAlarmPen, "LineWidth");
// Setting property value
_ObjectSetProperty(hAlarmPen, "LineWidth", 5);
END

IAlarmPen.AlarmType Gets or Sets the display type of this alarm pen.


[Property][Get/Set] Defined As
„ [VBA] Long AlarmType
„ [Cicode] INT AlarmType
„ [C++] AlarmType AlarmType
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Remarks
This AlarmType also dictates the number of alarm states, and their descriptions.
See Also IAlarmPen.AlarmType [Property][Get/Set]
Calling Syntax
This example assumes there is a valid alarm pen object to be passed into the
example methods.
[VBA]
Sub Example(alarmPen As Object)
Dim alarmType As Long
‘Getting Property value
alarmType = alarmPen.AlarmType
‘Setting Property value to Analog
alarmPen.AlarmType = 1
End Sub
[Cicode]
FUNCTION Example(OBJECT hAlarmPen)
// Getting property value
INT eAlarmType = _ObjectGetProperty(hAlarmPen, "AlarmType");
88

// Setting property to Analog


_ObjectSetProperty(hAlarmPen, "AlarmType", 1);
END

IAlarmPen.GetFillColor Gets the color used to fill the pen for the specified state.
[Method] Defined As
„ [VBA] GetFillColor(state as Long) as Long
„ [Cicode] INT GetFillColor(INT state)
„ [C++] HRESULT GetFillColor(int state, OLE_COLOR* color)
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Parameters
state
[in] The state for which fill color to retrieve (0 to 8).

Remarks
The color value can be calculated using the following formula: color = (65536 *
Blue) + (256 * Green) + (Red). Where red, green and blue are 0-255.
Calling Syntax
This example assumes there is a valid AlarmPen object to be passed into the
example methods.
[VBA]
Sub Example(alarmPen As Object)
Dim fillColor As Long
fillColor = alarmPen.GetFillColor(0)
End Sub
[Cicode]
FUNCTION Example(OBJECT hAlarmPen)
INT nFillColor = _ObjectCallMethod(hAlarmPen, “GetFillColor” ,
0);
END

IAlarmPen.SetFillColor Sets the color used to fill the pen for the specified state.
[Method] Defined As
„ [VBA] SetFillColor(state as Long, color as Long)
„ [Cicode] INT SetFillColor(INT state, INT color)
„ [C++] HRESULT SetFillColor(int state, OLE_COLOR color)
Parameters
state
[in] The state for which you would like to assign a fill color (0 to 8).
89

color
[in] The fill color that you would like used to for this specific state.
Execution Result
If the function succeeds, the return value will be Success. If the state is out of
range, the return value will be InvalidArgument. If the pen is deleted, the return
value will be GeneralFailure.
Remarks
The color value can be calculated using the following formula:
color = (65536 * Blue) + (256 * Green) + (Red)
where red, green, and blue are 0-255.
Calling Syntax
This example assumes there is a valid AlarmPen object to be passed into the
example methods.
[VBA]
Sub Example(alarmPen As Object)
Dim fillColor As Long
‘Setting FillColor to Red
alarmPen.SetFillColor(0, 255)
End Sub
[Cicode]
FUNCTION Example(OBJECT hAlarmPen)
// Setting FillColor to Red
_ObjectCallMethod(hAlarmPen, “SetFillColor” ,0, 255);
END

IAlarmPen.GetHatchCol Gets the color used to draw the outline and hatching for the specified state.
or [Method] Defined As
„ [VBA] GetHatchColor(state as Long) as Long
„ [Cicode] INT GetHatchColor(INT state)
„ [C++] HRESULT GetHatchColor(int state, OLE_COLOR* color)
Execution Result
If the function succeeds, the return value will be Success. If the state is out of
range, the return value will be InvalidArgument. If the pen is deleted, the return
value will be GeneralFailure.
Parameters
state
[in] The state for which hatch color to retrieve (0 to 8).

Remarks
The color value can be calculated using the following formula:
color = (65536 * Blue) + (256 * Green) + (Red)
90

where red, green, and blue are 0-255.


Calling Syntax
This example assumes there is a valid AlarmPen object to be passed into the
example methods.
[VBA]
Sub Example(alarmPen As Object)
Dim hatchColor As Long
hatchColor = alarmPen.GetHatchColor(0)
End Sub
[Cicode]
FUNCTION Example(OBJECT hAlarmPen)
INT nHatchColor = _ObjectCallMethod(hAlarmPen, “GetHatchColor” , 0);
END

IAlarmPen.SetHatchCol Sets the color used to draw the outline and hatching for the specified state.
or [Method] Defined As
„ [VBA] SetHatchColor(state as Long, color as Long)
„ [Cicode] INT SetHatchColor (INT state, INT color)
„ [C++] HRESULT SetHatchColor (int state, OLE_COLOR color)
Parameters
state
[in] The state for which you would like to assign a hatch color (0 to 8).
color
[in] The color that you would like to be used for a specified states hatch.

Execution Result
If the function succeeds the return value will be Success. If the state is out of
range then the return value will be InvalidArgument. If the pen is deleted the
return value will be GeneralFailure.
Remarks
The color value can be calculated using the following formula:
color = (65536 * Blue) + (256 * Green) + (Red)
where red, green, and blue are 0-255.
Calling Syntax
This example assumes there is a valid AlarmPen object to be passed into the
example methods.
[VBA]
Sub Example(alarmPen As Object)
Dim hatchColor As Long
‘Setting HatchColor to Red
alarmPen.SetHatchColor(0, 255)
End Sub
91

[Cicode]
FUNCTION Example(OBJECT hAlarmPen)
// Setting HatchColor to Red
_ObjectCallMethod(hAlarmPen, “SetHatchColor”,0, 255);
END

IAlarmPen.GetHatchStyl Gets the hatch style used when drawing the boxes for the specified state.
e [Method] Defined As
„ [VBA] GetHatchStyle(state as Long) as Long
„ [Cicode] INT GetHatchStyle(INT state)
„ [C++] HRESULT GetHatchStyle(int state, HatchStyle* color)
Parameters
state
[in] The state for which you would like to retrieve a hatch style (0 to 8).
Execution Result
If the function succeeds the return value will be Success. If the state is out of
range then the return value will be InvalidArgument. If the pen is deleted the
return value will be GeneralFailure.
Remarks
The color value can be calculated using the following formula: color = (65536 *
Blue) + (256 * Green) + (Red). Where red, green and blue are 0-255.
See Also IAlarmPen.GetHatchStyle [Method]
Calling Syntax
This example assumes there is a valid AlarmPen object to be passed into the
example methods.
[VBA]
Sub Example(alarmPen As Object)
Dim hatchStyle As Long
hatchStyle = alarmPen.GetHatchStyle(0)
End Sub
[Cicode]
FUNCTION Example(OBJECT hAlarmPen)
INT nHatchStyle = _ObjectCallMethod(hAlarmPen, “GetHatchStyle”, 0);
END

IAlarmPen.SetHatchStyl Sets the hatch style used for drawing the specified state.
e [Method] Defined As
„ [VBA] SetHatchStyle(state as Long, HatchStyle as Long)
„ [Cicode] INT SetHatchStyle (INT state, INT hatchStyle)
„ [C++] HRESULT SetHatchStyle (int state, HatchStyle hatchStyle)
Parameters
92

state
[in] The state for which you would like to assign a hatch style.
hatchStyle
[in] The hatch style that will be used for the specified state.

Execution Result
If the function succeeds the return value will be Success. If the state is out of
range then the return value will be InvalidArgument. If the pen is deleted the
return value will be GeneralFailure.
Remarks
The color value can be calculated using the following formula: color = (65536 *
Blue) + (256 * Green) + (Red). Where red, green and blue are 0-255.
See Also IAlarmPen.GetHatchStyle [Method]
Calling Syntax
This example assumes there is a valid AlarmPen object to be passed into the
example methods.
[VBA]
Sub Example(alarmPen As Object)
‘Setting HatchStyle
alarmPen.SetHatchStyle(0, 1)
End Sub
[Cicode]
FUNCTION Example(OBJECT hAlarmPen)
// Setting HatchStyle
_ObjectCallMethod(hAlarmPen, “SetHatchStyle” ,0, 1);
END

IAnalogPen Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IAnalogPen
Methods (0)
Properties (3)
See Also IAnalogPen.LineColor [Property][Get/Set]
IAnalogPen.LineInterpolation [Property][Get/Set]
IAnalogPen.LineWidth [Property][Get/Set]

IAnalogPen.LineColor Gets or Sets the color that will be used to draw the pen line.
[Property][Get/Set] Defined As
„ [VBA] Long LineColor
„ [Cicode] INT LineColor
93

„ [C++] OLE_COLOR LineColor


Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Remarks
The color value can be calculated using the following formula:
color = (65536 * blue) + (256 * green) + (red)
where red, green, and blue are 0-255.
Calling Syntax
This example assumes there is a valid AnalogPen object to be passed into the
example methods.
[VBA]
Sub Example(analogPen As Object)
Dim lineColor As Long
‘Getting Property value
lineColor = analogPen.LineColor
‘Setting Property to red
analogPen.LineColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hAnalogPen)
// Getting property value
INT nLineColor = _ObjectGetProperty(hAnalogPen, "LineColor");
// Setting property to red
_ObjectSetProperty(hAnalogPen, "LineColor", 255);
END

IAnalogPen.LineInterpol Gets or sets the drawing style used for drawing the connecting lines between
ation [Property][Get/ points for this analog pen.
Set] Defined As
„ [VBA] Long LineInterpolation
„ [Cicode] INT LineInterpolation
„ [C++] LineType LineInterpolation
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted the return value will be GeneralFailure.
Remarks
The LineInterpolation mode dictates how the two points of a line are joined
when drawn. If Stepped, there will be two lines joining each point, one
horizontal and one vertical. If Straight, only one line is used to directly connect
the two points.
94

See Also LineType [Enumeration]


Calling Syntax
This example assumes there is a valid Analog Pen object to be passed into the
example methods.
[VBA]
Sub Example(analogPen As Object)
Dim lineInterpolation As Long
‘Getting Property value
lineInterpolation = analogPen.LineInterpolation
‘Setting Property value
analogPen.LineInterpolation = 1
End Sub
[Cicode]
FUNCTION Example(OBJECT hAnalogPen)
// Getting property value
INT nInterpolation = _ObjectGetProperty(hAnalogPen, "LineInterpolation");
// Setting property value
_ObjectSetProperty(hAnalogPen, "LineInterpolation", 1);
END

IAnalogPen.LineWidth Gets or sets the width in pixels of the pen line when it is drawn.
[Property][Get/Set] Defined As
„ [VBA] Long LineWidth
„ [Cicode] INT LineWidth
„ [C++] int LineWidth
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Limits
„ Minimum = 0
„ Maximum = 8
Calling Syntax
This example assumes there is a valid Analog Pen object to be passed into the
example methods.
[VBA]
Sub Example(analogPen As Object)
Dim lineWidth As Long
‘Getting Property value
lineWidth = analogPen.LineWidth
‘Setting Property value
analogPen.LineWidth = 5
End Sub
95

[Cicode]
FUNCTION Example(OBJECT hAnalogPen)
// Getting property value
INT nLineWidth = _ObjectGetProperty(hAnalogPen, "LineWidth");
// Setting property value
_ObjectSetProperty(hAnalogPen, "LineWidth", 5);
END

ICommand Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] ICommand
Methods (0)
Properties (6)
ICommand.CommandId [Property][Get]
ICommand.ButtonType [Property][Get]
ICommand.Enabled [Property][Get/Set]
ICommand.Pressed [Property][Get/Set]
ICommand.Tooltip [Property][Get]
ICommand.Privilege [Property][Get]

ICommand.CommandId Gets the CommandId of this command.


[Property][Get] Defined As
„ [VBA] String CommandId
„ [Cicode] STRING hCommandId
„ [C++] BSTR CommandId
Calling Syntax
This example assumes there is a valid Command object as retrieved from a
Process Analyst’s CommandSystem (e.g., VBA:
ProcessAnalyst.CommandSystem.Item(1)).
[VBA]
Sub Example(Command As Object)
Dim commandId As String
‘Getting Property value
commandId = Command.CommandId
End Sub
[Cicode]
FUNCTION Example(OBJECT hCommand)
// Getting property value
STRING nCommandId = _ObjectGetProperty(hCommand,"CommandID");
END
96

ICommand.ButtonType Gets this commands button type.


[Property][Get] Defined As
„ [VBA] Long ButtonType
„ [Cicode] INT ButtonType
„ [C++] ToolbarButtonType ButtonType
Execution Results
If the property get succeeds, the return value will be Success. If the return value
is invalid, the return value will be InvalidArgument. If the command has been
deleted, the return value will be GeneralFailure.
Remarks
The return value meaning is as follows:
„ ToolbarButtonType_Push = 0
„ ToolbarButtonType_Toggle = 1
„ ToolbarButtonType_Separator = 2
Calling Syntax
This example assumes there is a valid Command object as retrieved from a
Process Analyst’s CommandSystem. (e.g., VBA:
ProcessAnalyst.CommandSystem.Item(1))
[VBA]
Sub Example(Command As Object)
Dim buttonType As Long
‘Getting Property value
buttonType = Command.ButtonType
End Sub
[Cicode]
FUNCTION Example(OBJECT hCommand)
// Getting property value
INT nButtonType = _ObjectGetProperty(hCommand, "ButtonType");
END

ICommand.Enabled Gets this commands enabled state.


[Property][Get/Set] Defined As
„ [VBA] Boolean Enabled
„ [Cicode] INT Enabled
„ [C++] VARIANT_BOOL Enabled
Execution Result
If the property get succeeds, the return value will be Success. If the return value
is invalid, the return value will be InvalidArgument.
Limits
„ True (-1): Enabled
97

„ Falso (0): Disabled


Remarks
The setting of this property is only valid for custom commands.
Calling Syntax
This example assumes there is a valid Command object as retrieved from a
Process Analyst’s CommandSystem. (e.g., VBA:
ProcessAnalyst.CommandSystem.Item(1))
[VBA]
Sub Example(Command As Object)
Dim enabled As Boolean
‘Getting Property value
enabled = Command.Enabled
‘Setting Property value
Command.Enabled = True
End Sub
[Cicode]
FUNCTION Example(OBJECT hCommand)
// Getting property value
INT nEnabled = _ObjectGetProperty(hCommand, "Enabled");
// Setting property value
_ObjectSetProperty(hCommand, "Enabled", -1);
END

ICommand.Pressed Gets and Sets this command’s Pressed state.


[Property][Get/Set] Defined As
„ [VBA] Boolean Pressed
„ [Cicode] INT Pressed
„ [C++] VARIANT_BOOL Pressed
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Limits
„ True (-1): Pressed
„ False (0): UnPressed
Remarks
This is only useful for toggle buttons, indicating whether or not the button is in a
pressed down state. The setting of this property is only valid for custom
commands.
Calling Syntax
This example assumes there is a valid Command object as retrieved from a
Process Analyst’s CommandSystem. (e.g., VBA:
ProcessAnalyst.CommandSystem.Item(1))
98

[VBA]
Sub Example(Command As Object)
Dim pressed As Boolean
‘Getting Property value
pressed = Command.Pressed
‘Setting Property value
Command.Pressed = True
End Sub
[Cicode]
FUNCTION Example(OBJECT hCommand)
// Getting property value
INT nPressed = _ObjectGetProperty(hCommand, "Pressed");
// Setting property value
_ObjectSetProperty(hCommand, "Pressed", -1);
END

ICommand.Tooltip Gets this commands Tooltip text.


[Property][Get] Defined As
„ [VBA] String Tooltip
„ [Cicode] STRING Tooltip
„ [C++] VARIANT_BOOL Tooltip
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is invalid, the return value will be InvalidArgument. If the command
has been deleted, the return value will be GeneralFailure.
Remarks
This returns the text that is displayed in a tooltip window when the mouse
pointer hovers over the command’s button.
Calling Syntax
This example assumes there is a valid Command object as retrieved from a
Process Analyst’s CommandSystem. (e.g., VBA:
ProcessAnalyst.CommandSystem.Item(1))
[VBA]
Sub Example(Command As Object)
Dim tooltip As String
‘Getting Property value
tooltip = Command.Tooltip
End Sub
[Cicode]
FUNCTION Example(OBJECT hCommand)
// Getting property value
STRING sTooltip = _ObjectGetProperty(hCommand, "Tooltip");
END
99

ICommand.Privilege Gets the privilege required to gain access to this command.


[Property][Get] Defined As
„ [VBA] Integer Privilege
„ [Cicode] INT Privilege
„ [C++] int Privilege
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is invalid, the return value will be InvalidArgument. If the command
has been deleted, the return value will be GeneralFailure.
Remarks
This is the required privilege level of the currently logged in Vijeo Citect user to
enable the state of this command, and hence allow access through the user
interface. If the currently logged in Vijeo Citect user doesn’t have this privilege,
any buttons tied to this command will be disabled.
Calling Syntax
This example assumes there is a valid Command object as retrieved from a
Process Analyst’s CommandSystem. (e.g., VBA:
ProcessAnalyst.CommandSystem.Item(1))
[VBA]
Sub Example(Command As Object)
Dim privilege As Integer
‘Getting Property value
privilege = Command.Privilege
End Sub
[Cicode]
FUNCTION Example(OBJECT hCommand)
// Getting property value
INT nPrivilege = _ObjectGetProperty(hCommand, "Privilege");
END

ICommandSystem Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] ICommandSystem
Methods (3)
ICommandSystem.Create [Method]
ICommandSystem.Execute [Method]
ICommandSystem.Remove [Method]
Properties (4)
ICommandSystem.Count [Property][Get]
ICommandSystem.Item [Property][Get]
100

ICommandSystem._NewEnum [Property][Get]
ICommandSystem.ItemById [Property][Get]

ICommandSystem.Cou Gets the number of commands in the command system.


nt [Property][Get] Defined As
„ [VBA] Long Count
„ [Cicode] INT Count
„ [C++] int Count
Execution Result
If the property get succeeds, the return value will be Success.
Calling Syntax
This example assumes there is a valid CommandSystem object as retrieved from
a Process Analyst. (e.g., VBA: ProcessAnalyst.CommandSystem).
[VBA]
Function Example(CommandSystem As Object)
Dim count As Long
‘Getting Property value
count = CommandSystem.Count
End Function
[Cicode]
FUNCTION Example(OBJECT hCommandSystem)
// Getting property value
INT nCount = _ObjectGetProperty(hCommandSystem, "Count");
END

ICommandSystem.Item Gets the Command at a supplied index location in this collection.


[Property][Get] Defined As
„ [VBA] Item(index As Long) as Object
„ [Cicode] OBJECT Item(INT index)
„ [C++] Item(int index, ICommand* Item)
Parameters
index
[in] Indicates the index location of the command to return from this
collection. (One based)
Execution Result
If the property get succeeds, the return value will be Success. If the index is out
of range, the return value will be InvalidArgument.
Calling Syntax
This example assumes there is a valid CommandSystem object as retrieved from
a Process Analyst. (e.g., VBA: ProcessAnalyst.CommandSystem).
101

[VBA]
Sub Example(CommandSystem As Object)
Dim command As Object
‘Getting Property value
Set command = CommandSystem.Item(1)
End Sub
[Cicode]
FUNCTION Example(OBJECT hCommandSystem)
// Getting property value
OBJECT hCommand = _ObjectCallMethod(hCommandSystem, "get_Item", 1);
END

ICommandSystem._Ne This allows “For… Each… Next” integration in VB.


wEnum [Property][Get] Calling Syntax
This example assumes there is a valid CommandSystem object as retrieved from
a Process Analyst. (e.g., VBA: ProcessAnalyst.CommandSystem). This property
is not applicable to Cicode.
[VBA]
Sub Example(CommandSystem As Object)
Dim command As Object
Dim count Object
‘Using Property
For Each command In CommandSystem
count = count + 1
Next command
End Sub

ICommandSystem.Item Gets the Command at a supplied index location in this collection.


ById [Property][Get] Defined As
„ [VBA] Object Command
„ [Cicode] OBJECT hCommand
„ [C++] ICommand* Command
Parameters
commandId
[in] Indicates command ID of the command to return from this collection.

Calling Syntax
This example assumes there is a valid CommandSystem object as retrieved from
a Process Analyst. (e.g., VBA: ProcessAnalyst.CommandSystem).
[VBA]
Sub Example(CommandSystem As Object)
Dim command As Object
‘Getting Property value
Set command = CommandSystem.ItemById(Citect_Command_AddPen)
End Sub
102

[Cicode]
FUNCTION Example(OBJECT hCommandSystem)
// Getting property value
OBJECT hCommand = _ObjectCallMethod (hCommandSystem," get_ItemById",
Citect_Command_AddPen);
END

ICommandSystem.Crea Creates a new Command object that is added to the CommandSystem.


te [Method] Defined As
„ [VBA] object Create (commandID As String, buttonType As Integer, tooltip
As String, iconPath As String, privilege As Integer)
„ [Cicode] OBJECT Create (STRING commandID, INT buttonType, STRING
tooltip, STRING iconPath, INT Pprivilege)
„ [C++] HRESULT Create (BSTR commandID, ToolbarButtonType
ButtonType, BSTR tooltip, BSTR iconPath, int privilege, ICommand** Val)
Parameters
commandID
[in] A unique identifier for this command (1-64 characters).
buttonType

[in] A value representing a button type.

„ ToolbarButtonType_Push = 0
„ ToolbarButtonType_Toggle = 1
„ ToolbarButtonType_Separator = 2
tooltip
[in] The text to be displayed as a tooltip for this command (1-64 characters).
iconPath
[in] The path to an icon file that will be used as this command’s picture.
privilege
[in] A privilege value required by the Vijeo Citect user to gain access to this
command (0-8).
Execution Result
If the method succeeds, the return value is Success. If an argument is invalid or
out of range, the return value is InvalidArgument. If the command was not
created, the return value is GeneralFailure.
Remarks
The commandID cannot begin with the prefix “Citect_”.
Calling Syntax
This example assumes there is a valid CommandSystem object as retrieved from
a Process Analyst. (e.g., VBA: ProcessAnalyst.CommandSystem).
103

[VBA]
Sub Example(CommandSystem As Object)
Dim command As Object
Set command = CommandSystem.Create(CommandIO, "Some tooltip text", "c:\someicon.ico",
5)
End Sub
[Cicode]
FUNCTION Example(OBJECT hCommandSystem)
OBJECT hCommand = _ObjectCallMethod(hCommandSystem, "Create", CommandIO, "Some tooltip
text", "c:\someicon.ico", 5);
END

ICommandSystem.Exec Executes the specified command’s action.


ute [Method] Defined As
„ [VBA] Execute (commandId As String)
„ [Cicode] Execute (STRING commandId)
„ [C++] HRESULT Execute(BSTR commandId)
Parameters
commandId
[in] The unique ID of the command whose action is to be executed.

Execution Result
If this method succeeds, the retun value will be Success. If the command is
invalid, the return value will be InvalidArgument.
Remarks
If the current Operator does not have the correct privilege, the command will
not execute.
Calling Syntax
This example assumes there is a valid CommandSystem object as retrieved from
a Process Analyst. (e.g., VBA: ProcessAnalyst.CommandSystem).
[VBA]
Sub Example(CommandSystem As Object)
CommandSystem.Execute(Citect_Command_AddPen)
End Sub
[Cicode]
FUNCTION Example(OBJECT hCommandSystem)
_ObjectCallMethod(hCommandSystem, "Execute", Citect_Command_AddPen);
END

ICommandSystem.Rem Removes the specified command.


ove [Method] Defined As
„ [VBA] Remove (commandId As String)
„ [Cicode] Remove (STRING CommandId)
104

„ [C++] HRESULT Remove(BSTR CommandId)


Parameters
commandId
[in] The ID of the command to be removed.

Calling Syntax
This example assumes there is a valid CommandSystem object as retrieved from
a Process Analyst. (e.g., VBA: ProcessAnalyst.CommandSystem).
[VBA]
Sub Example(CommandSystem As Object)
CommandSystem.Remove(“MyCommand1”)
End Sub
[Cicode]
FUNCTION Example(OBJECT hCommandSystem)
_ObjectCallMethod(hCommandSystem, "Remove", “MyCommand1”);
END

ICursors Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] ICursors
Methods
ICursors.Create [Method]
ICursors.RemoveAll [Method]
Properties
ICursors.Item [Property][Get]
ICursors._NewEnum [Property][Get]
ICursors.Count [Property][Get]
ICursors.ItemByName [Property][Get]

ICursors.Create Creates a new TrendCursor at the given location.


[Method] Defined As
„ [VBA] Object Create(name As String, position As Integer)
„ [Cicode] OBJECT Create(STRING name, INT position)
„ [C++] HRESULT Create(BSTR name, int position, ITrendCursor**
ppTrendCursor)
Parameters
name
[in] The desired unique name of the new cursor. This must be between 1
and 250 characters.
105

position
[in] The initial position of the new cursor. This value is given as the
number of pixels from the left of the Process Analyst graph view.
Execution Result
If the function succeeds, the return value will be Success. If the name is out of
range, the return value will be InvalidArgument. If the name is not unique, the
return value will be InvalidArgument.
If an unexpected error occurs, the return value will be GeneralFailure.
Remarks
The cursor name must be unique. Attempting to create a cursor with a name that
is already in use will result in error and the new cursor will not be created.
Calling Syntax
[VBA]
Sub Example(cursors As Object)
Dim newCursor As Object
newCursor = cursors.Create(“Cursor1”, 100)
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursors)
OBJECT hNewCursor = _ObjectCallMethod(hCursors, “Create”, “Cursor1”, 100);
END

ICursors.RemoveAll Removes all cursors from the collection.


[Method] Defined As
„ [VBA] RemoveAll()
„ [Cicode] RemoveAll()
„ [C++] HRESULT RemoveAll()
Execution Result
If the function succeeds the return value will be Success. If an unexpected error
occurs, the return value will be GeneralFailure.
Calling Syntax
This example assumes there is a valid Cursors object to be passed into the
example methods.
[VBA]
Sub Example(cursors As Object)
cursors.RemoveAll
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursors)
_ObjectCallMethod(hCursors, "RemoveAll");
End Sub
106

ICursors.Item Retrieves the Cursor from the collection at the specified index.
[Property][Get] Defined As
„ [VBA] Object Item(index As Integer)
„ [Cicode] OBJECT get_Item(INT index)
„ [C++] HRESULT get_Item (long index, ITrendCursor **cursor)
Parameters
index
[in] The index of the required cursor.

Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
If the index is out of range, the return value will be InvalidArgument. If the
collection is deleted, the return value will be GeneralFailure.
Remarks
The index for the collection is 1 based. The valid range for this parameter is
between 1 and the total number of cursors.
Calling Syntax
This example assumes you have a valid reference to the cursors collection and
that there are two items in the collection.
[VBA]
Sub Example(hCursors As Object)
Dim hSecondCursor As Object
Set hSecondCursor = hCursors.Item(2)
End Sub
[Cicode]
Sub Example(OBJECT hCursors)
OBJECT hSecondCursor = _ObjectCallMethod(hCursors, "get_Item", 2);
END

ICursors._NewEnum Retrieves an enumerator for the cursors collection.


[Property][Get] Defined As
„ [VBA] Object _NewEnum()
„ [C++] HRESULT get__NewEnum(LPUNKNOWN *pVal)
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the collection is
deleted, the return value will be GeneralFailure.
Remarks
Provided for the implementation of For Each...Next loops in Citect VBA (See
Calling Syntax, below). This property cannot be used in Cicode.
107

Calling Syntax
This example assumes you have a valid reference to the cursors collection and
that there are cursors in the collection.
[VBA]
Sub Example(cursors As Object)
Dim cursor As Object
Dim count As Integer = 0
For Each cursor In cursors
Set count = count + 1
Next
End Sub

ICursors.Count Returns the number of cursors in the collection.


[Property][Get] Defined As
„ [VBA] Integer Count()
„ [Cicode] INT Count()
„ [C++] HRESULT get_Count (long *pCount)
Execution Result
If the property get succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the collection is
deleted the return value will be GeneralFailure.
Remarks
This property may be used in conjunction with the Item property to iterate
through the collection in Cicode.
Calling Syntax
This example assumes you have a valid reference to the cursors collection.
[VBA]
Sub Example(cursors As Object)
Dim cursorCount As Integer
cursorCount = cursors.Count
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursors)
INT cursorCount;
cursorCount = _ObjectGetProperty(hCursors, "Count");
END

ICursors.ItemByName Retrieves the Cursor at the specified index.


[Property][Get] Defined As
„ [VBA] Object ItemByName(name As String)
„ [Cicode] OBJECT get_ItemByName(STRING name)
„ [C++] HRESULT get_ItemByName (BSTR name, ITrendCursor **cursor)
108

Parameters
name
[in] The name of the required cursor.

Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the cursor is not
found, the return value will be InvalidArgument.
If the collection is deleted, the return value will be GeneralFailure.
Calling Syntax
This example assumes you have a valid reference to the cursors collection, and
that there is a cursor in the collection named “MyCursor”.
[VBA]
Sub Example(cursors As Object)
Dim cursor As Object
Set cursor = cursors.ItemByName("MyCursor")
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursors)
OBJECT hCursor = _ObjectCallMethod(hCursors, "get_ItemByName", "MyCursor");
END

IDigitalPen Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IDigitalPen
Methods (0)
Properties (4)
IDigitalPen.FillColor [Property][Get/Set]
IDigitalPen.LineColor [Property][Get/Set]
IDigitalPen.LineWidth [Property][Get/Set]
IDigitalPen.Fill [Property][Get/Set]

IDigitalPen.FillColor Gets or Sets the color that will be used to fill the area under the line when the
[Property][Get/Set] value is 1.
Defined As
„ [VBA] Long FillColor
„ [Cicode] INT FillColor
„ [C++] OLE_COLOR FillColor
Execution Result
109

If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Remarks
The color value can be calculated using the following formula:
color = (65536 * blue) + (256 * green) + (red)
where red, green, and blue are 0-255. The area under the line is filled with this
color if the value of the Fill property is True (-1).
See Also IDigitalPen.Fill [Property][Get/Set]
Calling Syntax
This example assumes there is a valid DigitalPen object to be passed into the
example methods.
[VBA]
Sub Example(digitalPen As Object)
Dim fillColor As Long
‘Getting Property value
fillColor = digitalPen.FillColor
‘Setting Property to red
digitalPen.FillColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hDigitalPen)
// Getting property value
INT nFillColor = _ObjectGetProperty(hDigitalPen, "FillColor");
// Setting property to red
_ObjectSetProperty(hDigitalPen, "FillColor", 255);
END

IDigitalPen.LineColor Gets or Sets the color that will be used to draw the pen line.
[Property][Get/Set] Defined As
„ [VBA] Long LineColor
„ [Cicode] INT LineColor
„ [C++] OLE_COLOR LineColor
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted the return value will be GeneralFailure.
Remarks
The color value can be calculated using the following formula: color = (65536 *
Blue) + (256 * Green) + (Red). Where red, green and blue are 0-255.
Calling Syntax
110

This example assumes there is a valid DigitalPen object to be passed into the
example methods.
[VBA]
Sub Example(digitalPen As Object)
Dim lineColor As Long
‘Getting Property value
lineColor = DigitalPen.LineColor
‘Setting Property to red
digitalPen.LineColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hDigitalPen)
// Getting property value
INT nLineColor = _ObjectGetProperty(hDigitalPen, "LineColor");
// Setting property to red
_ObjectSetProperty(hDigitalPen, "LineColor", 255);
END

IDigitalPen.LineWidth Gets or sets the width in pixels of the pen line when it is drawn.
[Property][Get/Set] Defined As
„ [VBA] Long LineWidth
„ [Cicode] INT LineWidth
„ [C++] int LineWidth
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted the return value will be GeneralFailure.
Limits
„ Minimum = 0
„ Maximum = 8
Calling Syntax
This example assumes there is a valid Digital Pen object to be passed into the
example methods.
[VBA]
Sub Example(digitalPen As Object)
Dim lineWidth As Long
‘Getting Property value
lineWidth = digitalPen.LineWidth
‘Setting Property value
digitalPen.LineWidth = 5
End Sub
[Cicode]
FUNCTION Example(OBJECT hDigitalPen)
// Getting property value
INT nLineWidth = _ObjectGetProperty(hDigitalPen, "LineWidth");
111

// Setting property value


_ObjectSetProperty(hDigitalPen, "LineWidth", 5);
END

IDigitalPen.Fill Gets or sets whether the pen fill is displayed.


[Property][Get/Set] Defined As
„ [VBA] Boolean Fill
„ [Cicode] INT Fill
„ [C++] VARIANT_BOOL Fill
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted the return value will be GeneralFailure.
Remarks
If the pen is filled, the area under the pen line will be filled with the color
specified by the FillColor property.
See Also IDigitalPen.FillColor [Property][Get/Set]
Limits
„ True (-1): = Fill is displayed
„ False (0): = Fill is hidden
Calling Syntax
This example assumes there is a valid digital pen object to be passed into the
example methods.
[VBA]
Sub Example(digitalPen As Object)
Dim fill As Boolean
‘Getting Property value
fill = digitalPen.Fill
‘Setting Property value
digitalPen.Fill = True
End Sub
[Cicode]
FUNCTION Example(OBJECT hDigitalPen)
// Getting property value
INT nFill = _ObjectGetProperty(hDigitalPen, "Fill");
// Setting property value
_ObjectSetProperty(hDigitalPen, "Fill", -1);
END

IObjectView Interface
Defined As
„ [VBA] Object
112

„ [Cicode] OBJECT
„ [C++] IObjectView
Methods (0)
Properties (7)
IObjectView.Visible [Property][Get/Set]
IObjectView.Height [Property][Get/Set]
IObjectView.BackgroundColor [Property][Get/Set]
IObjectView.ForeColor [Property][Get/Set]
IObjectView.Columns [Property][Get]
IObjectView.Items [Property][Get]
IObjectView.SelectedItem [Property][Get]

IObjectView.Visible Gets or Sets the visibility of the Object View window.


[Property][Get/Set] Defined As
„ [VBA] Boolean Visible
„ [Cicode] INT Visible
„ [C++] VARIANT_BOOL Visible
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Limits
„ True (-1): Visible
„ False (0): Hidden
Remarks
By hiding the ObjectView, the chart gains the real estate previously held by it,
and likewise the chart loses real estate when the ObjectView gets shown.
Calling Syntax
Assume that there is an IObjectView object being passed in as a parameter.
[VBA]
Sub Example(objectView As Object)
Dim visible As Boolean
‘Getting Property value
visible = objectView.Visible
‘Setting Property value
objectView.Visible = False
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectView)
INT bVisible = 0
// Getting property value
bVisible = _ObjectGetProperty(hObjectView, "Visible");
113

// Setting Property to false


_ObjectSetProperty(hObjectView, "Visible", 0);
END

IObjectView.Height Gets or Sets the height in pixels of the Object View window.
[Property][Get/Set] Defined As
„ [VBA] Long Height
„ [Cicode] INT Height
„ [C++] int Height
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. A height value less
than 0 will be InvalidArgument.
Limits
„ Height must be 0 or greater.
Remarks
As the ObjectView and chart both share the same window, by enlarging the
ObjectView, you make the Chart smaller and vice versa.
Calling Syntax
This example assumes that there is an IObjectView object being passed in as a
parameter.
[VBA]
Sub Example(objectView As Object)
Dim height As Long
‘Getting Property value
height = objectView.Height
‘Setting Property value
objectView.Height = 25
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectView)
INT nHeight = 0;
// Getting property value
nHeight = _ObjectGetProperty(hObjectView, "Height");
// Setting Property to false
_ObjectSetProperty(hObjectView, "Height", 25);
END

IObjectView.Backgroun Gets or Sets the background color of the ObjectView. This number is treated as
dColor [Property][Get/ an OLE_COLOR inside the Process Analyst.
Set] Defined As
„ [VBA] Long BackgroundColor
„ [Cicode] INT BackgroundColor
114

„ [C++] OLE_COLOR BackgroundColor


Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Remarks
The color value can be calculated using the following formula: color = (65536 *
Blue) + (256 * Green) + (Red). Where red, green and blue are 0-255.
Calling Syntax
This example assumes that there is an IObjectView object being passed in as a
parameter.
[VBA]
Sub Example(objectView As Object)
Dim backgroundColor As Long
‘Getting Property value
backgroundColor = objectView.BackgroundColor
‘Setting Property value to red
objectView.BackgroundColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectView)
// Getting property value
INT nBackgroundColor =
_ObjectGetProperty(hObjectView,"BackgroundColor");
// Setting Property to Red
_ObjectSetProperty(hObjectView, "BackgroundColor", 255);
END

IObjectView.ForeColor Gets or Sets the Fore color (text and color box outlines) of the ObjectView. This
[Property][Get/Set] number is treated as an OLE_COLOR inside the Process Analyst.
Defined As
„ [VBA] Long ForeColor
„ [Cicode] INT ForeColor
„ [C++] OLE_COLOR ForeColor
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Remarks
The color value can be calculated using the following formula: color = (65536 *
Blue) + (256 * Green) + (Red). Where red, green and blue are 0-255.
Calling Syntax
This example assumes that there is an IObjectView object being passed in as a
parameter.
115

[VBA]
Sub Example(objectView As Object)
Dim foreColor As Long
‘Getting Property value
foreColor = objectView.ForeColor
‘Setting Property value to red
objectView.ForeColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectView)
INT nForeColor = 0;
// Getting property value
nForeColor = _ObjectGetProperty(hObjectView, "ForeColor");
// Setting Property to red
_ObjectSetProperty(hObjectView, "ForeColor", 255);
END

IObjectView.Columns Gets the automation object representing the collection of columns currently
[Property][Get] visible in the ObjectView.
Defined As
„ [VBA] Object Columns
„ [Cicode] OBJECT Columns
„ [C++] IObjectViewColumns* Columns
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Calling Syntax
This example assumes that there is an IObjectView object being passed in as a
parameter.
[VBA]
Sub Example(objectView As Object)
Dim columns As Object
‘Getting Property value
Set columns = objectView.Columns
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectView)
// Getting property value
OBJECT hColumns = _ObjectGetProperty(hObjectView, "Columns");
END

IObjectView.Items Gets the automation object representing the collection of items at the root of the
[Property][Get] ObjectView tree.
Defined As
„ [VBA] Object Items
116

„ [Cicode] OBJECT Items


„ [C++] IObjectViewItems* Items
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Remarks
The method will provide a list of all the pane items in tree. Each pane item has
an Items property which allows access to the pen items listed under it.
Calling Syntax
This example assumes that there is an IObjectView object being passed in as a
parameter.
[VBA]
Sub Example(objectView As Object)
Dim items As Object
‘Getting Property value
Set items = objectView.Items
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectView)
// Getting property value
OBJECT hItems = _ObjectGetProperty(hObjectView, "Items");
END

IObjectView.SelectedIte Gets the current primary selection in the ObjectView. This is the pen item that
m [Property][Get] was last selected.
Defined As
„ [VBA] Object SelectedItem
„ [Cicode] OBJECT SelectedItem
„ [C++] IObjectViewItem* SelectedItem
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Calling Syntax
This example assumes that there is an IObjectView object being passed in as a
parameter.
[VBA]
Sub Example(objectView As Object)
Dim selectedItem As Object
‘Getting Property value
Set selectedItem = objectView.SelectedItem
End Sub
117

[Cicode]
FUNCTION Example(OBJECT hObjectView)
// Getting property value
OBJECT hSelectedItem = _ObjectGetProperty(hObjectView, "SelectedItem");
END

IObjectViewColumn Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IObjectViewColumn
Methods (0)
Properties (3)
IObjectViewColumn.Name [Property][Get]
IObjectViewColumn.Text [Property][Get]
IObjectViewColumn.Width [Property][Get/Set]

IObjectViewColumn.Na Retrieves the unique identifier of this column.


me [Property][Get] Defined As
„ [VBA] String Name
„ [Cicode] STRING Name
„ [C++] BSTR Name
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Calling Syntax
This example assumes there is a valid column as retrieved from an ObjectView.
(e.g., VBA: objectView.Columns.Item(1)).
[VBA]
Sub Example(objectViewColumn As Object)
Dim name As String
‘Getting Property value
name = objectViewColumn.Name
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectViewColumn)
// Getting property value
STRING name = _ObjectGetProperty(hObjectViewColumn, "Name");
END

IObjectViewColumn.Tex Gets the Text that is being displayed for this columns header.
t [Property][Get] Defined As
118

„ [VBA] String Text


„ [Cicode] STRING Text
„ [C++] BSTR Text
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Calling Syntax
This example assumes there is a valid column as retrieved from an ObjectView.
(e.g., VBA: objectView.Columns.Item(1)).
[VBA]
Sub Example(objectViewColumn As Object)
Dim text As String
‘Getting Property value
text = objectViewColumn.Text
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectViewColumn)
// Getting property value
STRING text = _ObjectGetProperty(hObjectViewColumn, "Text");
END

IObjectViewColumn.Wid Gets or Sets the width in pixels of this column.


th [Property][Get/Set] Defined As
„ [VBA] Long Width
„ [Cicode] INT Width
„ [C++] int Width
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the width is out of
range, the result will be InvalidArgument.
Limits
A valid width is 0-1000.
Calling Syntax
This example assumes there is a valid column as retrieved from an ObjectView.
(e.g., VBA: objectView.Columns.Item(1)).
[VBA]
Sub Example(objectViewColumn As Object)
Dim width As Long
‘Getting Property value
width = objectViewColumn.Width
119

‘Setting Property value


objectViewColumn.Width = 150
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectViewColumn)
// Getting property value
INT width = _ObjectGetProperty(hObjectViewColumn, "Width");
_ObjectSetProperty(hObjectViewColumn, "Width", 150);
END

IObjectViewColumns Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IObjectViewColumns
Methods (4)
IObjectViewColumns.Add [Method]
IObjectViewColumns.Hide [Method]
IObjectViewColumns.Remove [Method]
IObjectViewColumns.Show [Method]
Properties (4)
IObjectViewColumns.Count [Property][Get]
IObjectViewColumns.Item [Property][Get]
IObjectViewColumns.ItemByName [Property][Get]
IObjectViewColumns._NewEnum [Property][Get]

IObjectViewColumns.A Adds a visible custom column to the ObjectView.


dd [Method] Defined As
„ [VBA] Add(name As String, DisplayText As String, Width As Long)
„ [Cicode] Add(STRING name, STRING DisplayText, INT Width)
„ [C++] HRESULT Add (BSTR name, BSTR text, int width)
Parameters
name
[in] The string ID uniquely identifying this column (1-64).
text
[in] The title to be displayed in the column header (0-256).
width
[in] The width of this column in pixels (0-1000).

Execution Result
If the method succeeds, the return value will be Success. If an argument is out of
range, the return value will be InvalidArgument. If the column cannot be added,
the return value is GeneralFailure.
120

See Also OVColumnAdded [Event]

Calling Syntax
This example assumes there is a valid Columns collection as retrieved from an
ObjectView. (e.g., VBA: objectView.Columns).
[VBA]
Sub Example(Columns As Object)
Columns.Add "NameID", "New Column", 120;
End Sub
[Cicode]
FUNCTION Example(OBJECT hColumns)
_ObjectCallMethod(hColumns, "Add", "NameID", "New Column", 120);
END

IObjectViewColumns.Hi Makes the specified column hidden within the Object View.
de [Method] Defined As
„ [VBA] Hide(columnName As String)
„ [Cicode] Hide(STRING columnName)
„ [C++] HRESULT Hide(BSTR columnName)
Parameters
columnName
[in] The string ID uniquely identifying the column you want to hide

Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the field cannot be
set, GeneralFailure is returned.
See Also IObjectViewColumns.Show [Method]
Calling Syntax
This example assumes there is a columns Collection from an ObjectView. (e.g.,
VBA: objectView.Columns).
[VBA]
Sub Example(columns As Object)
columns.Hide "Error"
End Sub
[Cicode]
FUNCTION Example(OBJECT hColumns)
_ObjectCallMethod(hColumns, "Hide", "Error");
END

IObjectViewColumns.Re Removes the specified custom column from the Object View columns.
move [Method] Defined As
„ [VBA] Remove(columnName As String)
121

„ [Cicode] OBJECT Remove(STRING columnName)


„ [C++] Remove(STRING columnName)
Parameters
columnName
[in] Indicates the unique name of the column to remove from this collection.
Execution Results
If the method succeeds, the return value will be Success. If the column cannot be
found, the return value will be InvalidArgument.
Remarks
Only user created custom columns can be removed.
Calling Syntax
This example assumes there is a valid Columns collection object to be passed
into the example methods.
[VBA]
Sub Example(columns As Object)
Dim column As Object
‘Getting Property value
Set column = columns.Remove(“MyCustomColumn”)
End Sub
[Cicode]
FUNCTION Example(OBJECT hColumns)
// Getting property value
OBJECT hColumn = _ObjectCallMethod(hColumns, "get_ItemByName", "MyCustomColumn");
END

IObjectViewColumns.Sh Makes the specified column visible within the Object View.
ow [Method] Defined As
„ [VBA] Show(columnName As String)
„ [Cicode] Show(STRING columnName)
„ [C++] HRESULT Show(BSTR columnName)
Parameters
columnName
[in] The string ID uniquely identifying the column you want to make
visible
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the field cannot be
set, then GeneralFailure is returned.
See Also IObjectViewColumns.Hide [Method]
Calling Syntax
122

This example assumes there is a columns Collection from an ObjectView. (e.g.,


VBA: objectView.Columns).
[VBA]
Sub Example(columns As Object)
columns.Show "Error"
End Sub
[Cicode]
FUNCTION Example(OBJECT hColumns)
_ObjectCallMethod(hColumns, "Show", "Error");
END

IObjectViewColumns.C Gets the number of Columns in this columns collection.


ount [Property][Get] Defined As
„ [VBA] Long Count
„ [Cicode] INT Count
„ [C++] int Count
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Calling Syntax
This example assumes there is a valid Columns collection as retrieved from an
ObjectView. (e.g., VBA: ObjectView.Columns).
[VBA]
Function Example(Columns As Object)
Dim count As Long
‘Getting Property value
count = Columns.Count
End Function
[Cicode]
FUNCTION Example(OBJECT hColumns)
// Getting property value
INT nCount = _ObjectGetProperty(hColumns, "Count");
END

IObjectViewColumns.Ite Gets the ObjectViewItem at a supplied index location in this collection.


m [Property][Get] Defined As
„ [VBA] Item(index As Long) as Object
„ [Cicode] OBJECT Item(INT index)
„ [C++] Item(int index, IObjectViewColumn* Item)
Parameters
index
123

[in] Indicates the index location of the column to return from this
collection. (One based)
Calling Syntax
This example assumes there is a valid Columns collection as retrieved from an
ObjectView (e.g., VBA: objectView.Columns).
[VBA]
Sub Example(Columns As Object)
Dim column As Object
‘Getting Property value
Set column = Columns.Item(1)
End Sub
[Cicode]
FUNCTION Example(OBJECT hColumns)
// Getting property value
OBJECT hColumn = _ObjectCallMethod(hColumns, "get_Item", 1);
END

IObjectViewColumns.Ite Returns a reference to the column object with the given name from this column’s
mByName collection.
[Property][Get] Defined As
„ [VBA] ItemByName(columnName As String) as Object
„ [Cicode] OBJECT ItemByName(STRING columnName)
„ [C++] ItemByName(STRING columnName, IObjectViewColumn* Item)
Parameters
columnName
[in] Indicates the unique name of the column item to return from this
collection.
Execution Results
If the method succeeds, the return value will be Success. If the column cannot be
found, the return value will be InvalidArgument.
Calling Syntax
This example assumes there is a valid Columns collection object to be passed
into the example methods.
[VBA]
Sub Example(columns As Object)
Dim column As Object
‘Getting Property value
Set column = columns.ItemByName(“Duration”)
End Sub
124

[Cicode]
FUNCTION Example(OBJECT hColumns)
// Getting property value
OBJECT hColumn = _ObjectCallMethod(hColumns, "get_ItemByName", "Duration");
END

IObjectViewColumns._N This allows “For… Each… Next” integration in VB.


ewEnum [Property][Get] Calling Syntax
This example assumes there is a valid Columns collection as retrieved from an
ObjectView. (e.g., VBA: objectView.Columns). This property is not applicable in
Cicode.
[VBA]
Sub Example(Columns As Object)
Dim column As Object
Dim count Object
‘Using Property
For Each column In Columns
count = count + 1
Next column
End Sub

IObjectViewItem Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IObjectViewItem
Methods (2)
IObjectViewItem.GetField [Method]
IObjectViewItem.PutField [Method]
Properties (3)
IObjectViewItem.Expanded [Property][Get/Set]
IObjectViewItem.Tag [Property][Get/Set]
IObjectViewItem.Items [Property][Get]

IObjectViewItem.GetFiel Returns the string value of a displayed field for a specified column on this item.
d [Method] The IObjectViewItem interface is hierarchical to two levels – pane and then pen.
The result of the GetField method will depend on what type of item it is called
on. To access the fields for a pen, for example, you have to first get the items
collection for the pane item, then get the pen item.
Defined As
„ [VBA] GetField(ColumnName As String) as String
„ [Cicode] STRING GetField (STRING ColumnName)
„ [C++] HRESULT GetField (BSTR ColumnName, BSTR *Val)
125

Parameters
ColumnName
[in] The string ID uniquely identifying the column whose field value is
being queried for.
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the ColumnName
does not exist, InvalidArgument will be returned.
Calling Syntax
This example gets the Scale property of the first pen in the first pane. It assumes
there is a valid Item as retrieved from an Items Collection from an ObjectView.
(e.g., VBA: objectView.Items.Item(1))
[VBA]
Sub Example()
Dim paneItem As Object
Dim penItem As Object
Dim fieldValue As String
Set paneItem = Test_CPA.ObjectView.Items.Item(1) 'Get the first pane of the ObjectView
Set penItem = paneItem.Items.Item(1) 'Get the first pen from the first pane
penItem.GetField "Scale", fieldValue 'Get the value of the scale field
End Sub
[CICODE]
FUNCTION Example(OBJECT hObjectView)
OBJECT hPaneItems = _ObjectGetProperty(hObjectView, "Items");
OBJECT hPaneItem = _ObjectCallMethod(hPaneItems, "get_Item", 1); // Get the first pane
of the ObjectView
OBJECT hPenItems = _ObjectGetProperty(hPaneItem, "Items"); // Get the collection of
pens from the first pane
OBJECT hPenItem = _ObjectCallMethod(hPenItems, "get_Item", 1); // Get the first Pen
item
STRING sValue;
_ObjectCallMethod(hPenItem, "GetField", "Scale", sValue); // Get the value of the scale
field
END

IObjectViewItem.PutFiel Sets the display string in a field’s cell for a specified column on this item.
d [Method] The IObjectViewItem interface is hierarchical to two levels – pane and then pen.
The scope of the PutField method will depend on what type of item it is called
on. To set fields for a pen, for example, you have to first get the items collection
for the pane item, then get the pen item.
Defined As
„ [VBA] PutField(columnName As String, fieldValue as String)
„ [Cicode] PutField (STRING columnName, STRING fieldValue)
„ [C++] HRESULT PutField (BSTR columnName, BSTR fieldValue)
Parameters
126

columnName
[in] The string ID uniquely identifying the column whose field value is
being set.
fieldValue
[in] The string you would like to be displayed in the field for this column/
pen intersection.
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the field cannot be
set, then GeneralFailure is returned.
Calling Syntax
This example writes the value “someValue” to the CustomColumn field of the
first pen in the first pane. It assumes there is a valid Item as retrieved from an
Items Collection from an ObjectView. (e.g., VBA: objectView.Items.Item(1)).
[VBA]
Sub Example()
Dim paneItem As Object
Dim penItem As Object
Set paneItem = Test_CPA.ObjectView.Items.Item(1) 'Get the first pane of the ObjectView
Set penItem = paneItem.Items.Item(1) 'Get the first pen from the first pane
penItem.PutField "CustomColumn", "someValue" 'Set the value of the CustomColumn field
End Sub
[CICODE]
FUNCTION Example(OBJECT hObjectView)
OBJECT hPaneItems = _ObjectGetProperty(hObjectView, "Items");
OBJECT hPaneItem = _ObjectCallMethod(hPaneItems, "get_Item", 1); // Get the first pane
of the ObjectView
OBJECT hPenItems = _ObjectGetProperty(hPaneItem, "Items"); // Get the collection of
pens from the first pane
OBJECT hPenItem = _ObjectCallMethod(hPenItems, "get_Item", 1); // Get the first Pen
item
_ObjectCallMethod(hPenItem, "PutField", "CustomColumn", "someValue"); // Set the value
of the CustomColumn field
END

IObjectViewItem.Expan Gets or Sets the expanded state of an item in the ObjectView. This change is
ded [Property][Get/Set] reflected immediately in the visualization of the ObjectView.
Defined As
„ [VBA] Boolean Expanded
„ [Cicode] INT Expanded
„ [C++] VARIANT_BOOL Expanded
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Limits
127

„ True (-1): Expanded


„ False (0): Collapsed
Calling Syntax
This example assumes there is a valid Item as retrieved from an Items Collection
from an ObjectView. (e.g., VBA: objectView.Items.Item(1)).
[VBA]
Sub Example(objectViewItem As Object)
Dim expanded As Boolean
‘Getting Property value
expanded = objectViewItem.Expanded
‘Setting Property value
objectViewItem.Expanded = False
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectViewItem)
// Getting property value
INT nExpanded = _ObjectGetProperty(hObjectViewItem, "Expanded");
// Setting Property
_ObjectSetProperty(hObjectViewItem, "Expanded", 0);
END

IObjectViewItem.Tag Gets or Sets a user specified piece of data to associate with this Item.
[Property][Get/Set] Defined As
„ [VBA] <Any Type> Tag
„ [Cicode] <Any Type> Tag
„ [C++] VARIANT Tag
Remarks
The user can associate any variant of data with a pen. This is handy for
associating some custom data with a pen item, and then having direct access to it
whenever any events with a pen item target occur.
Calling Syntax
This example assumes there is a valid Item as retrieved from an Items Collection
from an ObjectView. (e.g., VBA: objectView.Items.Item(1)).
[VBA]
Sub Example(objectViewItem As Object)
Dim tag As Variant
‘Getting Property value
tag = objectViewItem.Tag
‘Setting Property value to red
objectViewItem.Tag = tag
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectViewItem)
// Getting property value
INT nTag = _ObjectGetProperty(hObjectViewItem, "Tag");
128

// Setting Property to red


_ObjectSetProperty(hObjectView, "Tag", nTag);
END

IObjectViewItem.Items Gets the automation object representing the collection of child items under this
[Property][Get] item.
Defined As
„ [VBA] Object Items
„ [Cicode] OBJECT Items
„ [C++] IObjectViewItems* Items
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Remarks
Pane nodes are currently the only nodes that can have children.
Calling Syntax
This example assumes there is a valid item as retrieved from an ObjectView.
(e.g., VBA: objectView.Items.Item(1). This will be a pane).
[VBA]
Sub Example(objectViewItem As Object)
Dim items As Object
‘Getting Property value
Set items = objectViewItem.Items
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectViewItem)
// Getting property value
OBJECT hItems = _ObjectGetProperty(hObjectViewItem, "Items");
END

IObjectViewItems Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IObjectViewItems
Methods (0)
Properties (3)
IObjectViewItems.Count [Property][Get]
IObjectViewItems.Item [Property][Get]
IObjectViewItems._NewEnum [Property][Get]
129

IObjectViewItems.Count Gets the number of child items under this item.


[Property][Get] Defined As
„ [VBA] Long Count
„ [Cicode] INT Count
„ [C++] int Count
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Calling Syntax
This example assumes there is a valid Items collection as retrieved from an
ObjectView. (e.g., VBA: objectView.Items)
[VBA]
Sub Example(Items As Object)
Dim count As Long
‘Getting Property value
count = Items.Count
End Sub
[Cicode]
FUNCTION Example(OBJECT hItems)
// Getting property value
INT nCount = _ObjectGetProperty(hItems, "Count");
END

IObjectViewItems.Item Gets the ObjectViewItem at a supplied index location in this collection.


[Property][Get] Defined As
„ [VBA] Item(index As Long) as Object
„ [Cicode] OBJECT Item(INT index)
„ [C++] Item(int index, IObjectViewItem* Item)
Parameters
index
[in] Indicates the index location of the child item to return from this
collection. (One based)
Calling Syntax
This example assumes there is a valid Items collection as retrieved from an
ObjectView. (e.g., VBA: objectView.Items).
[VBA]
Sub Example(Items As Object)
Dim item As Object
‘Getting Property value
Set item = Items.Item(1)
End Sub
130

[Cicode]
FUNCTION Example(OBJECT hItems)
// Getting property value
OBJECT hItem = _ObjectCallMethod(hItems, "get_Item", 1);
END

IObjectViewItems._New This allows For.. Each.. Next integration in VB.


Enum [Property][Get] Calling Syntax
This example assumes there is a valid Items collection as retrieved from an
ObjectView. (e.g., VBA: objectView.Items). This property is not applicable to
Cicode.
[VBA]
Sub Example(Items As Object)
Dim item As Object
Dim count Object
‘Using Property
For Each item In Items
count = count + 1
Next Item
End Sub

IObjectViewPenItem Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IObjectViewPenItem
Methods (0)
Properties (3)
IObjectViewPenItem.BlockColor [Property][Get])
IObjectViewPenItem.Checked [Property][Get/Set]
IObjectViewPenItem.Selected [Property][Get]

IObjectViewPenItem.Blo Gets the color representing this item in the ObjectView.


ckColor [Property][Get] Defined As
„ [VBA] Long BlockColor
„ [Cicode] INT BlockColor
„ [C++] OLE_COLOR BlockColor
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Remarks
The color value can be calculated using the following formula: color = (65536 *
Blue) + (256 * Green) + (Red) where red, green, and blue are 0-255.
131

Calling Syntax
This example assumes there is a valid pen item as retrieved from an ObjectView.
(e.g., VBA: ObjectView.Items.Item(1).Items.Item(1) This will be a pen).
[VBA]
Sub Example(objectViewPenItem As Object)
Dim blockColor As Long
‘Getting Property value
blockColor = objectViewPenItem.BlockColor
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectViewPenItem)
// Getting property value
INT blockColor = _ObjectGetProperty(hObjectViewItem, "BlockColor");
END

IObjectViewPenItem.Ch Gets or Sets whether or not this pen item is checked.


ecked [Property][Get/ Defined As
Set]
„ [VBA] Boolean Checked
„ [Cicode] INT Checked
„ [C++] VARIANT_BOOL Checked
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Limits
„ True (-1): Checked
„ False (0): Unchecked
Remarks
This reflects the pens visibility property directly, and any sets to this property
will reflect immediately in the update of the Process Analyst display.
See Also OVItemChecked [Event]

Calling Syntax
This example assumes there is a valid pen item as retrieved from an ObjectView.
(e.g., VBA: objectView.Items.Item(1).Items.Item(1) This will be a pen).
[VBA]
Sub Example(objectViewPenItem As Object)
Dim checked As Boolean
‘Getting Property value
checked = objectViewPenItem.Checked
‘Setting Property value
objectViewPenItem.Checked = False
End Sub
132

[Cicode]
FUNCTION Example(OBJECT hObjectViewPenItem)
// Getting property value
INT checked = _ObjectGetProperty(hObjectViewItem, "Checked");
// Setting property value
_ObjectSetProperty(hObjectViewItem, "Checked", 0);
END

IObjectViewPenItem.Sel Gets whether or not this pen is the selected pen in its pane.
ected [Property][Get] Defined As
„ [VBA] Boolean Selected
„ [Cicode] INT Selected
„ [C++] VARIANT_BOOL Selected
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Limits
„ True (-1): Selected
„ False (0): Unselected
Remarks
Each Pane has one selected pen. It is visually emphasized by a vertical gradient
fill.
Calling Syntax
This example assumes there is a valid pen item as retrieved from an ObjectView.
(e.g., VBA: objectView.Items.Item(1).Items.Item(1) This will be a pen).
[VBA]
Sub Example(objectViewPenItem As Object)
Dim selected As Boolean
‘Getting Property value
selected = objectViewPenItem.Selected
End Sub
[Cicode]
FUNCTION Example(OBJECT hObjectViewPenItem)
// Getting property value
INT selected = _ObjectGetProperty(hObjectViewItem, "Selected");
END

IPane Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IPanes
133

Methods (1)
IPane.Delete [Method]
Properties (6)
IPane.Height [Property][Get/Set]
IPane.Collection [Property][Get]
IPane.Name [Property][Get/Set]
IPane.BackgroundColor [Property][Get/Set]
IPane.FixedHeight [Property][Get/Set]
IPane.Pens [Property][Get]

IPane.Delete [Method] Removes this Pane from the collection and the display.
Defined As
„ [VBA] Delete()
„ [Cicode] Delete()
„ [C++] HRESULT Delete()
Execution Result
If the method succeeds, the return value will be Success. If the pane is already
deleted, the return value will be GeneralFailure.
Remarks
Any pen associated with the pane will also be deleted.
Calling Syntax
This example assumes there is a valid Pane object to be passed into the example
methods.
[VBA]
Sub Panes(Pane As Object)
Pane.Delete()
End Sub
[Cicode]
FUNCTION Example(OBJECT hPane)
_ObjectCallMethod(hPane, “Delete”);
END

IPane.Height Gets or Sets the height of this pane.


[Property][Get/Set] Defined As
„ [VBA] Long Height
„ [Cicode] INT Height
„ [C++] int Height
Execution Result
If the property get/set succeeds, the return value will be Success. If the height is
out of range (16-1000), the return value will be InvalidArgument. If the pane is
deleted, the return value will be GeneralFailure.
134

Remarks
This property affects the visible height of the Pane in two different ways based
on the Boolean value of the FixedHeight property. If the FixedHeight property is
True, the Pane takes on a pixel height equivalent to the Height property value.
All pens inside the Pane are adjusted to fit. If the FixedHeight property is False,
the Height property value is used as a ratio of the available ‘Variable’ real estate
(all the left over room in the Process Analyst after Fixed Height panes have been
added) which is shared out between all the Variable Height panes.
See Also IPane.FixedHeight [Property][Get/Set]

Calling Syntax
This example assumes there is a valid Pane object to be passed into the example
methods.
[VBA]
Sub Example(Pane As Object)
Dim height As Long
‘Getting Property value
height = Pane.Height
‘Setting Property value
Pane.Height = 250
End Sub
[Cicode]
FUNCTION Example(OBJECT hPane)
// Getting property value
INT nHeight = _ObjectGetProperty(hPane, "Height");
// Setting property value
_ObjectSetProperty(hPane, "Height", 250);
END

IPane.Collection Returns a reference to the Panes collection that this Pane belongs to.
[Property][Get] Defined As
„ [VBA] Object Collection
„ [Cicode] OBJECT Collection
„ [C++] IPanes* Collection
Execution Result
If the property get succeeds the return value will be Success. If the pane is
deleted the return value will be GeneralFailure.
See Also IPanes Interface

Calling Syntax
This example assumes there is a valid Pane object to be passed into the example
methods.
135

[VBA]
Sub Example(pane As Object)
Dim panes As Object
‘Getting Property value
Set panes = pane.Collection
End Sub
[Cicode]
FUNCTION Example(OBJECT hPane)
// Getting property value
OBJECT hPanes = _ObjectGetProperty(hPane, "Collection");
END

IPane.Name Gets or Sets the name of this pane.


[Property][Get/Set] Defined As
„ [VBA] String Name
„ [Cicode] STRING Name
„ [C++] BSTR Name
Execution Result
If the property get/set succeeds, the return value will be Success. If a pane of the
same name exists, the return value will be InvalidArgument. If the panes
collection is deleted, the return value will be GeneralFailure.
Limits
Name must be between 1-250 characters.
Remarks
Pane names must be unique.
Calling Syntax
This example assumes there is a valid Pane object to be passed into the example
methods.
[VBA]
Sub Example(pane As Object)
Dim name As String
‘Getting Property value
name = pane.Name
‘Setting Property value
pane.Name = "Alarms"
End Sub
[Cicode]
FUNCTION Example(OBJECT hPane)
// Getting property value
STRING sName = _ObjectGetProperty(hPane, "Name");
// Setting property value
_ObjectSetProperty(hPane, "Name", "Alarms");
END
136

IPane.BackgroundColor Gets or Sets the color of this Pane.


[Property][Get/Set] Defined As
„ [VBA] Long BackgroundColor
„ [Cicode] INT BackgroundColor
„ [C++] OLE_COLOR BackgroundColor
Execution Result
If the property get/set succeeds, the return value will be Success. If the pane is
deleted, the return value will be GeneralFailure.
Remarks
The color value can be calculated using the following formula: color = (65536 *
Blue) + (256 * Green) + (Red). Where red, green and blue are 0-255.
Calling Syntax
This example assumes there is a valid Pane object to be passed into the example
methods.
[VBA]
Sub Example(Pane As Object)
Dim backgroundColor As Long
‘Getting Property value
backgroundColor = Pane.BackgroundColor
‘Setting Property value to red
Pane.BackgroundColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hPane)
// Getting property value
INT nColor = _ObjectGetProperty(hPane, "BackgroundColor");
// Setting property value
_ObjectSetProperty(hPane, "Name", 255);
END

IPane.FixedHeight Gets or Sets whether this pane has a fixed height.


[Property][Get/Set] Defined As
„ [VBA] Boolean FixedHeight
„ [Cicode] INT FixedHeight
„ [C++] VARIANT_BOOL FixedHeight
Execution Result
If the property get/set succeeds, the return value will be Success. If the pane is
deleted, the return value will be GeneralFailure.
Limits
„ True (-1): Height is fixed
„ False (0): Height is variable
137

Remarks
When this property is true, the pane’s Height reflects the pixel value size as
gotten from the Pane’s Height property. If the FixedHeight property is false, the
Height property value is used as a ratio of the available ‘Variable’ real estate (all
the left over room in the Process Analyst after Fixed Height panes have been
added) which is shared out between all the Variable Height panes.
See Also IPane.Height [Property][Get/Set]

Calling Syntax
This example assumes there is a valid Pane object to be passed into the example
methods.
[VBA]
Sub Example(pane As Object)
Dim fixedHeight As Boolean
‘Getting Property value
fixedHeight = pane.FixedHeight
‘Setting Property value
pane.FixedHeight = True
End Sub
[Cicode]
FUNCTION Example(OBJECT hPane)
// Getting property value
INT bFixedHeight = _ObjectGetProperty(hPane, "FixedHeight");
// Setting property value
_ObjectSetProperty(hPane, "FixedHeight", -1);
END

IPane.Pens Gets a reference to the pens collection object containing the pens for this pane.
[Property][Get] Defined As
„ [VBA] Object Pens
„ [Cicode] OBJECT Pens
„ [C++] IPens* Pens
Execution Result
If the property get succeeds the return value will be Success. If the pane is
deleted the return value will be GeneralFailure.
See Also IPens Interface

Calling Syntax
This example assumes there is a valid Pane object to be passed into the example
methods.
138

[VBA]
Sub Example(pane As Object)
Dim pens As Object
‘Getting Property value
Set pens = pane.Pens
End Sub
[Cicode]
FUNCTION Example(OBJECT hPane)
// Getting property value
OBJECT hPens = _ObjectGetProperty(hPane, "Pens");
END

IPanes Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IPanes
Methods (2)
IPanes.Create [Method]
IPanes.RemoveAll [Method]
Properties (4)
IPanes.Count [Property][Get]
IPanes.Item [Property][Get]
IPanes._NewEnum [Property][Get]
IPanes.ItemByName [Property][Get]

IPanes.Create [Method] Adds a pane to this collection and returns a reference to it.
Defined As
„ [VBA] Create(name as String) as Object
„ [Cicode] OBJECT Create (STRING name)
„ [C++] HRESULT Create(BSTR name, IPane** pane)
Parameters
name
[in] The name to give to the pane (0-250 characters).

Execution Result
If the method succeeds, the return value will be Success. If a pane of the same
name exists, the return value will be InvalidArgument. If the panes collection is
deleted, the return value will be GeneralFailure.
Remarks
When this method succeeds it will return a reference to the new IPane object.
See Also IPanes Interface
139

Calling Syntax
This example assumes there is a valid Panes collection object to be passed into
the example methods.
[VBA]
Sub Example(Panes As Object)
Dim pane As Object
Set pane = Panes.Create(“Alarm Pane”)
End Sub
[Cicode]
FUNCTION Example(OBJECT hPanes)
OBJECT hPane = _ObjectCallMethod(hPanes, “Create”, “Alarm Pane”);
END

IPanes.RemoveAll Removes all Panes from this Pane collection.


[Method] Defined As
„ [VBA] RemoveAll()
„ [Cicode] RemoveAll()
„ [C++] HRESULT RemoveAll()
Execution Result
If the method succeeds, the return value will be Success. If the panes collection is
deleted, the return value will be GeneralFailure.
Calling Syntax
This example assumes there is a valid Panes collection object to be passed into
the example methods.
[VBA]
Sub Panes(Buttons As Object)
Panes.RemoveAll()
End Sub
[Cicode]
FUNCTION Example(OBJECT hPanes)
_ObjectCallMethod(hPanes, “RemoveAll”);
END

IPanes.Count Gets the number of Panes in this collection.


[Property][Get] Defined As
„ [VBA] Long Count
„ [Cicode] INT Count
„ [C++] int Count
Execution Result
If the property get succeeds, the return value will be Success. If the panes
collection is deleted, the return value will be GeneralFailure.
140

Calling Syntax
This example assumes there is a valid Panes collection object to be passed into
the example methods.
[VBA]
Sub Example(Panes As Object)
Dim count As Long
‘Getting Property value
count = Panes.Count
End Sub
[Cicode]
FUNCTION Example(OBJECT hPanes)
// Getting property value
INT nCount = _ObjectGetProperty(hPanes, "Count");
END

IPanes.Item Gets the Pane at the given index in this Pane collection.
[Property][Get] Defined As
„ [VBA] Item(index As Long) as Object
„ [Cicode] OBJECT Item(INT index)
„ [C++] Item(int index, IPane* Item)
Parameters
index
[in] Indicates the location of the Pane item to return from this collection.
(One based)
Execution Result
If the property get succeeds the return value will be Success. If the index is out of
range then the return value will be InvalidArgument. If the panes collection is
deleted the return value will be GeneralFailure.
See Also IPane Interface

Calling Syntax
This example assumes there is a valid Panes collection object to be passed into
the example methods.
[VBA]
Sub Example(Panes As Object)
Dim pane As Object
‘Getting Property value
Set pane = Panes.Item(1)
End Sub
[Cicode]
FUNCTION Example(OBJECT hPanes)
// Getting property value
OBJECT hPane = _ObjectCallMethod(hPanes, "get_Item", 1);
END
141

IPanes._NewEnum This allows For.. Each.. Next integration in VB.


[Property][Get] Calling Syntax
This example assumes there is a valid Panes collection object to be passed into
the example methods. This property is not applicable to Cicode.
[VBA]
Sub Example(Panes As Object)
Dim pane As Object
Dim count As Long
‘Using Property
For Each pane In Panes
count = count + 1
Next pane
End Sub

IPanes.ItemByName Returns a reference to the pane object with the given name from this Panes
[Property][Get] collection.
Defined As
„ [VBA] ByName(name As String) as Object
„ [Cicode] OBJECT ByName(STRING name)
„ [C++] ByName(STRING name, IPane* Item)
Parameters
name
[in] Indicates the name of the Pane item to return from this collection.

Execution Result
If the property get succeeds, the return value will be Success. If the pane cannot
be found, the return value will be InvalidArgument. If the panes collection is
deleted, the return value will be GeneralFailure.
Calling Syntax
This example assumes there is a valid Panes collection object to be passed into
the example methods.
[VBA]
Sub Example(Panes As Object)
Dim pane As Object
‘Getting Property value
Set pane = Panes.ItemByName(“Alarm Pane”)
End Sub
[Cicode]
FUNCTION Example(OBJECT hPanes)
// Getting property value
OBJECT hPane = _ObjectCallMethod(hPanes, "get_ItemByName", "Alarm Pane");
END
142

IPen Interface
Methods
IPen.AddSample
IPen.Clear [Method]
IPen.Delete [Method]
IPen.GetDefaultSpan [Method]
IPen.GetHorizontalAxisTimeSpan [Method]
IPen.GetInformation [Method]
IPen.GetStatistic [Method]
IPen.GetVerticalAxisSpan [Method]
IPen.GoToNow [Method]
IPen.HorizontalScrollBy [Method]
IPen.HorizontalZoom [Method]
IPen.PutHorizontalAxisTimeSpan [Method]
IPen.PutVerticalAxisSpan [Method]
IPen.RefreshData [Method]
IPen.ResetToDefaultSpan [Method]
IPen.Select [Method]
IPen.SetDefaultSpan [Method]
IPen.SetQualityCompactionPointType [Method]
IPen.SetQualityLineStyle [Method]
IPen.SetVerticalAxisLabelValue [Method]
IPen.VerticalScrollBy [Method]
IPen.VerticalZoom [Method]
Properties
IPen.AxisBackgroundColor [Property][Get/Set]
IPen.BlockRepaint [Property][Get/Set]
IPen.Collection [Property][Get]
IPen.DataPoint [Property][Get/Set]
IPen.DataServer [Property][Get/Set]
IPen.Height [Property][Get/Set]
IPen.HorizontalAxisColor [Property][Get/Set]
IPen.HorizontalAxisResize [Property][Get/Set]
IPen.HorizontalAxisScroll [Property][Get/Set]
IPen.HorizontalAxisWidth [Property][Get/Set]
IPen.HorizontalGridlinesColor [Property][Get/Set]
IPen.HorizontalGridlinesStyle [Property][Get/Set]
IPen.HorizontalGridlinesWidth [Property][Get/Set]
IPen.HorizontalMinorGridlinesColor [Property][Get/Set]
IPen.HorizontalMinorGridlinesStyle [Property][Get/Set]
IPen.IsDeleted [Property][Get]
IPen.IsSelected [Property][Get]
IPen.LocalTime [Property][Get/Set]
IPen.Name [Property][Get/Set]
IPen.PointsVisible [Property][Get/Set]
IPen.RequestMode [Property][Get/Set]
IPen.Stacked [Property][Get/Set]
IPen.TrendCursorLabelFillColor [Property][Get/Set]
IPen.TrendCursorLabelLineColor [Property][Get/Set]
IPen.TrendCursorLabelTextColor [Property][Get/Set]
IPen.VerticalAxisAutoscale [Property][Get/Set]
IPen.VerticalAxisColor [Property][Get/Set]
IPen.VerticalAxisLabelType [Property][Get/Set]
143

IPen.VerticalAxisResize [Property][Get/Set]
IPen.VerticalAxisScroll [Property][Get/Set]
IPen.VerticalAxisWidth [Property][Get/Set]
IPen.VerticalGridlinesColor [Property][Get/Set]
IPen.VerticalGridlinesStyle [Property][Get/Set]
IPen.VerticalGridlinesWidth [Property][Get/Set]
IPen.VerticalMinorGridlinesColor [Property][Get/Set]
IPen.VerticalMinorGridlinesStyle [Property][Get/Set]
IPen.Visible [Property][Get/Set]

IPen.AddSample Adds a temporary sample to a pen.


Defined As
„ [VBA] AddSample(value As Double, timeStamp as Date, milli as Integer,
qualityType as Integer, compactionType as Integer)
„ [Cicode] AddSample(REAL value, DATE timeStamp, INT milli, INT
qualityType, INT compactionType)
„ [C++] HRESULT AddSample(double value, DATE timeStamp, short milli,
QualityType qualityType, QualityCompactionType compactionType)
Parameters
value
[in] Indicates the value of the sample that will be added.
timeStamp
[in] Indicates at what time the sample will occur in UTC time.
milli
[in] Indicates the millisecond component of the time stamp (0 to 999).
qualityType
[in] Indicates the quality of the sample that will be added.
compactionType
[in] Indicates what display type the sample will be represented as.

Execution Result
If the function succeeds, the return value will be Success. If an argument is bad,
the return value will be InvalidArgument. If an argument is out of range, the
return value will be InvalidArgument. If the pen is deleted, the return value will
be GeneralFailure. If any other unexpected error occurs, the return value will be
GeneralFailure.
Remarks
This function has limited use as the samples added are stored in a temporary
cache; they can be cleared anytime by time span changes, data refresh calls, or
automation.
You can only add samples to analog or digital pens.
See Also QualityType [Enumeration], QualityCompactionType [Enumeration]

Calling Syntax
144

Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim timeStamp As Date
timestamp = Now
pen.AddSample 75.0, timeStamp, 100, 0, 0
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT iCitectTime;
REAL rOleTime;

iCitectTime = TimeCurrent(); // Returns seconds since 1970


rOleTime = TimeToOleDate(iCitectTime, 1); // Convert to OLE UTC time
_ObjectCallMethod(hPen, "AddSample", 75.0, timeStamp, 100, 0, 0);
END

IPen.Clear [Method] Clears all samples belonging to this pen from the internal cache. (Note: This does
not remove logged samples from the server)
Defined As
„ [VBA] Clear()
„ [Cicode] Clear()
„ [C++] HRESULT Clear()
Execution Result
If the function succeeds the return value will be Success. If the pen is deleted
then the return value will be GeneralFailure.
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
pen.Clear
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
_ObjectCallMethod(hPen, “Clear”);
END

IPen.Delete [Method] Deletes the pen from the Process Analyst.


Defined As
„ [VBA] Delete()
„ [Cicode] Delete()
„ [C++] HRESULT Delete()
Execution Result
145

If the function succeeds, the return value will be Success. If the pen is already
deleted, the return value will be GeneralFailure.
Remarks
Calling this method will mark the pen for deletion, meaning any further calls to
methods or properties on the pen will result in a GeneralFailure error. The pen
will be removed from the display immediately after making this call.
See Also IPen.IsDeleted [Property][Get]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
pen.Delete
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
_ObjectCallMethod(hPen, “Delete”);
END

IPen.GetDefaultSpan Returns the default time span for this pen as a series of time components.
[Method] Defined As
„ [VBA] GetDefaultSpan(weeks As Integer, days As Integer, hours As Integer,
minutes As Integer, seconds As Integer, milliseconds As Integer)
„ [Cicode] GetDefaultSpan (INT weeks, INT days, DATE hours, INT minutes,
INT seconds, INT milliseconds)
„ [C++] HRESULT GetDefaultSpan (short* weeks, short* days, short* hours,
short* minutes, short* seconds, short* milliseconds)
Parameters
weeks
[out] Indicates the number of weeks in the span.
days
[out] Indicates the number of days in the span.
hours
[out] Indicates the number of hours in the span.
minutes
[out] Indicates the number of minutes in the span.
seconds
[out] Indicates the number of seconds in the span.
milliseconds
[out] Indicates the number of milliseconds in the span.
Execution Result
146

If the function succeeds, the return value will be Success. If an argument is bad,
the return value will be InvalidArgument. If the pen is deleted, the return value
will be GeneralFailure. If any other unexpected error occurs, the return value
will be GeneralFailure.
See Also IPen.SetDefaultSpan [Method], IPen.ResetToDefaultSpan [Method]

Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim weeks As Integer
Dim days As Integer
Dim hours As Integer
Dim minutes As Integer
Dim seconds As Integer
Dim milliseconds As Integer
pen.GetDefaultSpan weeks, days, hours, minutes, seconds,
milliseconds
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT weeks;
INT days;
INT hours;
INT minutes;
INT seconds;
INT milliseconds;
_ObjectCallMethod(hPen, “GetDefaultSpan”, weeks, days, hours, minutes, seconds,
milliseconds);
END

IPen.GetHorizontalAxis Returns the start and end time of this pen in local or UTC time format.
TimeSpan [Method] Defined As
„ [VBA] GetHorizontalAxisTimeSpan(startTime As Date, startMs as Integer,
endTime as Date, endMs as Integer, localTime as Boolean)
„ [Cicode] GetHorizontalAxisTimeSpan (REAL startTime, INT startMs, REAL
endTime, INT endMs, INT localTime)
„ [C++] HRESULT GetHorizontalAxisTimeSpan (DATE* startTime, short*
startMs, DATE* endTime, short* endMs, VARIANT_BOOL localTime)
Parameters
startTime
[out] This will contain the beginning date and time without milliseconds of
the time span.
startMs
[out] This will contain the milliseconds component of the start time.
endTime
147

[out] This will contain the end date and time without milliseconds.of the
time span.
endMs
[out] This will contain the milliseconds component of the end time.
localTime
[in] Indicates whether the times returned are in local time or UTC. True = -
1, False (0) = UTC.
Execution Result
If the function succeeds, the return value will be Success. If an argument is bad,
the return value will be InvalidArgument. If the pen is deleted, the return value
will be GeneralFailure. If any other unexpected error occurs, the return value
will be GeneralFailure.
See Also IPen.PutHorizontalAxisTimeSpan [Method]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim startDate As Date
Dim endDate As Date
Dim startMs As Integer
Dim endMs As Integer
pen.GetHorizontalAxisTimeSpan startDate, startMs, endDate,
endMs, True
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
REAL startDate;
REAL endDate;
INT startMs;
INT endMs;
_ObjectCallMethod(hPen, “GetHorizontalAxisTimeSpan”, startDate, startMs, endDate,
endMs, -1);
END

IPen.GetInformation Returns information associated with this pen.


[Method] Defined As
„ [VBA] GetInformation(name As String) As String
„ [Cicode] STRING GetInformation(STRING name)
„ [C++] HRESULT GetDefaultSpan (BSTR name, BSTR* value)
Parameters
name
[in] Specify the pen information attribute you want to get the value for. See
Remarks below for supported attributes.
148

value
[out] Indicates the value of the specified information attribute.

Execution Result
If the function succeeds, the return value will be Success. If an argument is bad,
the return value will be InvalidArgument. If the attribute does not exist, the
return value will be InvalidArgument. If the pen is deleted, the return value will
be GeneralFailure. If any other unexpected error occurs, the return value will be
GeneralFailure.
Information Attributes
Attribute Returns Applies to
Alarm Area Alarm tag field Alarm
Alarm Category Alarm tag field Alarm
Alarm Desc Alarm tag field Alarm
Alarm Name Alarm tag field Alarm
Alarm Type Alarm tag field Alarm
Comment Alarm/Trend tag comment field All
Duration Process Analyst time span All
End Time Process Analyst axis end time All
Engineering Full Scale Trend tag field Analog, Digital
Engineering Units Trend tag field Analog, Digital
Engineering Zero Scale Trend tag field Analog, Digital
Error Process Analyst error status All
Full Scale Process Analyst vertical axis max scale Analog,
Name Process Analyst pen name All
Raw Full Scale Trend tag field Analog, Digital
Raw Zero Scale Trend tag field Analog, Digital
Sample Period Trend tag field Analog, Digital
Start Time Process Analyst axis start time All
Tag Process Analyst source binding field All
Trend Type Trend tag field Analog, Digital
Zero Scale Process Analyst vertical axis min scale Analog
Scale Process Analyst vertical axis scale range Analog, Digital
Engineering Scale Engineering scale range Analog, Digita

Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim duration As String
duration = pen.GetInformation "Duration"
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
STRING duration;
duration = _ObjectCallMethod(hPen, "GetInformation", "Duration");
END
149

IPen.GetStatistic Returns the result of a specified Process Analyst statistical operation.


[Method] Defined As
„ [VBA] GetStatistic(name As String, value As String)
„ [Cicode] GetStatistic(STRING name, STRING value)
„ [C++] HRESULT GetStatistic(BSTR name, BSTR* value)
Parameters
name
[in] Specify the statistic attribute you want to get the value for. See
Remarks below for supported attributes.
value
[out] Indicates the value of the specified statistic attribute.

Execution Result
If the function succeeds, the return value will be Success. If an argument is bad,
the return value will be InvalidArgument. If the attribute does not exist, the
return value will be InvalidArgument. If the pen is deleted, the return value will
be GeneralFailure. If any other unexpected error occurs, the return value will be
GeneralFailure.
Information Attributes
Attribute Returns Applies to
Average Process Analyst real-time average Analog, Digital
Maximum Process Analyst real-time maximum Analog
Minimum Process Analyst real-time minimum Analog

Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim average As String
pen.GetStatistic “Average”, average
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
STRING average;
_ObjectCallMethod(hPen, “GetStastic”, “Average”, average);
END

IPen.GetVerticalAxisSp Returns the current span of the pens’ vertical axis.


an [Method] Defined As
„ [VBA] GetVerticalAxisSpan(startValue As Double, endValue As Double)
„ [Cicode] GetVerticalAxisSpan (REAL startValue, REAL endValue)
„ [C++] HRESULT GetVerticalAxisSpan (double* startValue, double*
endValue)
150

Parameters
startValue
[out] The current lower bound of the vertical axis.
endValue
[out] The current upper bound of the vertical axis.

Execution Result
If the function succeeds, the return value will be Success. If an argument is bad,
the return value will be InvalidArgument. If the pen is deleted, the return value
will be GeneralFailure. If any other unexpected error occurs, the return value
will be GeneralFailure.
See Also IPen.PutVerticalAxisSpan [Method]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim startValue As Double
Dim endValue As Double
pen.GetVerticalAxisSpan startValue, endValue
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
REAL startValue;
REAL endValue;
_ObjectCallMethod(hPen, “GetVerticalAxisSpan”, startValue, endValue);
END

IPen.GoToNow Synchronizes the end time of the pen’s span with your computer’s current local
[Method] time. The start time will also be moved to maintain the pen’s current time span.
Defined As
„ [VBA] GoToNow()
„ [Cicode] GoToNow()
„ [C++] HRESULT GoToNow()
Execution Result
If the function succeeds, the return value will be Success. If the pen is deleted,
the return value will be GeneralFailure.
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
pen.GoToNow
End Sub
151

[Cicode]
FUNCTION Example(OBJECT hPen)
_ObjectCallMethod(hPen, “GoToNow”);
END

IPen.HorizontalScrollBy Scrolls the horizontal axis by the specified factor.


[Method] Defined As
„ [VBA] HorizontalScrollBy(factor As Double)
„ [Cicode] HorizontalScrollBy(REAL factor)
„ [C++] HRESULT HorizontalScrollBy(double factor)
Parameters
factor
[in] Controls the direction and amount the axis will be scrolled. A negative
value will move the axis back in time; a positive value will move the axis
forward in time. The value is a percentage representing the current viewable
span. So if the pen span is 1 hour, and you specify a factor of 0.5, you will
move the time span 30 minutes into the future.
Execution Result
If the function succeeds, the return value will be Success. If the argument is bad,
the return value will be InvalidArgument. If the pen is deleted, the return value
will be GeneralFailure.
See Also IPen.VerticalScrollBy [Method]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
‘ Move the pen span back one complete span into history
pen.HorizontalScrollBy -1.0
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
// Move the pen span back one complete span into history
_ObjectCallMethod(hPen, “HorizontalScrollby”, -1.0);
END

IPen.HorizontalZoom Zooms centrally into the time span by the given factor.
[Method] Defined As
„ [VBA] HorizontalZoom(factor As Double)
„ [Cicode] HorizontalZoom(REAL factor)
„ [C++] HRESULT HorizontalZoom(double factor)
Parameters
factor
152

[in] Controls the direction and amount the axis will be zoomed. Acceptable
zoom values are 0 to 1 (Zoom out) and > 1 (zoom in).
Execution Result
If the function succeeds the return value will be Success. If the argument is bad
then the return value will be InvalidArgument. If the argument is out of range
then the return value will be InvalidArgument. If the pen is deleted then the
return value will be GeneralFailure.
See Also IPen.VerticalZoom [Method]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
‘ Zoom out 50%
pen.HorizontalZoom 0.5
‘ Undo the Zoom
pen.HorizontalZoom 1.5
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
// Zoom out 50%
_ObjectCallMethod(hPen, “HorizontalZoom”, 0.5);
// Undo the Zoom
_ObjectCallMethod(hPen, “HorizontalZoom”, 2.0);
END

IPen.PointsVisible Gets or Sets whether the sample points are displayed or hidden on the pen.
[Property][Get/Set] Defined As
„ [VBA] Boolean PointsVisible
„ [Cicode] INT PointsVisible
„ [C++] VARIANT_BOOL PointsVisible
Execution Results
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Limits
„ True(-1): Points are visible
„ False(0): Points are hidden
Remarks
By default this property is False, meaning that any point type you have set using
the SetQualityCompactionPointType function will be hidden.
See Also IPen.SetQualityCompactionPointType [Method]
Calling Syntax
153

Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim visible As Boolean
‘Getting Property value
visible = pen.PointsVisible
‘Setting Property value
pen.PointsVisible = True
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT visible;
// Getting current property value
visible = _ObjectGetProperty(hPen, "PointsVisible");
// Setting Property value
_ObjectSetProperty(hPen, "PointsVisible", -1);
END

IPen.PutHorizontalAxis Sets the start and end time of this pen.


TimeSpan [Method] Defined As
„ [VBA] PutHorizontalAxisTimeSpan(startTime As Date, startMs as Integer,
endTime as Date, endMs as Integer)
„ [Cicode] PutHorizontalAxisTimeSpan (REAL startTime, INT startMs, REAL
endTime, INT endMs)
„ [C++] HRESULT PutHorizontalAxisTimeSpan (DATE* startTime, short*
startMs, DATE* endTime, short* endMs)
Parameters
startTime
[in] Indicates the beginning date and time without milliseconds of the time
span in UTC format.
startMs
[in] Indicates the milliseconds component of the start time.
endTime
[in] Indicates the end date and time without milliseconds of the time span
in UTC format.
endMs
[in] This will contain the milliseconds component of the end time.

Execution Result
If the function succeeds the return value will be Success. If an argument is bad
then the return value will be InvalidArgument. If an argument is out of range
then the return value will be InvalidArgument. If the pen is deleted then the
return value will be GeneralFailure. If any other unexpected error occurs the
return value will be GeneralFailure.
154

Remarks
The Process Analyst only supports setting its axis in UTC (Universal Co-
ordinated Time) format. This means you must convert from local to UTC format
yourself to make the axis display correctly in local time. Cicode provides several
functions to do these conversions.
Limits
The horizontal axis has an upper limit of 1/1/2100 12:00:00.000 and a lower limit
of 1/1/1900 12:00:00.000. The minimum span is 100 milliseconds. The maximum
span is 200 years.
See Also IPen.GetHorizontalAxisTimeSpan [Method]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim startDate As Date
Dim endDate As Date
Dim startMs As Integer
Dim endMs As Integer
startDate = CDate(“16/6/2004 11:30:00”)
endDate = CDate(“16/6/2004 12:29:00”)
startMs = 0
endMs = 0
pen.PutHorizontalAxisTimeSpan startDate, startMs, endDate, endMs
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
REAL startDate;
REAL endDate;
startDate = StrToDate("16/6/04") + StrToTime("9:30:00");
endDate = StrToDate("16/6/04") + StrToTime("10:29:00");
startDate = TimeToOLEDate(startDate, 0); // Convert to UTC
endDate = TimeToOLEDate(endDate, 0); // Convert to UTC
_ObjectcallMethod(hPen, "PutHorizontalAxisTimeSpan", startDate, 0, endDate, 0);
END

IPen.PutVerticalAxisSp Sets the current position and span of the pens’ vertical axis.
an [Method] Defined As
„ [VBA] GetVerticalAxisSpan(startValue As Double, endValue As Double)
„ [Cicode] GetVerticalAxisSpan (REAL startValue, REAL endValue)
„ [C++] HRESULT GetVerticalAxisSpan (double* startValue, double*
endValue)
Parameters
startValue
[in] Indicates the new lower bound of the vertical axis.
endValue
155

[in] Indicates the new upper bound of the vertical axis.


Execution Result
If the function succeeds, the return value will be Success. If an argument is bad,
the return value will be InvalidArgument. If an argument is out of range, or the
span is out of range, the return value will be InvalidArgument. If the pen is
deleted, the return value will be GeneralFailure.
Limits
The vertical axis has a upper limit of 1+e10 and a lower limit of 1-e10. However,
the maximum span supported is 1+e10. The minimum span is 0.00001.
See Also IPen.GetVerticalAxisSpan [Method]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
pen.PutVerticalAxisSpan 200.5, 300.34
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
_ObjectCallMethod(hPen, “PutVerticalAxisSpan”, 200.5, 300.34);
END

IPen.RefreshData Clears all samples belonging to this pen from the internal cache and then issues
[Method] a new request for data.
Defined As
„ [VBA] RefreshData()
„ [Cicode] RefreshData ()
„ [C++] HRESULT RefreshData ()
Execution Result
If the function succeeds the return value will be Success. If the pen is deleted
then the return value will be GeneralFailure.
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
pen.RefreshData
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
_ObjectCallMethod(hPen, “RefreshData”);
END
156

IPen.ResetToDefaultSp Resets the span of this pen to its default span.


an [Method] Defined As
„ [VBA] ResetToDefaultSpan()
„ [Cicode] ResetToDefaultSpan()
„ [C++] HRESULT ResetToDefaultSpan()
Execution Result
If the function succeeds, the return value will be Success. If the pen is deleted,
the return value will be GeneralFailure.
Remarks
The default span of all pens is 10 minutes. This can be modified by using
IPen.SetDefaultSpan.
See Also IPen.GetDefaultSpan [Method], IPen.SetDefaultSpan [Method]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
pen.ResetToDefaultSpan
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
_ObjectCallMethod(hPen, “ResetToDefaultSpan”);
END

IPen.Select [Method] Makes this pen the primary selected pen.


Defined As
„ [VBA] Select()
„ [Cicode] Select()
„ [C++] HRESULT Select()
Execution Result
If the function succeeds, the return value will be Success. If the pen is deleted,
the return value will be GeneralFailure.
Remarks
Calling this method will also trigger PenSelectionChanged [Event].
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
pen.Select
End Sub
157

[Cicode]
FUNCTION Example(OBJECT hPen)
_ObjectCallMethod(hPen, “Select”);
END

IPen.SetDefaultSpan Sets the default time span for this pen.


[Method] Defined As
„ [VBA] SetDefaultSpan(weeks As Integer, days As Integer, hours As Integer,
minutes As Integer, seconds As Integer, milliseconds As Integer)
„ [Cicode] SetDefaultSpan (INT weeks, INT days, DATE hours, INT minutes,
INT seconds, INT milliseconds)
„ [C++] HRESULT SetDefaultSpan (short weeks, short days, short hours, short
minutes, short seconds, short milliseconds)
Parameters
weeks
[in] Indicates the number of weeks in the span.
days
[in] Indicates the number of days in the span.
hours
[in] Indicates the number of hours in the span.
minutes
[in] Indicates the number of minutes in the span.
seconds
[in] Indicates the number of seconds in the span.
milliseconds
[in] Indicates the number of milliseconds in the span.

Execution Result
If the function succeeds the return value will be Success. If an argument is bad
then the return value will be InvalidArgument. If the pen is deleted then the
return value will be GeneralFailure.
See Also IPen.GetDefaultSpan [Method], IPen.ResetToDefaultSpan [Method]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
‘ Set span to 2 hours and 30 minutes
pen.GetDefaultSpan 0, 0, 2, 30, 0, 0
End Sub
158

[Cicode]
FUNCTION Example(OBJECT hPen)
// Set span to 2 hours and 30 minutes
_ObjectCallMethod(hPen, “SetDefaultSpan”, 0, 0, 2, 30, 0, 0);
END

IPen.SetQualityCompac Use this function to indicate what visual cue to display for single and multiple
tionPointType [Method] samples.
Defined As
„ [VBA] SetQualityCompactionPointType(compactionType As Integer,
pointType As Integer)
„ [Cicode] SetQualityCompactionPointType(INT compactionType, INT
pointType)
„ [C++] HRESULT SetQualityCompactionPointType(QualityCompactionType
compactionType, PointType pointType)
Parameters
compactionType
[in] Indicates which sample compaction type you want to set the visual cue
for.
pointType
[in] Indicates which visual cue to use for the selected compaction type.

Execution Result
If the function succeeds the return value will be Success. If an argument is bad,
the return value will be InvalidArgument. If an argument is out of range, the
return value will be InvalidArgument. If the pen is deleted, the return value will
be GeneralFailure.
See Also QualityCompactionType [Enumeration], PointType [Enumeration]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
‘ Set single samples to lsook like triangles
pen.SetQualityCompactionPointType 0, 5
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
// Set single samples to look like triangles
_ObjectCallMethod(hPen, "SetQualityCompactionPointType", 0, 5);
END

IPen.SetQualityLineStyl This function can be used to change the type of line drawn for each of the quality
e [Method] states defined by the Process Analyst for this Pen only.
Defined As
159

„ [VBA] SetQualityLineStyle(qualityType As Integer, lineStyle As Integer)


„ [Cicode] SetQualityLineStyle(INT qualityType, INT lineStyle)
„ [C++] HRESULT SetQualityLineStyle(QualityType qualityType, LineStyle
lineStyle)
Parameters
qualityType
[in] Indicates which quality type you want to set the visual cue for.
lineStyle
[in] Indicates which line style visual cue to use for the selected quality type.

Execution Result
If the function succeeds the return value will be Success. If an argument is bad
then the return value will be InvalidArgument. If an argument is out of range
then the return value will be InvalidArgument. If the pen is deleted then the
return value will be GeneralFailure.
Remarks
When a sample is added to the display, its quality value indicates how the line
drawn from that sample to the next one will be displayed.
See Also QualityType [Enumeration], LineStyle [Enumeration]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
‘ Set all lines drawn after NA samples to be drawn as dash_dot
pen.SetQualityLineStyle 1, 3
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
// Set all lines drawn after NA samples to be drawn as dash_dot
_ObjectCallMethod(hPen, “SetQualityLineStyle”, 1, 3);
END

IPen.SetVerticalAxisLab This function can be used to display custom text for a particular value on the
elValue [Method] Vertical Axis.
Defined As
„ [VBA] SetVerticalAxisLabelValue(value As Double, label As String)
„ [Cicode] SetVerticalAxisLabelValue(REAL value, STRING label)
„ [C++] HRESULT SetVerticalAxisLabelValue(double value, BSTR label)
Parameters
value
[in] Indicates which value you want to replace with a custom label.
160

label
[in] Indicates the text that will be displayed instead of the specified value.

Execution Result
If the function succeeds the return value will be Success. If an argument is bad
then the return value will be InvalidArgument. If the pen is deleted then the
return value will be GeneralFailure.
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
‘ Change the vertical axis to display High High instead of 95
pen.SetVerticalAxisLabelValue 95, “High High”
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
// Change the vertical axis to display High High instead of 95
_ObjectCallMethod(hPen, “SetVerticalAxisLabelValue”, 95, “High High”);
END

IPen.VerticalScrollBy Scrolls the vertical axis by the specified factor.


[Method] Defined As
„ [VBA] VerticalScrollBy(factor As Double)
„ [Cicode] VerticalScrollBy(REAL factor)
„ [C++] HRESULT VerticalScrollBy(double factor)
Parameters
factor
[in] Controls the direction and amount the axis will be scrolled. A negative
value will move the axis in the negative direction. A positive value will
move the axis forward in the positive direction. The value is a percentage
representing the current viewable span. So if the pen span is 100 units (10 to
110), and you specify a factor of 0.5 then you will move the span 50 units (60
to 160).
Execution Result
If the function succeeds the return value will be Success. If the argument is bad
then the return value will be InvalidArgument. If the pen is deleted then the
return value will be GeneralFailure.
See Also IPen.HorizontalScrollBy [Method]
Calling Syntax
Assumes you have passed a valid pen object into the function.
161

[VBA]
Sub Example(pen As Object)
‘ Move the pen span forward one complete span
pen.VerticalScrollBy 1.0
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
// Move the pen span forward one complete span
_ObjectCallMethod(hPen, “VerticalScrollby”, 1.0);
END

IPen.VerticalZoom Zooms centrally into the time span by the given factor on the vertical axis
[Method] Defined As
„ [VBA] VerticalZoom(factor As Double)
„ [Cicode] VerticalZoom (REAL factor)
„ [C++] HRESULT VerticalZoom (double factor)
Parameters
factor
[in] Controls the direction and amount the axis will be zoomed. Acceptable
zoom values are 0 to 1 (Zoom out) and > 1 (zoom in).
Execution Result
If the function succeeds the return value will be Success. If the argument is bad
then the return value will be InvalidArgument. If the argument is out of range
then the return value will be InvalidArgument. If the pen is deleted then the
return value will be GeneralFailure.
See Also IPen.HorizontalZoom [Method]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
‘ Zoom out 50%
pen.VerticalZoom 0.5
‘ Undo the Zoom
pen.VerticalZoom 1.5
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
// Zoom out 50%
_ObjectCallMethod(hPen, “VerticalZoom”, 0.5);
// Undo the Zoom
_ObjectCallMethod(hPen, “VerticalZoom”, 2.0);
END
162

IPen.AxisBackgroundC Gets or sets the background color of the axis of this pen.
olor [Property][Get/Set] Defined As
„ [VBA] Long BackgroundColor
„ [Cicode] INT BackgroundColor
„ [C++] OLE_COLOR BackgroundColor
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted then the return value will be GeneralFailure.
Remarks
The background is the area underneath the axis lines and values.
To calculate the integer value required for a color apply the following formula
(65536 * Blue) + (256 * Green) + (Red). Where Red, Green and Blue are 0-255
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim backgroundColor As Long
‘Getting Property value
backgroundColor = pen.AxisBackgroundColor
‘Setting Property value to Red
pen.AxisBackgroundColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT backgroundColor;
// Getting current property value
backgroundColor = _ObjectGetProperty(hPen, “AxisBackgroundColor”);
// Setting Property to Red
_ObjectSetProperty(hPen, “AxisBackgroundColor”, PackedRGB(255, 0, 0));
END

IPen.BlockRepaint Use this property to halt or continue any drawing updates to this pen.
[Property][Get/Set] Defined As
„ [VBA] Boolean BlockRepaint
„ [Cicode] INT BlockRepaint
„ [C++] VARIANT_BOOL BlockRepaint
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted then the return value will be GeneralFailure.
Remarks
163

This property is useful if you are modifying several properties at once as it will
help reduce flicker and the amount of processing required. Simply set the
property to True (-1), change as many properties as you want, and then set the
property to False (0).
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim blockRepaint As Boolean
‘Getting Property value
blockRepaint = pen.BlockRepaint
‘Setting Property value
pen.BlockRepaint = True
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT bBlockRepaint;
// Getting current property value
bBlockRepaint = _ObjectGetProperty(hPen, “BlockRepaint”);
// Setting Property
_ObjectSetProperty(hPen, “BlockRepaint”, -1);
END

IPen.Collection Returns a reference to the Pens collection object that this pen belongs to.
[Property][Get] Defined As
„ [VBA] Object Collection
„ [Cicode] OBJECT Collection
„ [C++] IPen* Collection
Execution Result
If the property get succeeds the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim pens As Object
‘Getting Property value
Set pens = pen.Collection
End Sub
164

[Cicode]
FUNCTION Example(OBJECT hPen)
OBJECT pens;
// Getting current property value
pens = _ObjectGetProperty(hPen, “Collection”);
END

IPen.DataPoint Get or Set the trend/alarm tag which this pen is bound to.
[Property][Get/Set] Defined As
„ [VBA] String DataPoint
„ [Cicode] STRING DataPoint
„ [C++] BSTR DataPoint
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the tag is greater
than 79 characters, the return value will be InvalidArgument. If the pen is
deleted, the return value will be GeneralFailure.
Remarks
This property works in conjunction with the DataServer property. This property
can be changed during the lifetime of the pen. Changing the DataPoint property
will result in the data cache being cleared and a new data request issued. A
request for the tag’s information will also be issued.
See Also IPen.DataServer [Property][Get/Set]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim tag As String
‘Getting Property value
tag = pen.DataPoint
‘Setting Property value
pen.DataPoint = “LOOP_1_PV”
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
STRING tag;
// Getting current property value
tag = _ObjectGetProperty(hPen, “DataPoint”);
// Setting Property
_ObjectSetProperty(hPen, “DataPoint”, “LOOP_1_PV”);
END

IPen.DataServer Get or Set the server that this pen is bound to.
[Property][Get/Set] Defined As
„ [VBA] String DataServer
165

„ [Cicode] STRING DataServer


„ [C++] BSTR DataServer
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the server
connection cannot be found, the return value will be InvalidArgument. If the
pen is deleted, the return value will be GeneralFailure.
Remarks
This property currently only supports two options, “localhost” and “” (empty
string), which indicates an unbound connection. Local host means the pen will
use the local Vijeo Citect client to source data from the Vijeo Citect trend/alarm
servers.
This property works in conjunction with the DataPoint property. This property
can be changed during the lifetime of the pen.
See Also IPen.DataPoint [Property][Get/Set]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim server As String
‘Getting Property value
server = pen.DataServer
‘Setting Property value
pen.DataPoint = “localhost”
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
STRING server;
// Getting current property value
server = _ObjectGetProperty(hPen, “DataServer”);
// Setting Property
_ObjectSetProperty(hPen, “DataServer”, “localhost”);
END

IPen.Height Get or Set the physical height in pixels that the pen will allocate for itself when
[Property][Get/Set] displayed in Stacked mode.
Defined As
„ [VBA] Integer Height
„ [Cicode] INT Height
„ [C++] double Height
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If height set is out of
166

range (16 – 1000), the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Remarks
This property is ignored when the pen is not in Stacked mode.
See Also IPen.Stacked [Property][Get/Set]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim height As Boolean
`Getting Property value
height = pen.Height
`Setting Property value
pen.Height = 75
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT height;
// Getting current property value
height = _ObjectGetProperty(hPen, "Height");
// Setting Property
_ObjectSetProperty(hPen, "Height", 75);
END

IPen.HorizontalAxisCol Gets or sets the color used to draw the line, labels, and interval markers of the
or [Property][Get/Set] horizontal axis of this pen.
Defined As
„ [VBA] Long HorizontalAxisColor
„ [Cicode] INT HorizontalAxisColor
„ [C++] OLE_COLOR HorizontalAxisColor
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Remarks
To calculate the integer value required for a color apply the following formula:
(65536 * Blue) + (256 * Green) + (Red)
where Red, Green, and Blue are 0-255.
See Also IPen.VerticalAxisColor [Property][Get/Set]
Calling Syntax
Assumes you have passed a valid pen object into the function.
167

[VBA]
Sub Example(pen As Object)
Dim color As Long
‘Getting Property value
color = pen.HorizontalAxisColor
‘Setting Property value to Red
pen.HorizontalAxisColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT color;
// Getting current property value
color = _ObjectGetProperty(hPen, “HorizontalAxisColor”);
// Setting Property to Red
_ObjectSetProperty(hPen, “HorizontalAxisColor”, PackedRGB(255, 0, 0));
END

IPen.HorizontalAxisResi Gets or sets whether this pen allows the operator to interactively scale the
ze [Property][Get/Set] horizontal axis using the mouse.
Defined As
„ [VBA] Boolean HorizontalAxisResize
„ [Cicode] INT HorizontalAxisResize
„ [C++] VARIANT_BOOL HorizontalAxisResize
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Limits
„ True (-1): Axis can be resized
„ False (0): Axis cannot be resized
See Also IPen.VerticalAxisResize [Property][Get/Set]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim resize As Boolean
‘Getting Property value
resize = pen.HorizontalAxisResize
‘Setting Property value
pen.HorizontalAxisResize = False
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT bResize;
// Getting current property value
168

bResize = _ObjectGetProperty(hPen, “HorizontalAxisResize”);


// Setting Property
_ObjectSetProperty(hPen, “HorizontalAxisResize”,0);
END

IPen.HorizontalAxisScr Gets or sets whether this pen allows the operator to interactively scroll the
oll [Property][Get/Set] horizontal axis using the mouse.
Defined As
„ [VBA] Boolean HorizontalAxisScroll
„ [Cicode] INT HorizontalAxisScroll
„ [C++] VARIANT_BOOL HorizontalAxisScroll
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted then the return value will be GeneralFailure.
Limits
„ True (-1): Axis can be scrolled
„ False (0): Axis cannot be scrolled
See Also IPen.VerticalAxisScroll [Property][Get/Set]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim scroll As Boolean
‘Getting Property value
scroll = pen.HorizontalAxisScroll
‘Setting Property value
pen.HorizontalAxisScroll = False
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT bScroll;
// Getting current property value
bScroll = _ObjectGetProperty(hPen, “HorizontalAxisScroll”);
// Setting Property
_ObjectSetProperty(hPen, “HorizontalAxisScroll”, 0);
END

IPen.HorizontalAxisWid Gets or sets the width of the horizontal axis line and the associated interval
th [Property][Get/Set] markers.
Defined As
„ [VBA] Integer HorizontalAxisWidth
„ [Cicode] INT HorizontalAxisWidth
„ [C++] short HorizontalAxisWidth
169

Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Limits
A valid width is 0-8 pixels.
See Also IPen.VerticalAxisWidth [Property][Get/Set]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim width As Integer
‘Getting Property value
width = pen.HorizontalAxisWidth
‘Setting Property value
pen.HorizontalAxisWidth = 3
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT width;
// Getting current property value
width = _ObjectGetProperty(hPen, “HorizontalAxisWidth”);
// Setting Property
_ObjectSetProperty(hPen, “HorizontalAxisWidth”, 3);
END

IPen.HorizontalGridline Gets or sets the color used to draw the major horizontal gridlines.
sColor [Property][Get/ Defined As
Set]
„ [VBA] Long HorizontalGridlinesColor
„ [Cicode] INT HorizontalGridlinesColor
„ [C++] OLE_COLOR HorizontalGridlinesColor
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Limits
A valid width is 0-8 pixels.
Remarks
To calculate the integer value required for a color apply the following formula
(65536 * Blue) + (256 * Green) + (Red). Where Red, Green and Blue are 0-255
See Also IPen.HorizontalMinorGridlinesColor [Property][Get/Set]
Calling Syntax
170

Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim color As Long
‘Getting Property value
color = pen.HorizontalGridlinesColor
‘Setting Property value to Red
pen.HorizontalGridlinesColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT color;
// Getting current property value
color = _ObjectGetProperty(hPen, “HorizontalGridlinesColor”);
// Setting Property to Red
_ObjectSetProperty(hPen, “HorizontalGridlinesColor”, PackedRGB(255, 0, 0));
END

IPen.HorizontalGridline Gets or sets the line style used to draw the major horizontal gridlines.
sStyle [Property][Get/ Defined As
Set]
„ [VBA] Long HorizontalGridlinesStyle
„ [Cicode] INT HorizontalGridlinesStyle
„ [C++] LineStyle HorizontalGridlinesStyle
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the style is out of
range, the return value will be InvalidArgument. If the pen is deleted, the return
value will be GeneralFailure.
See Also IPen.HorizontalMinorGridlinesColor [Property][Get/Set], LineStyle
[Enumeration]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim style As Long
‘Getting Property value
style = pen.HorizontalGridlinesStyle
‘Setting Property value to Dot
pen.HorizontalGridlinesColor = 2
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT style;
// Getting current property value
style = _ObjectGetProperty(hPen, “HorizontalGridlinesStyle”);
171

// Setting Property to Dot


_ObjectSetProperty(hPen, “HorizontalGridlinesStyle”, 2);
END

IPen.HorizontalGridline Gets or sets the line width used when drawing the major horizontal gridlines.
sWidth [Property][Get/ Defined As
Set]
„ [VBA] Integer HorizontalGridlinesWidth
„ [Cicode] INT HorizontalGridlinesWidth
„ [C++] short HorizontalGridlinesWidth
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the width is out of
range, the return value will be InvalidArgument. If the pen is deleted, the return
value will be GeneralFailure.
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim width As Integer
‘Getting Property value
width = pen.HorizontalGridlinesWidth
‘Setting Property value
pen.HorizontalGridlinesWidth = 3
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT width;
// Getting current property value
width = _ObjectGetProperty(hPen, “HorizontalGridlinesWidth”);
// Setting Property t
_ObjectSetProperty(hPen, “HorizontalGridlinesWidth”, 3);
END

IPen.HorizontalMinorGri Gets or sets the color used to draw the minor horizontal gridlines.
dlinesColor Defined As
[Property][Get/Set]
„ [VBA] Long HorizontalMinorGridlinesColor
„ [Cicode] INT HorizontalMinorGridlinesColor
„ [C++] OLE_COLOR HorizontalMinorGridlinesColor
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Remarks
172

To calculate the integer value required for a color apply the following formula:
(65536 * Blue) + (256 * Green) + (Red)
where Red, Green, and Blue are 0-255.
See Also IPen.HorizontalGridlinesColor [Property][Get/Set]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim color As Long
‘Getting Property value
color = pen.HorizontalMinorGridlinesColor
‘Setting Property value to Red
pen.HorizontalMinorGridlinesColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT color;
// Getting current property value
color = _ObjectGetProperty(hPen, “HorizontalMinorGridlinesColor”);
// Setting Property to Red
_ObjectSetProperty(hPen, “HorizontalMinorGridlinesColor”, PackedRGB(255, 0, 0));
END

IPen.HorizontalMinorGri Gets or sets the line style used to draw the minor horizontal gridlines.
dlinesStyle Defined As
[Property][Get/Set]
„ [VBA] Long HorizontalMinorGridlinesStyle
„ [Cicode] INT HorizontalMinorGridlinesStyle
„ [C++] LineStyle HorizontalMinorGridlinesStyle
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the style is out of
range, the return value will be InvalidArgument. If the pen is deleted, the return
value will be GeneralFailure.
See Also IPen.HorizontalGridlinesStyle [Property][Get/Set], LineStyle
[Enumeration]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim style As Long
‘Getting Property value
style = pen.HorizontalMinorGridlinesStyle
173

‘Setting Property value to Dot


pen.HorizontalMinorGridlinesColor = 2
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT style;
// Getting current property value
style = _ObjectGetProperty(hPen, “HorizontalMinorGridlinesStyle”);
// Setting Property to Dot
_ObjectSetProperty(hPen, “HorizontalMinorGridlinesStyle”, 2);
END

IPen.IsDeleted Returns whether this pen has been marked for deletion. That is, whether
[Property][Get] someone has called the Delete method on it or deleted it from the display.
Defined As
„ [VBA] Boolean IsDeleted
„ [Cicode] INT IsDeleted
„ [C++] VARIANT_BOOL IsDeleted
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
See Also IPen.Delete [Method]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim deleted As Boolean
deleted = pen.IsDeleted
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT bDeleted;
bDeleted = _ObjectGetProperty(hPen, “IsDeleted”);
END

IPen.IsSelected Returns whether this pen has been selected in the Process Analyst.
[Property][Get] Defined As
„ [VBA] Boolean IsSelected
„ [Cicode] INT IsSelected
„ [C++] VARIANT_BOOL IsSelected
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
174

See Also IPen.Select [Method]


Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim selected As Boolean
selected = pen.IsSelected
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT bSelected;
bSelected = _ObjectGetProperty(hPen, “IsSelected”);
END

IPen.LocalTime Get or Set whether the axis will display time in the computers current local
[Property][Get/Set] format or in UTC (Universal Time Coordinate).
Defined As
„ [VBA] Boolean LocalTime
„ [Cicode] INT LocalTime
„ [C++] VARIANT_BOOL LocalTime
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Limits
„ True (-1): Local format
„ False (0): UTC format
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim localTime As Boolean
‘Getting Property value
localTime = pen.LocalTime
‘Display time in UTC
pen.LocalTime = False
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT bLocalTime;
// Getting current property value
bLocalTime = _ObjectGetProperty(hPen, “LocalTime”);
175

// Display time in UTC


_ObjectSetProperty(hPen, “LocalTime”, 0);
END

IPen.Name Get or Set the name of this pen.


[Property][Get/Set] Defined As
„ [VBA] String Name
„ [Cicode] STRING Name
„ [C++] BSTR Name
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the length of the
name is wrong then the return value will be InvalidArgument. If the pen is
deleted then the return value will be GeneralFailure.
Remarks
The Process Analyst will use this name extensively throughout the user interface
to reference this pen.
The name of the pen does not have to be unique, but it must be between 1 and
250 character long.
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim name As String
‘Getting Property value
name = pen.Name
‘Setting property value
pen.Name = “NicePen”
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
STRING name;
// Getting current property value
name = _ObjectGetProperty(hPen, “Name”);
// Setting property value
_ObjectSetProperty(hPen, “Name”, “NicePen”);
END

IPen.RequestMode Get or Set how multiple samples will be calculated on the server.
[Property][Get/Set] Defined As
„ [VBA] Integer RequestMode
„ [Cicode] INT RequestMode
„ [C++] RequestMode RequestMode
176

Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the mode is out of
range, the return value will be InvalidArgument. If the pen is deleted, the return
value will be GeneralFailure.
Remarks
When the pen makes a request for data and samples need to be compacted, it
will use this mode to determine how the compaction will occur.
Changing this mode will clear the data cache and issue a new request for data.
See Also RequestMode [Enumeration]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim requestMode As Integer
‘Getting Property value
requestMode = pen.RequestMode
‘Setting mode to minimum
pen.RequestMode = 1
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT requestMode;
// Getting current property value
requestMode = _ObjectGetProperty(hPen, “RequestMode”);
// Setting mode to minimum
_ObjectSetProperty(hPen, “RequestMode”, 1);
END

IPen.Stacked Get or Set whether the pen is visually displayed stacked or overlaid.
[Property][Get/Set] Defined As
„ [VBA] Boolean Stacked
„ [Cicode] INT Stacked
„ [C++] VARIANT_BOOL Stacked
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Limits
„ True (-1): Stacked
„ False (0): Overlaid
Remarks
177

When stacked, pens will be drawn under each other; when overlaid, the pens
will be drawn over the top of each other.
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim stacked As Boolean
‘Getting Property value
stacked = pen.Stacked
‘Setting Property value
pen.Stacked = True
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT bStacked;
// Getting current property value
bStacked = _ObjectGetProperty(hPen, “Stacked”);
// Setting property value
_ObjectSetProperty(hPen, “Stacked”, -1);
END

IPen.TrendCursorLabel Gets or sets the fill color used for any cursor label associated with this pen.
FillColor [Property][Get/ Defined As
Set]
„ [VBA] Long TrendCursorLabelFillColor
„ [Cicode] INT TrendCursorLabelFillColor
„ [C++] OLE_COLOR TrendCursorLabelFillColor
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted then the return value will be GeneralFailure.
Remarks
To calculate the integer value required for a color apply the following formula
(65536 * Blue) + (256 * Green) + (Red). Where Red, Green and Blue are 0-255.
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim color As Long
‘Getting Property value
color = pen. TrendCursorLabelFillColor
‘Setting Property value to Red
pen. TrendCursorLabelFillColor = 255
End Sub
178

[Cicode]
FUNCTION Example(OBJECT hPen)
INT color;
// Getting current property value
color = _ObjectGetProperty(hPen, “TrendCursorLabelFillColor”);
// Setting Property to Red
_ObjectSetProperty(hPen, “TrendCursorLabelFillColor”, PackedRGB(255, 0, 0));
END

IPen.TrendCursorLabel Gets or sets the border color used for any cursor label associated with this pen.
LineColor Defined As
[Property][Get/Set]
„ [VBA] Long TrendCursorLabelLineColor
„ [Cicode] INT TrendCursorLabelLineColor
„ [C++] OLE_COLOR TrendCursorLabelLineColor
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted then the return value will be GeneralFailure.
Remarks
To calculate the integer value required for a color apply the following formula
(65536 * Blue) + (256 * Green) + (Red). Where Red, Green and Blue are 0-255.
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim color As Long
‘Getting Property value
color = pen. TrendCursorLabelLineColor
‘Setting Property value to Red
pen. TrendCursorLabelLineColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT color;
// Getting current property value
color = _ObjectGetProperty(hPen, “TrendCursorLabelLineColor”);
// Setting Property to Red
_ObjectSetProperty(hPen, “TrendCursorLabelLineColor”, PackedRGB(255, 0, 0));
END

IPen.TrendCursorLabel Gets or sets the text color used for any cursor label associated with this pen.
TextColor Defined As
[Property][Get/Set]
„ [VBA] Long TrendCursorLabelTextColor
„ [Cicode] INT TrendCursorLabelTextColor
179

„ [C++] OLE_COLOR TrendCursorLabelTextColor


Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted then the return value will be GeneralFailure.
Remarks
To calculate the integer value required for a color apply the following formula
(65536 * Blue) + (256 * Green) + (Red). Where Red, Green and Blue are 0-255.
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim color As Long
‘Getting Property value
color = pen. TrendCursorLabelTextColor
‘Setting Property value to Red
pen. TrendCursorLabelTextColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT color;
// Getting current property value
color = _ObjectGetProperty(hPen, “TrendCursorLabelTextColor”);
// Setting Property to Red
_ObjectSetProperty(hPen, “TrendCursorLabelTextColor”, PackedRGB(255, 0, 0));
END

IPen.VerticalAxisAutosc Gets or sets whether the vertical axis will automatically calculate its physical
ale [Property][Get/Set] limits based on the sample values within its internal cache.
Defined As
„ [VBA] Boolean VerticalAxisAutoscale
„ [Cicode] INT VerticalAxisAutoscale
„ [C++] VARIANT_BOOL VerticalAxisAutoscale
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted then the return value will be GeneralFailure.
Remarks
Setting this property will turn off interactive Scrolling
(IPen.HorizontalAxisScroll) and Scaling (IPen.HorizontalAxisResize).
Limits
„ True (-1): Autoscale enabled
180

„ False (0): Autoscale disabled


Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim autoScale As Long
‘Getting Property value
autoScale = pen. VerticalAxisAutoscale
‘Setting Property value
pen. VerticalAxisAutoscale = True
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT autoScale;
// Getting current property value
autoScale = _ObjectGetProperty(hPen, “VerticalAxisAutoscale”);
// Setting Property
_ObjectSetProperty(hPen, “VerticalAxisAutoscale”, -1);
END

IPen.VerticalAxisColor Gets or sets the color used to draw the line, labels and interval markers of the
[Property][Get/Set] vertical axis of this pen.
Defined As
„ [VBA] Long VerticalAxisColor
„ [Cicode] INT VerticalAxisColor
„ [C++] OLE_COLOR VerticalAxisColor
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted then the return value will be GeneralFailure.
Remarks
To calculate the integer value required for a color apply the following formula
(65536 * Blue) + (256 * Green) + (Red). Where Red, Green and Blue are 0-255.
See Also IPen.HorizontalAxisColor [Property][Get/Set]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim color As Long
‘Getting Property value
color = pen.VerticalAxisColor
‘Setting Property value to Red
pen.VerticalAxisColor = 255
End Sub
181

[Cicode]
FUNCTION Example(OBJECT hPen)
INT color;
// Getting current property value
color = _ObjectGetProperty(hPen, “VerticalAxisColor”);
// Setting Property to Red
_ObjectSetProperty(hPen, “VerticalAxisColor”, PackedRGB(255, 0, 0));
END

IPen.VerticalAxisLabelT Gets or sets a unit type which can be applied to the axis labels. This allows
ype [Property][Get/Set] numbers on the axis to display with their unit. For example, setting the unit to
“kg” will display “10 Kg” on the axis.
Defined As
„ [VBA] Integer VerticalAxisLabelType
„ [Cicode] INT VerticalAxisLabelType
„ [C++] AxisLabelType VerticalAxisLabelType
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the pen is
deleted then the return value will be GeneralFailure.
Remarks
Label Types are fixed and cannot be added to.
See Also AxisLabelType [Enumeration]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim labelType As Integer
‘Getting Property value
labelType = pen.VerticalAxisLabelType
‘Setting Property value to Percent
pen.VerticalAxisLabelType= 3
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT labelType;
// Getting current property value
labelType = _ObjectGetProperty(hPen, “VerticalAxisLabelType”);
// Setting Property to Percent
_ObjectSetProperty(hPen, “VerticalAxisLabelType”, 3);
END

IPen.VerticalAxisResize Gets or sets whether this pen allows the operator to interactively scale the
[Property][Get/Set] vertical axis by using the mouse.
Defined As
182

„ [VBA] Boolean VerticalAxisResize


„ [Cicode] INT VerticalAxisResize
„ [C++] VARIANT_BOOL VerticalAxisResize
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Limits
„ True (-1): Enable resize
„ False (0): Disable resize
Remarks
This only applies to analog pens.
See Also IPen.HorizontalAxisResize [Property][Get/Set]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim resize As Boolean
‘Getting Property value
resize = pen. VerticalAxisResize
‘Setting Property value
pen. VerticalAxisResize = False
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT bResize;
// Getting current property value
bResize = _ObjectGetProperty(hPen, “VerticalAxisResize”);
// Setting Property
_ObjectSetProperty(hPen, “VerticalAxisResize”,0);
END

IPen.VerticalAxisScroll Gets or sets whether this pen allows the operator to interactively scroll the
[Property][Get/Set] vertical axis by using the mouse.
Defined As
„ [VBA] Boolean VerticalAxisScroll
„ [Cicode] INT VerticalAxisScroll
„ [C++] VARIANT_BOOL VerticalAxisScroll
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
183

Limits
„ True (-1): Enable scrolling
„ False (0): Disable scrolling
Remarks
This only applies to analog pens.
See Also IPen.HorizontalAxisScroll [Property][Get/Set]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim scroll As Boolean
‘Getting Property value
scroll = pen.VerticalAxisScroll
‘Setting Property value
pen.VerticalAxisScroll = False
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT bScroll;
// Getting current property value
bScroll = _ObjectGetProperty(hPen, “VerticalAxisScroll”);
// Setting Property
_ObjectSetProperty(hPen, “VerticalAxisScroll”, 0);
END

IPen.VerticalAxisWidth Gets or sets the width of the vertical axis line and the associated interval
[Property][Get/Set] markers.
Defined As
„ [VBA] Integer VerticalAxisWidth
„ [Cicode] INT VerticalAxisWidth
„ [C++] short VerticalAxisWidth
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Limits
A valid width is 0-8 pixels.
Remarks
This only applies to analog pens.
See Also IPen.HorizontalAxisWidth [Property][Get/Set]
Calling Syntax
184

Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim width As Integer
‘Getting Property value
width = pen.VerticalAxisWidth
‘Setting Property value
pen.VerticalAxisWidth = 3
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT width;
// Getting current property value
width = _ObjectGetProperty(hPen, “VerticalAxisWidth”);
// Setting Property
_ObjectSetProperty(hPen, “VerticalAxisWidth”, 3);
END

IPen.VerticalGridlinesC Gets or sets the color used to draw the major vertical gridlines.
olor [Property][Get/Set] Defined As
„ [VBA] Long VerticalGridlinesColor
„ [Cicode] INT VerticalGridlinesColor
„ [C++] OLE_COLOR VerticalGridlinesColor
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Remarks
To calculate the integer value required for a color apply the following formula
(65536 * Blue) + (256 * Green) + (Red). Where Red, Green and Blue are 0-255.
See Also IPen.VerticalMinorGridlinesColor [Property][Get/Set]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim color As Long
‘Getting Property value
color = pen.VerticalGridlinesColor
‘Setting Property value to Red
pen. VerticalGridlinesColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT color;
// Getting current property value
185

color = _ObjectGetProperty(hPen, “VerticalGridlinesColor”);


// Setting Property to Red
_ObjectSetProperty(hPen, “VerticalGridlinesColor”, PackedRGB(255, 0, 0));
END

IPen.VerticalGridlinesSt Gets or sets the line style used to draw the major vertical gridlines.
yle [Property][Get/Set] Defined As
„ [VBA] Long VerticalGridlinesColor
„ [Cicode] INT VerticalGridlinesColor
„ [C++] LineStyle VerticalGridlinesColor
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the style is out of
range, the return value will be InvalidArgument. If the pen is deleted, the return
value will be GeneralFailure.
See Also IPen.VerticalMinorGridlinesStyle [Property][Get/Set], LineStyle
[Enumeration]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim style As Long
‘Getting Property value
style = pen.VerticalGridlinesColor
‘Setting Property value to Dot
pen.VerticalGridlinesColor = 2
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT style;
// Getting current property value
style = _ObjectGetProperty(hPen, “VerticalGridlinesStyle”);
// Setting Property to Dot
_ObjectSetProperty(hPen, “VerticalGridlinesStyle”, 2);
END

IPen.VerticalGridlinesW Gets or sets the line width used when drawing the major vertical gridlines.
idth [Property][Get/Set] Defined As
„ [VBA] Integer VerticalGridlinesWidth
„ [Cicode] INT VerticalGridlinesWidth
„ [C++] short VerticalGridlinesWidth
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the width is out of
186

range, the return value will be InvalidArgument. If the pen is deleted, the return
value will be GeneralFailure.
Limits
A valid width is 0-8 pixels.
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim width As Integer
‘Getting Property value
width = pen.VerticalGridlinesWidth
‘Setting Property value
pen.VerticalGridlinesWidth = 3
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT width;
// Getting current property value
width = _ObjectGetProperty(hPen, “VerticalGridlinesWidth”);
// Setting Property t
_ObjectSetProperty(hPen, “VerticalGridlinesWidth”, 3);
END

IPen.VerticalMinorGridli Gets or sets the color used to draw the minor vertical gridlines.
nesColor Defined As
[Property][Get/Set]
„ [VBA] Long VerticalMinorGridlinesColor
„ [Cicode] INT VerticalMinorGridlinesColor
„ [C++] OLE_COLOR VerticalMinorGridlinesColor
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Remarks
To calculate the integer value required for a color apply the following formula
(65536 * Blue) + (256 * Green) + (Red). Where Red, Green and Blue are 0-255.
See Also IPen.VerticalGridlinesColor [Property][Get/Set]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim color As Long
‘Getting Property value
color = pen. VerticalMinorGridlinesColor
187

‘Setting Property value to Red


pen.VerticalMinorGridlinesColor = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT color;
// Getting current property value
color = _ObjectGetProperty(hPen, “VerticalMinorGridlinesColor”);
// Setting Property to Red
_ObjectSetProperty(hPen, “VerticalMinorGridlinesColor”, PackedRGB(255, 0, 0));
END

IPen.VerticalMinorGridli Gets or sets the line style used to draw the minor vertical gridlines.
nesStyle [Property][Get/ Defined As
Set]
„ [VBA] Long VerticalMinorGridlinesStyle
„ [Cicode] INT VerticalMinorGridlinesStyle
„ [C++] LineStyle VerticalMinorGridlinesStyle
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the style is out of
range, the return value will be InvalidArgument. If the pen is deleted, the return
value will be GeneralFailure.
See Also IPen.VerticalGridlinesStyle [Property][Get/Set], LineStyle
[Enumeration]
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim style As Long
‘Getting Property value
style = pen.VerticalMinorGridlinesStyle
‘Setting Property value to Dot
pen.VerticalMinorGridlinesColor = 2
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT style;
// Getting current property value
style = _ObjectGetProperty(hPen, “VerticalMinorGridlinesStyle”);
// Setting Property to Dot
_ObjectSetProperty(hPen, “VerticalMinorGridlinesStyle”, 2);
END

IPen.Visible Get or set whether this pen will be visually shown (True) or hidden (False) to the
[Property][Get/Set] operator.
Defined As
188

„ [VBA] Boolean Visible


„ [Cicode] INT Visible
„ [C++] VARIANT_BOOL Visible
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the pen is deleted,
the return value will be GeneralFailure.
Limits
„ True (-1): Visible
„ False (0): Hidden
Calling Syntax
Assumes you have passed a valid pen object into the function.
[VBA]
Sub Example(pen As Object)
Dim visible As Boolean
‘Get the property value
visible = pen.Visible
‘ Set the property value
pen.Visible = False
End Sub
[Cicode]
FUNCTION Example(OBJECT hPen)
INT bVisible;
// Get the property value
bVisible = _ObjectGetProperty(hPen, “Visible”, 0.5);
// Set the property value
_ObjectSetProperty(hPen, “Visible”, 0);
END

IPens Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IPens
Methods (2)
IPens.Create [Method]
IPens.RemoveAll [Method]
Properties (5)
IPens.Count [Property][Get]
IPens.Item [Property][Get]
IPens._NewEnum [Property][Get]
IPens.ItemByName [Property][Get]
IPens.Pane[Property][Get]
189

IPens.Create [Method] Creates a new pen and adds it to this collection.


Defined As
„ [VBA] Create(penType As Integer, nameMode As Integer) as Object
„ [Cicode] OBJECT Create (INT penType, INT nameMode)
„ [C++] HRESULT Create(PenType penType, PenNameMode penNameMode,
IPen** pen)
Parameters
penType
[in] Indicates the type of pen that will be created. See PenType
Enumeration for the types of pen that can be created.
penNameMode
[in] Indicates how the name will be obtained for this pen. The Process
Analyst provides options of PenNameMode_Comment,
PenNameMode_Tag, and PenNameMode_Custom. Specifying
PenNameMode_Comment will mean that the Process Analyst names the
pen from the Comment field of the trend/alarm tag associated with the
IPen.DataPoint property. Specifying PenNameMode_Tag will mean that the
Process Analyst will name the pen as the value of the IPen.DataPoint
property. Specifying PenNameMode_Custom causes the Process Analyst to
provide a default name and leave setting the name to you via the IPen.Name
property.
Execution Results
If the method succeeds the return value will be Success. If the pens collection is
deleted, the return value will be GeneralFailure.
Remarks
If this method succeeds, a new Pen of the specified type is created and appended
to the pens collection.
See Also IPen Interface, PenType [Enumeration], PenNameMode [Enumeration]
Calling Syntax
This example assumes there is a valid Pens collection object to be passed in to
the example methods.
[VBA]
Sub Example(pens As Object)
Dim pen As Object
Set pen = pens.Create(4097, 1)
End Sub
[Cicode]
FUNCTION Example(OBJECT hPens)
OBJECT hPen = _ObjectCallMethod(hPens, “Create” , 4097, 1);
END
190

IPens.RemoveAll Removes all Pens from the Pens collection.


[Method] Defined As
„ [VBA] RemoveAll()
„ [Cicode] RemoveAll()
„ [C++] HRESULT RemoveAll()
Execution Result
If the property get/set succeeds the return value will be Success. If the pens
collection is deleted the return value will be GeneralFailure.
Calling Syntax
This example assumes there is a valid Pens collection object to be passed into the
example methods.
[VBA]
Sub Panes(pens As Object)
pens.RemoveAll()
End Sub
[Cicode]
FUNCTION Example(OBJECT hPens)
_ObjectCallMethod(hPens, “RemoveAll”);
END

IPens.Count Gets the number of Pens in this collection.


[Property][Get] Defined As
„ [VBA] Long Count
„ [Cicode] INT Count
„ [C++] int Count
Execution Result
If the property get succeeds, the return value will be Success. If the pens
collection is deleted, the return value will be GeneralFailure.
Calling Syntax
This example assumes there is a valid Pens collection object to be passed into the
example methods.
[VBA]
Sub Example(Pens As Object)
Dim count As Long
‘Getting Property value
count = Pens.Count
End Sub
[Cicode]
FUNCTION Example(OBJECT hPens)
// Getting property value
INT nCount = _ObjectGetProperty(hPens, "Count");
END
191

IPens.Item Gets the Pen at the given index from this pen’s collection.
[Property][Get] Defined As
„ [VBA] Item(index As Long) as Object
„ [Cicode] OBJECT Item(INT index)
„ [C++] Item(int index, IPen* Item)
Parameters
index
[in] Indicates the index of the pen item to return from this collection. (One
based)
Execution Result
If the property get succeeds, the return value will be Success. If the index is out
of range, the return value will be InvalidArgument. If the pen’s collection is
deleted, the return value will be GeneralFailure.
Calling Syntax
This example assumes there is a valid Pens collection object to be passed into the
example methods.
[VBA]
Sub Example(pens As Object)
Dim pen As Object
‘Getting Property value
Set pen = pens.Item(1)
End Sub
[Cicode]
FUNCTION Example(OBJECT hPens)
// Getting property value
OBJECT hPen = _ObjectCallMethod(hPens, "get_Item", 1);
END

IPens._NewEnum This allows For.. Each.. Next integration in VB.


[Property][Get] Calling Syntax
This example assumes there is a valid Pens collection object to be passed into the
example methods. This property is not applicable to Cicode.
[VBA]
Sub Example(Pens As Object)
Dim pen As Object
Dim count As Long
‘Using Property
For Each pen In Pens
count = count + 1
Next pen
End Sub

IPens.ItemByName Gets the Pen of the given name from this Pens collection.
[Property][Get] Defined As
192

„ [VBA] ItemByName(name As String) as Object


„ [Cicode] OBJECT ItemByName(STRING name)
„ [C++] ItemByName(STRING name, IPen* Item)
Parameters
name
[in] Indicates the name of the Pen item to return from this collection.

Execution Result
If the property get succeeds, the return value will be Success. If the pen does not
exist, the return value will be InvalidArgument. If the pens collection is deleted,
the return value will be GeneralFailure.
Calling Syntax
This example assumes there is a valid Pens collection object to be passed into the
example methods.
[VBA]
Sub Example(Pens As Object)
Dim pen As Object
‘Getting Property value
Set pen = Pens.ItemByName(“CPU Usage”)
End Sub
[Cicode]
FUNCTION Example(OBJECT hPens)
// Getting property value
OBJECT hPen = _ObjectCallMethod(hPens, "get_ItemByName", "CPU Usage");
END

IPens.Pane[Property][G Gets the Pane that this Pens collection belongs to.
et] Defined As
„ [VBA] Object Pane
„ [Cicode] OBJECT Pane
„ [C++] HRESULT Pane(IPane** Pane)
Execution Result
If the property get succeeds the return value will be Success. If the pens
collection is deleted the return value will be GeneralFailure.
Remarks
Each Pens collection belongs to a Pane.
Calling Syntax
This example assumes there is a valid Pens collection object to be passed into the
example methods.
193

[VBA]
Sub Example(pens As Object)
Dim pane As Object
‘Getting Property value
Set pane = pens.Pane
End Sub
[Cicode]
FUNCTION Example(OBJECT hPens)
// Getting property value
OBJECT hPane = _ObjectGetProperty(hPens, "Pane");
END

IProcessAnalyst Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IProcessAnalyst
Methods
IProcessAnalyst.BlockUpdates [Method]
IProcessAnalyst.UnBlockUpdates [Method]
IProcessAnalyst.CopyToClipboard [Method]
IProcessAnalyst.CopyToFile [Method]
IProcessAnalyst.FreezeEvent [Method]
IProcessAnalyst.LoadFromFile [Method]
IProcessAnalyst.PrintAll [Method]
IProcessAnalyst.SaveToFile [Method]
IProcessAnalyst.ShowProperties [Method]
IProcessAnalyst.SubscribeForPropertyChange [Method]
IProcessAnalyst.SynchroniseToNow [Method]
IProcessAnalyst.UnsubscribePropertyChange [Method]
Properties
IProcessAnalyst.AdminPrivilegeLevel [Property] [Get]
IProcessAnalyst.AutoScroll [Property][Get/Set]
IProcessAnalyst.BackgroundColor [Property][Get/Set]
IProcessAnalyst.CommandSystem [Property][Get]
IProcessAnalyst.ContextMenu [Property][Get/Set]
IProcessAnalyst.Cursors [Property][Get]
IProcessAnalyst.DataRequestRate [Property][Get/Set]
IProcessAnalyst.DisplayRefreshRate [Property][Get/Set]
IProcessAnalyst.Language [Property] [Get/Set]
IProcessAnalyst.LastSelectedPen [Property][Get]
IProcessAnalyst.LockedPens [Property][Get/Set]
IProcessAnalyst.ObjectView [Property][Get]
IProcessAnalyst.NumberofSamples[Property][Get/Set]
IProcessAnalyst.Panes [Property][Get]
IProcessAnalyst.PrimaryPath [Property][Get/Set]
IProcessAnalyst.SecondaryPath [Property][Get/Set]
IProcessAnalyst.Toolbars [Property][Get]
194

IProcessAnalyst.WritePrivilegeLevel [Property][Get]
IProcessAnalyst.ZoomMode [Property][Get/Set]

IProcessAnalyst.BlockU Blocks certain aspects of the Process Analyst’s redrawing and data updating.
pdates [Method] Defined As
„ [VBA] BlockUpdates()
„ [Cicode] BlockUpdates()
„ [C++] HRESULT BlockUpdates()
Remarks
„ This method blocks three redraw systems: redraw for the chart, the Object
View, and the toolbars.
„ Data updates are also blocked.
„ The current data requests are all cancelled.
„ The Process Analyst has a built-in counter to store how many times the
block and unblock have been called, so that only the final UnBlockUpdates
call actually unblocks the above mentioned data updates and redraw
systems.
See Also IProcessAnalyst.UnBlockUpdates [Method]
Execution Result
If the function suceeds, the return value will be Success. If the function fails, the
return value will be general failure.
Calling Syntax
This example assumes there is a valid Process Analyst object to be passed into
the example methods.
[VBA]
Sub Example(ProcessAnalyst As Object)
ProcessAnalyst.BlockUpdates()
End Sub
[Cicode]
FUNCTION Example(OBJECT hProcessAnalyst)
_ObjectCallMethod(hProcessAnalyst, “BlockUpdates”);
END

IProcessAnalyst.UnBlo Unblocks certain aspects of the Process Analyst’s redrawing and data updating.
ckUpdates [Method] Defined As
„ [VBA] UnblockUpdates()
„ [Cicode] UnblockUpdates()
„ [C++] HRESULT UnblockUpdates()
Remarks
„ This method unblocks three redraw systems: redraw for the chart, the Object
View, and the toolbars.
195

„ Data updates are also unblocked.


„ The Process Analyst has a built-in counter to store how many times the
block and unblock have been called, so that only the final UnBlockUpdates
call actually unblocks the above mentioned data updates and redraw
systems.
See Also IProcessAnalyst.BlockUpdates [Method]
Execution Result
If the function suceeds, the return value will be Success. If the function fails, the
return value will be general failure. If other BlockUpdates are in effect, a Success
will be returned also (for those C++ users, S_FALSE will be returned in this case).
Calling Syntax
This example assumes there is a valid Process Analyst object to be passed into
the example methods.
[VBA]
Sub Example(ProcessAnalyst As Object)
ProcessAnalyst.UnblockUpdates()
End Sub
[Cicode]
FUNCTION Example(OBJECT hProcessAnalyst)
_ObjectCallMethod(hProcessAnalyst, “UnblockUpdates”);
END

IProcessAnalyst.CopyT Copies the data in the current viewable range for all visible pens to the
oClipboard [Method] clipboard.
Defined As
„ [VBA] CopyToClipboard()
„ [Cicode] CopyToClipboard()
„ [C++] HRESULT CopyToClipboard()
Remarks
The timestamp of each sample will be in local time defined by your computer.
The start and end sample maybe generated for each pen to indicate the exported
range of the data.
Execution Result
If the function succeeds the return value will be Success. If the function fails the
return value will be GeneralFailure.
See Also IProcessAnalyst.CopyToFile [Method]
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
196

[VBA]
Sub Example()
myPage_AN35.CopyToClipboard
End Sub
[Cicode]
Sub Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
_ObjectCallMethod(hProcessAnalyst, “CopyToClipboard”);
End Sub

IProcessAnalyst.CopyT Saves the data in the current viewable range for all visible pens to the specified
oFile [Method] file.
Defined As
„ [VBA] CopyToFile(filename As String)
„ [Cicode] CopyToFile(STRING filename)
„ [C++] HRESULT CopyToClipBoard(BSTR filename)
Parameters
filename
[in] Indicates the name and path of the file that the data will be exported to.

Execution Result
If the function succeeds the return value will be Success. If the function fails the
return value will be GeneralFailure.
Remarks
The timestamp of each sample will be in local time defined by your computer.
The start and end sample maybe generated for each pen to indicate the exported
range of the data.
See Also IProcessAnalyst.CopyToClipboard [Method]
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
myPage_AN35.CopyToFile “test.xls”
End Sub
[Cicode]
Sub Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
_ObjectCallMethod(hProcessAnalyst, “CopyToFile”, “test.xls”);
End Sub

IProcessAnalyst.Freeze Enables or disables a specified event from triggering.


Event [Method] Defined As
197

„ [VBA] FreezeEvent(eventName As String, freeze As Boolean)


„ [Cicode] FreezeEvent(STRING eventName, INT freeze)
„ [C++] HRESULT FreezeEvent(BSTR columnName, VARIANT_BOOL freeze)
Parameters
eventName
[in] Specifies the event that you want to cease receiving notifications for.
freeze
[in] Indicates whether to enable or disable the event. True(-1) enable the
event. False(0) disable the event.
Execution Result
If the method succeeds, the return value will be Success. If the method fails, the
return value will be GeneralFailure. If eventName is bad or does not exist, the
return value will be InvalidArgument.
Remarks
All events exposed by the Process Analyst can be enabled or disabled. This
method is particularly useful to prevent recursive behavior of functions that
generate the same event that you are trying to handle.
Calling Syntax
This example assumes there is a valid Process Analyst object to be passed into
the example methods.
[VBA]
Sub Example(analyst As Object)
analyst.FreezeEvent "HorizontalAxisChanged" True
End Sub
[Cicode]
FUNCTION Example(OBJECT hAnalyst)
_ObjectCallMethod(hAnalyst, "FreezeEvent","HorizontalAxisChanged", -1);
END

IProcessAnalyst.LoadFr Loads a specified view into the Process Analyst.


omFile [Method] Defined As
„ [VBA] LoadFromFile(filename As String, fileLocation As Integer)
„ [Cicode] LoadFromFile(STRING filename, INT fileLocation)
„ [C++] HRESULT LoadFromFile(BSTR filename, FileLocation fileLocation)
Parameters
filename
[in] Indicates a relative path and filename of the view to load into the
Process Analyst. See Remarks, below.
fileLocation
[in] Indicates which known location to load the file from.
198

Execution Result
If the function succeeds the return value will be Success. If the filename is
invalid the return value will be InvalidArgument. If the path indicated by
fileLocation is invalid or offline then the return value will be PathNotFound. If
any other problem occurs then the return value will be GeneralFailure.
Remarks
This method will replace the current view with the one in the specified file.
Absolute paths are not required for the filename as the method has been
designed to load the specified file from your project
directory(FileLocation_Local), my documents folder (FileLocation_User) or
from the primary/secondary paths (FileLocation_Server).
When a file is loaded it will be synchronized with the other locations to ensure
each location has the file which is the latest. If the file you are loading is older
then one which exists in another location it will be replaced. Synchronization
will not occur when loaded from a Web-client.
See Also FileLocation [Enumeration], IProcessAnalyst.PrimaryPath
[Property][Get/Set], IProcessAnalyst.SecondaryPath [Property][Get/
Set]
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
‘ Load the view from the server
myPage_AN35.LoadFromFile “Analyst Views\Test1.pav”, 1
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
_ObjectCallMethod(hProcessAnalyst, “LoadFromFile”,“AnalystViews\Test1.pav”, 1);
END

IProcessAnalyst.PrintAl Displays the Print configuration dialog.


l [Method] Defined As
„ [VBA] PrintAll
„ [Cicode] PrintAll()
„ [C++] HRESULT PrintAll()
Execution Result
If the function succeeds the return value will be Success. If an unexpected error
occurs then return value will be GeneralFailure.
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
199

[VBA]
Sub Example()
myPage_AN35.PrintAll
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
_ObjectCallMethod(hProcessAnalyst, “PrintAll”);
END

IProcessAnalyst.SaveT Saves the current view using the specified name to the specified location.
oFile [Method] Defined As
„ [VBA] SaveToFile(filename As String, fileLocation As Integer)
„ [Cicode] SaveToFile(STRING filename, INT fileLocation)
„ [C++] HRESULT SaveToFile(BSTR filename, FileLocation fileLocation)
Parameters
filename
[in] Indicates a relative path and filename which will be used during the
saving of the view. See Remarks.
fileLocation
[in] Indicates which known location to save the file to.

Execution Result
If the function succeeds the return value will be Success. If the filename is
invalid the return value will be InvalidArgument. If the path indicated by
fileLocation is invalid or offline then the return value will be PathNotFound. If
any other problem occurs, the return value will be GeneralFailure.
Remarks
On a client where the current user matches the WritePrivilegeLevel only the
FileLocation_Server and FileLocation_User options will succeed. Saving using
the FileLocation_Server option will save to the locations indicated by
PrimaryPath and SecondaryPath properties and into the Project directory.
On a client where the current user does not match the WritePrivilegeLevel only
the FileLocation_User will succeed.
On a webclient the FileLocation_User is the only option which will succeed.
See Also FileLocation [Enumeration], IProcessAnalyst.PrimaryPath
[Property][Get/Set], IProcessAnalyst.SecondaryPath
[Property][Get/Set], IProcessAnalyst.WritePrivilegeLevel
[Property][Get]
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
200

[VBA]
Sub Example()
‘ Save the view to the server and project
myPage_AN35.SaveToFile “Analyst Views\Test1.pav”, 1
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
‘ Save the view to the server and project
_ObjectCallMethod(hProcessAnalyst, “SaveToFile”, “Analyst
Views\Test1.pav”, 1);
END

IProcessAnalyst.ShowP Displays the Process Analyst’s property configuration dialog.


roperties [Method] Define As
„ [VBA] ShowProperties
„ [Cicode] ShowProperties()
„ [C++] HRESULT ShowProperties ()
Execution Result
If the function succeeds the return value will be Success. If an unexpected error
occurs then the return value will be GeneralFailure.
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
myPage_AN35.ShowProperties
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
_ObjectCallMethod(hProcessAnalyst, “ShowProperties”);
END

IProcessAnalyst.Subscr Use this method to receive notifications of when a particular property changes.
ibeForPropertyChange Notifications will be sent via the PropertyChanged event.
[Method] Defined As
„ [VBA] SubscribeForPropertyChange(interfaceName As String,
propertyName As String)
„ [Cicode] SubscribeForPropertyChange(STRING interfaceName, STRING
propertyName)
„ [C++] HRESULT SubscribeForPropertyChange(BSTR interfaceName, BSTR
propertyName)
Parameters
201

interfaceName
[in] Specify the name of the interface that the property you want
notifications for is defined on.
propertyName
[in] This is the name of the property you want to receive notifications for.

Execution Result
If the function succeeds, the return value will be Success. If the interfaceName or
propertyName is a bad string, the return value will be InvalidArgument. If any
other problem occurs, the return value will be GeneralFailure.
Remarks
The following set of properties are supported:
Interface name Property Name
IProcessAnalyst AutoScroll
IProcessAnalyst BackgroundColor
IProcessAnalyst ContextMenu
IProcessAnalyst LockedPens
IProcessAnalyst DisplayRefreshRate
IProcessAnalyst DataRequestRate
IProcessAnalyst ZoomMode
See Also IProcessAnalyst.UnsubscribePropertyChange [Method],
PropertyChanged [Event]
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
myPage_AN35.SubscribeForPropertyChange “IProcessAnalyst”, “ZoomMode”
End Sub
[Cicode]
Sub Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
_ObjectCallMethod(hProcessAnalyst,“SubscribeForPropertyChange”, “IProcessAnalyst”,
“ZoomMode”);
End Sub

IProcessAnalyst.Synchr Synchronizes all pens such that the date/time reflects “Now.”
oniseToNow [Method] Defined As
„ [VBA] SynchroniseToNow
„ [Cicode] SynchroniseToNow()
„ [C++] HRESULT SynchroniseToNow()
Execution Result
202

If the function succeeds, the return value will be Success. If any other problem
occurs, the return value will be GeneralFailure.
Remarks
The current span for each pen will be maintained. ‘Now’ is defined as the
current time on the client machine.
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
myPage_AN35.SynchroniseToNow
End Sub
[Cicode]
Sub Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
_ObjectCallMethod(hProcessAnalyst, “SynchroniseToNow”);
End Sub

IProcessAnalyst.Unsub Use this method to cancel notifications of when the specified property changes.
scribePropertyChange Notifications will cease to be sent via the PropertyChanged event.
[Method] Defined As
„ [VBA] UnsubscribePropertyChange(interfaceName As String,
propertyName As String)
„ [Cicode] UnsubscribePropertyChange(STRING interfaceName, STRING
propertyName)
„ [C++] HRESULT UnsubscribePropertyChange(BSTR interfaceName, BSTR
propertyName)
Parameters
interfaceName
[in] Name of the interface that the property you want to remove
notifications for is defined on.
propertyName
[in] Name of the property you want to remove notifications for.

Execution Result
If the function succeeds, the return value will be Success. If the interfaceName or
propertyName is a bad string, the return value will be InvalidArgument. If any
other problem occurs, the return value will be GeneralFailure.
See Also IProcessAnalyst.SubscribeForPropertyChange [Method],
PropertyChanged [Event]
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
203

[VBA]
Sub Example()
myPage_AN35.UnsubscribePropertyChange “IProcessAnalyst”,“ZoomMode”
End Sub
[Cicode]
Sub Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
_ObjectCallMethod(hProcessAnalyst, “UnsubscribePropertyChange”,“IProcessAnalyst”,
“ZoomMode”);
End Sub

IProcessAnalyst.Admin Retrieves the privilege level currently set for controlling administration features
PrivilegeLevel of the Process Analyst at Run-time.
[Property] [Get] Defined As
„ [VBA] Integer AdminPrivilegeLevel
„ [Cicode] INT AdminPrivilegeLevel
„ [C++] short AdminPrivilegeLevel
Execution Result
If the property get succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument.
Remarks
By default the level is 0 (Zero), which allows access to all features at run time.
Setting this to any other level will require the operator viewing the Process
Analyst to have a privilege equal to that level.
This property can only be set at design time (in the Graphics Builder property
pages) and is recommended to prevent Operators from changing performance
properties such as DataRequestRate and DisplayRefreshRate.
Limits
Privilege level defined in Vijeo Citect 1 - 8. 0 = no security.
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim privilege As Boolean
‘Getting Property value
privilege = myPage_AN35.AdminPrivilegeLevel
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
INT privilege;
// Getting current property value
204

privilege = _ObjectGetProperty(hProcessAnalyst,
“AdminPrivilegeLevel”);
END

IProcessAnalyst.AutoS Gets or Sets the automatic scrolling of all pens as time passes.
croll [Property][Get/Set] Defined As
„ [VBA] Boolean AutoScroll
„ [Cicode] INT AutoScroll
„ [C++] VARIANT_BOOL AutoScroll
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Remarks
This function does not synchronize the pens to now. The display will be updated
according to the value of the DisplayRefreshRate property.
Limits
„ True (-1): Autoscroll is On
„ False (0): Autoscroll is Off
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim autoScroll As Boolean
‘Getting Property value
autoScroll = myPage_AN35.AutoScroll
‘Setting Property value
myPage_AN35.AutoScroll = True
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
INT autoScroll;
// Getting current property value
autoScroll = _ObjectGetProperty(hProcessAnalyst, “AutoScroll”);
// Setting Property to true
_ObjectSetProperty(hProcessAnalyst, “AutoScroll”, -1);
END

IProcessAnalyst.Backgr Gets or sets the background color for the Process Analyst.
oundColor Defined As
[Property][Get/Set]
„ [VBA] Long BackgroundColor
„ [Cicode] INT BackgroundColor
205

„ [C++] OLECOLOR BackgroundColor


Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Remarks
The background is the area under the panes. To calculate the integer value
required for a color, apply the following formula:
(65536 * Blue) + (256 * Green) + (Red)
where Red, Green, and Blue are 0-255.
Limits
„ True (-1): Context menu is enabled
„ False (0): Context menu is disabled
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim backgroundColor As Long
‘Getting Property value
backgroundColor = myPage_AN35.BackgroundColor
‘Setting Property value to Red
myPage_AN35.BackgroundColor = 255
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
INT backgroundColor;
// Getting current property value
backgroundColor = _ObjectGetProperty(hProcessAnalyst,“BackgroundColor”);
// Setting Property to Red
_ObjectSetProperty(hProcessAnalyst, “BackgroundColor”, 255);
END

IProcessAnalyst.Comm Gets a reference to the Process Analyst’s Command System object. With this
andSystem object you can execute commands, query command information, and create
your own custom commands.
[Property][Get]
Defined As
„ [VBA] Object CommandSystem
„ [Cicode] OBJECT CommandSystem
„ [C++] ICommandSystem* CommandSystem
Execution Result
If the property get succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument.
206

Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim commandSystem As Object
‘Retrieve command system
Set commandSystem = myPage_AN35.CommandSystem
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
OBJECT hCommandSystem;
// Retrieve command system
hCommandSystem = _ObjectGetProperty(hProcessAnalyst, “CommandSystem”);
END

IProcessAnalyst.Contex Enables or disables the context menu which is displayed at Run-time when an
tMenu [Property][Get/ operator clicks the right mouse button on the graphical display.
Set] Defines As
„ [VBA] Boolean ContextMenu
„ [Cicode] INT ContextMenu
„ [C++] VARIANT_BOOL ContextMenu
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument.
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim contextMenu As Boolean
‘Getting Property value
contextMenu = myPage_AN35.ContextMenu
‘Disable the context menu
myPage_AN35.ContextMenu = False
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
INT contextMenu;
// Getting current property value
contextMenu =_ObjectGetProperty(hProcessAnalyst,“ContextMenu”);
// Disable the context menu
_ObjectSetProperty(hProcessAnalyst, “ContextMenu”, 0);
END
207

IProcessAnalyst.Cursor Gets a reference to the Process Analyst’s cursors collection. With this object you
s [Property][Get] can create new, and browse existing cursors.
Defined As
„ [VBA] Object Cursors
„ [Cicode] OBJECT Cursors
„ [C++] ICursors* Cursors
Execution Result
If the property get succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument.
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim cursors As Object
‘Retrieve cursors collection
Set cursors = myPage_AN35.Cursors
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
OBJECT hCursors;
// Retrieve cursor collection
hCursors = _ObjectGetProperty(hProcessAnalyst, “Cursors”);
END

IProcessAnalyst.DataRe Indicates how often (in milliseconds) the Process Analyst Control will request
questRate data from the trend server(s). Internally the Process Analyst will choose the most
optimum request rate for data, but this property can be used to slow the request
[Property][Get/Set]
down further.
Defined As
„ [VBA] Integer DataRequestRate
„ [Cicode] INT DataReqestRate
„ [C++] short DataRequestRate
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument.
Remarks
This property is useful for controlling the load on a trend server. The higher the
figure the less load will be put on the trend server(s).
Limits
„ Minimum = 10 milliseconds
208

„ Maximum = 60000 milliseconds (1 minute)


„ Default = 1000 milliseconds (1 second)
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim requestRate As Integer
‘Retrieve request rate
requestRate = myPage_AN35.DataRequestRate
‘Set request rate
myPage_AN35.DataRequestRate = 2000
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
INT requestRate;
// Retrieve property value
requestRate = _ObjectGetProperty(hProcessAnalyst, “DataRequestRate”);
// Set property value to 2 seconds
_ObjectSetProperty(hProcessAnalyst, “DataRequestRate”, 2000);
END

IProcessAnalyst.Displa Indicates how fast the Process Analyst Control display is updated in
yRefreshRate milliseconds. The default is an update of 1 second, which provides optimum
client performance and visual feedback.
[Property][Get/Set]
Defined As
„ [VBA] Integer DisplayRefreshRate
„ [Cicode] INT DisplayRefreshRate
„ [C++] short DisplayRefreshRate
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Remarks
This property is useful for controlling the performance of a client (CPU usage).
Limits
„ Minimum = 10 milliseconds (most machines will not be fast enough to keep
up).
„ Maximum = 60000 milliseconds (1 minute).
„ Default = 1000 milliseconds (1 second).
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
209

[VBA]
Sub Example()
Dim requestRate As Integer
‘Retrieve request rate
requestRate = myPage_AN35.DisplayRefreshRate
‘Set request rate
myPage_AN35.DisplayRefreshRate = 2000
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
INT requestRate;
// Retrieve request rate
requestRate = _ObjectGetProperty(hProcessAnalyst, “DisplayRefreshRate”);
// Set request rate
_ObjectSetProperty(hProcessAnalyst, “DisplayRefreshRate”, 2000);
END

IProcessAnalyst.Langu This function allows dynamic changing of the user interface to the language
age [Property] [Get/Set] specified.
Defined As
„ [VBA] String Language
„ [Cicode] STRING Language
„ [C++] BSTR Language
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Remarks
To change languages you must have additional localized resource .dll files
alongside the main resources.dll file. Additional language .dll files are named
(and should be named) using the format “Resources_<languagecode>.dll”. The
Process Analyst expects this format or the language will not be loaded.
For example, if you have a Chinese resource dll named “Resources_zh-CN.dll”,
set the Language property to “zh-CN”. The .dll files are named according to the
RFC 1766 standard for specifying culture names.
Specifying “.” resets the language back to the default.
Note: This method is not required to be called if you are using Vijeo Citect’s
multilanguage feature to make the Process Analyst switch languages. For
details, see Multi-language Support.
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
210

[VBA]
Sub Example()
Dim language As String
‘Retrieve current language
language = myPage_AN35.Language
‘Set language to Japanese
myPage_AN35.Language = “ja-JP”
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
STRING language;
// Retrieve current language
language = _ObjectGetProperty(hProcessAnalyst, “Language”);
// Set language to Japanese
_ObjectSetProperty(hProcessAnalyst, “Language”, “ja-JP”);
END

IProcessAnalyst.LastSe Retrieves the last selected pen on the Process Analyst.


lectedPen Defined As
[Property][Get]
„ [VBA] Object LastSelectedPen
„ [Cicode] OBJECT LastSelectedPen
„ [C++] IPen* LastSelectedPen
Execution Result
If the property get succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument.
Remarks
The last selected pen is also referred to as the “primary” selection. If there are no
pens in the view, an invalid object will be returned.
Limits
„ A reference to the primary selected pen.
„ Invalid object when there are no pens on the display.
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim selectedPen As Object
‘Retrieve primary selection
Set selectedPen = myPage_AN35.LastSelectedPen
End Sub
211

[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
OBJECT selectedPen;
// Retrieve primary selection
selectedPen = _ObjectGetProperty(hProcessAnalyst, “LastSelectedPen”);
END

IProcessAnalyst.Locke Determines whether all the pens across all panes in the Process Analyst control
dPens [Property][Get/ are locked together.
Set] Defined As
„ [VBA] Boolean LockedPens
„ [Cicode] INT LockedPens
„ [C++] VARIANT_BOOL LockedPens
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument.
Remarks
While this property is enabled, any operation applied to the selected pen is
applied to all pens. When the property is disabled, the pens will lose the lock
logic, and any interaction technique will apply to the individual pen with
selection focus.
If this property is disabled and then enabled, all pens assume the same scale,
timespan, and end time position as the selected pen.
Limits
„ True (-1): Pens are locked.
„ False (0): Pens are unlocked.
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim locked As Boolean
‘Get current locked status
locked = myPage_AN35.LockedPens
‘Turn off locked Pens
myPage_AN35.LockedPens = False
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
OBJECT lockedPens;
// Get current locked status
lockedPens = _ObjectGetProperty(hProcessAnalyst, “LockedPens”);
212

// Turn off locked Pens


_ObjectSetProperty(hProcessAnalyst, “LockedPens”, 0);
END

IProcessAnalyst.Object Gets a reference to the ObjectView object. With this object you can manipulate
View [Property][Get] the look of the ObjectView.
Defined As
„ [VBA] Object ObjectView
„ [Cicode] OBJECT ObjectView
„ [C++] IObjectView* ObjectView
Execution Result
If the property get succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument.
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim objectView As Object
‘Retrieve the objectview
Set objectView = myPage_AN35.ObjectView
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
OBJECT objectView;
// Retrieve the objectview
objectView = _ObjectGetProperty(hProcessAnalyst, “ObjectView”);
END

IProcessAnalyst.Numbe Specifies the date/time axis span of each pen in number of samples. More or less
rofSamples[Property][G detail for each pen can be displayed by increasing or decreasing the value of this
property respectively.
et/Set]
Note: The value entered into the Number of Samples box in the Process Analyst
Properties dialog box is closely tied to the display resolution. The default setting
is ideal for screen resolutions from 1024x768 to 1280x1024. The association
between Number of Samples and the display resolution occurs because for each
sample shown on screen the Process Analyst attempts to leave a small gap to
allow for sample markers. Because the Process Analyst shows samples when
they occur, it requires less data than a traditional trend client. Retrieving data is
expensive and the more data you retrieve the more time the request takes. It is
recommended that this parameter not exceed 500.
Defined As
„ [VBA] Integer NumberofSamples
„ [Cicode] INT NumberofSamples
213

„ [C++] short NumberofSamples


Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Remarks
This property is useful for controlling the performance of a client. (CPU usage).
By dividing a pen’s time span by the value of this property, you can calculate the
current display period of the pen. The Process Analyst will only display a
maximum of one sample per display period. See Data Compaction for details.
Limits
„ Minimum = 10
„ Maximum = 5000
„ Default = 300
See Also Exporting Pen Data
Calling Syntax
Assumes you have a page called "myPage" and the Process Analyst has been
named "AN35".
[VBA]
Sub Example()
Dim numOfSamples As Integer
`Retrieve number of samples
numOfSamples = myPage_AN35.NumberOfSamples
`Set request rate
myPage_AN35.NumberOfSamples = numOfSamples
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName("AN35");
INT numOfSamples;
// Retrieve number of samples
numOfSamples = _ObjectGetProperty(hProcessAnalyst, "NumberOfSamples");
// Set request rate
_ObjectSetProperty(hProcessAnalyst, "NumberOfSamples", 500);
END

IProcessAnalyst.Panes Gets a reference to the Panes collection. With this object you can create new, and
[Property][Get] browse existing panes.
Defined As
„ [VBA] Object Panes
„ [Cicode] OBJECT Panes
„ [C++] IPanes* Panes
Execution Result
214

If the property get succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument.
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim panes As Object
‘Retrieve the panes collection
Set panes = myPage_AN35.Panes
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
OBJECT panes;
// Retrieve the panes collection
panes = _ObjectGetProperty(hProcessAnalyst, “Panes”);
END

IProcessAnalyst.Primar Specifies the primary location for saving and loading Process Analyst views.
yPath [Property][Get/ Defined As
Set]
„ [VBA] String PrimaryPath
„ [Cicode] STRING PrimaryPath
„ [C++] BSTR PrimaryPath
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Remarks
The primary and secondary path properties together provide a file redundancy
option for large systems that need to store Process Analyst Views in a shared
location. Whenever a load operation occurs from either of these locations, the
loaded file will be synchronized with each location, such that the latest version
of the file appears in both locations.
See Also IProcessAnalyst.SecondaryPath [Property][Get/Set],
IProcessAnalyst.LoadFromFile [Method], IProcessAnalyst.SaveToFile
[Method]
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim path As String
‘Retrieve the path
path = myPage_AN35.PrimaryPath
215

‘Set the path


myPage_AN35.PrimaryPath = “\\computer1\PA Views”
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
STRING path;
// Retrieve the path
path = _ObjectGetProperty(hProcessAnalyst, “PrimaryPath”);
// Set the path
_ObjectSetProperty(hProcessAnalyst, “PrimaryPath”, “\\computer1\PA Views”);
END

IProcessAnalyst.Secon Specifies the secondary location for saving and loading Process Analyst views.
daryPath Defined As
[Property][Get/Set]
„ [VBA] String SecondaryPath
„ [Cicode] STRING SecondaryPath
„ [C++] BSTR SecondaryPath
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Remarks
The secondary and primary path properties together provide a file redundancy
option for large systems that need to store Process Analyst Views in a shared
location. Whenever a load operation occurs from either of these locations, the
loaded file will be synchronized with each location, such that the latest version
of the file appears in both locations.
See Also IProcessAnalyst.LoadFromFile [Method],
IProcessAnalyst.PrimaryPath [Property][Get/Set],
IProcessAnalyst.SaveToFile [Method]
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim path As String
‘Retrieve the path
path = myPage_AN35.PrimaryPath
‘Set the path
myPage_AN35.SecondaryPath = “\\computer1\PA Views”
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
STRING path;
// Retrieve the path
216

path = _ObjectGetProperty(hProcessAnalyst, “SecondaryPath”);


// Set the path
_ObjectSetProperty(hProcessAnalyst, “SecondaryPath”, “\\computer1\PA Views”);
END

IProcessAnalyst.Toolba Gets a reference to the Toolbars collection. With this object you can browse and
rs [Property][Get] modify existing toolbars.
Defined As
„ [VBA] Object Toolbars
„ [Cicode] OBJECT Toolbars
„ [C++] IToolbars* Toolbars
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim toolbars As Object
‘Retrieve the toolbars collection
Set toolbars = myPage_AN35.Toolbars
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
OBJECT toolbars;
// Retrieve the toolbars collection
toolbars = _ObjectGetProperty(hProcessAnalyst, “Toolbars”);
END

IProcessAnalyst.WriteP Returns the privilege level required to save Process Analyst views to the
rivilegeLevel Primary and Secondary paths.
[Property][Get] Defined As
„ [VBA] Integer WritePrivilegeLevel
„ [Cicode] INT WritePrivilegeLevel
„ [C++] short WritePrivilegeLevel
Execution Result
If the property get succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument.
Remarks
The privilege cannot be set via automation. It must be set in the property pages
at design time (for example, in Graphics Builder).
217

See Also IProcessAnalyst.SaveToFile [Method], IProcessAnalyst.PrimaryPath


[Property][Get/Set], IProcessAnalyst.SecondaryPath
[Property][Get/Set]
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim privilege As Integer
‘Retrieve the privilege
privilege = myPage_AN35.WritePrivilegeLevel
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
INTEGER privilege;
// Retrieve the privilege
privilege = _ObjectGetProperty(hProcessAnalyst, “WritePrivilegeLevel”);
END

IProcessAnalyst.Zoom Enables or disables the box zooming mode for the Process Analyst.
Mode [Property][Get/ Defined As
Set]
„ [VBA] Boolean ZoomMode
„ [Cicode] INT ZoomMode
„ [C++] VARIANT_BOOL ZoomMode
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Remarks
Setting this mode will ensure only box zooming operations can occur; all other
operations such as interactive scrolling and scaling will cease.
Limits
„ True (-1): Enable zoom mode.
„ False (0): Disable zoom mode.
Calling Syntax
Assumes you have a page called “myPage” and the Process Analyst has been
named “AN35”.
[VBA]
Sub Example()
Dim zoomMode As Boolean
‘Retrieve the mode
zoomMode = myPage_AN35.ZoomMode
218

‘Set the path


myPage_AN35.ZoomMode = True
End Sub
[Cicode]
FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName(“AN35”);
INT zoomMode;
// Retrieve the zoomMode
zoomMode = _ObjectGetProperty(hProcessAnalyst, “ZoomMode”);
// Set the zoomMode
_ObjectSetProperty(hProcessAnalyst, “ZoomMode”, -1);
END

MouseDoubleClick This event is raised whenever a mouse double-click occurs on the graphical
[Event] chart area of the Process Analyst.
Defined As
„ [VBA] MouseDoubleClick(pen As Object, button As Integer)
„ [Cicode] MouseDoubleClick(OBJECT processAnalyst, OBJECT pen, INT
button)
„ [C++] MouseDoubleClick(IPen pen, int button)
Parameters
pen
[in] Indicates which pen the double-click occurred on. This object will be
invalid if no pen was double-clicked.
button
[in] Indicates which button was double-clicked: 0 = Left, 1 = Right.
processAnalyst
[in] Indicates the Process Analyst object that raised the event (Cicode only).

Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_MouseDoubleClick(pen As Object, button As Integer)
End Sub
[Cicode]
FUNCTION myPage_AN35_MouseDoubleClick(OBJECT processAnalyst, OBJECT pen, INT button)
END

MouseClick [Event] This event is raised whenever a single mouse click occurs on the graphical chart
area of the Process Analyst.
Defined As
„ [VBA] MouseClick(pen As Object, button As Integer)
„ [Cicode] MouseClick(OBJECT processAnalyst, OBJECT pen, INT button)
219

„ [C++] MouseClick(IPen* pen, int button)


Parameters
pen
[in] Indicates which pen the click occurred on. This object will be invalid if
no pen was clicked.
button
[in] Indicates which button was clicked: 0 = Left, 1 = Right.
processAnalyst
[in] Indicates the Process Analyst object that raised the event (Cicode only).

Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_MouseClick(pen As Object, button As Integer)
End Sub
[Cicode]
FUNCTION myPage_AN35_MouseClick(OBJECT processAnalyst, OBJECT pen, INT button)
END

PenCreated [Event] This event is raised whenever a pen is either created via the automation model,
or added through the Add Pen dialog at run time.
Defined As
„ [VBA] PenCreated(pen As Object)
„ [Cicode] PenCreated(OBJECT processAnalyst, OBJECT pen)
„ [C++] PenCreated(IPen* pen)
Parameters
pen
[in] Refers to the pen that was created.
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only).
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_PenCreated(pen As Object)
End Sub
[Cicode]
FUNCTION myPage_AN35_PenCreated(OBJECT processAnalyst, OBJECT pen)
END
220

PenDeleted [Event] This event is raised whenever a pen is deleted either by automation or via the
interface.
Defined As
„ [VBA] PenDeleted(penName As String)
„ [Cicode] PenDeleted(OBJECT processAnalyst, STRING penName)
„ [C++] PenDeleted(BSTR penName)
Parameters
penName
[in] Contains the name of the pen that was deleted.
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only)
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35
[VBA]
Sub myPage_AN35_PenDeleted(penName As String)
End Sub
[Cicode]
FUNCTION myPage_AN35_PenDeleted(OBJECT processAnalyst, STRING penName)
END

PenRenamed [Event] This event is raised whenever a pen is renamed via automation or through the
user interface.
Defined As
„ [VBA] PenRenamed(pen As Object)
„ [Cicode] PenRenamed(OBJECT processAnalyst, OBJECT pen)
„ [C++] PenRenamed(IPen* pen)
Parameters
pen
[in] Refers to the pen that was renamed.
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only).
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
221

[VBA]
Sub myPage_AN35_PenRenamed(pen As Object)
End Sub
[Cicode]
FUNCTION myPage_AN35_PenRenamed(OBJECT processAnalyst, OBJECT pen)
END

PenSelectionChanged This event is raised whenever the selection changes in the Process Analyst.
[Event] Defined As
„ [VBA] PenSelectionChanged (pen As Object)
„ [Cicode] PenSelectionChanged (OBJECT processAnalyst, OBJECT pen)
„ [C++] PenSelectionChanged (IPen* pen)
Parameters
pen
[in] Refers to the pen that now has primary selection. This maybe invalid if
the last pen was deleted from the view.
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only)
Remarks
Selection can change via user interaction (such as clicking on pens, deleting/
adding pens) and automation.
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_PenSelectionChanged(pen As Object)
End Sub
[Cicode]
FUNCTION myPage_AN35_PenSelectionChanged(OBJECT processAnalyst, OBJECT pen)
END

HorizontalAxisChanged This event is raised when the date/time axis position or scale of a pen is changed.
[Event] Defined As
„ [VBA] HorizontalAxisChanged(pen As Object)
„ [Cicode] HorizontalAxisChanged(OBJECT processAnalyst, OBJECT pen)
„ [C++] HorizontalAxisChanged(IPen* pen)
Parameters
pen
222

[in] Refers to the pen that has changed. This will be invalid if pens are
locked.
processAnalyst
[in] Indicates the Process Analyst object that raised the event (Cicode only).

Remarks
When the LockedPens property is True, this event is fired only once with the
pen parameter marked as invalid.
See Also IProcessAnalyst.LockedPens [Property][Get/Set],
VerticalAxisChanged [Event]
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
AN35_E.
[VBA]
Sub AN35_E_HorizontalAxisChanged (pen As Object)
End Sub
[Cicode]
FUNCTION AN35_E_HorizontalAxisChanged (OBJECT processAnalyst, OBJECT pen)
END

VerticalAxisChanged This event is raised whenever the vertical axis position or scale of a pen is
[Event] changed.
Defined As
„ [VBA] VerticalAxisChanged(pen As Object)
„ [Cicode] VerticalAxisChanged(OBJECT processAnalyst, OBJECT pen)
„ [C++] VerticalAxisChanged(IPen* pen)
Parameters
pen
[in] Refers to the pen that has changed.
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only)
See Also HorizontalAxisChanged [Event]
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_VerticalAxisChanged (pen As Object)
End Sub
223

[Cicode]
FUNCTION myPage_AN35_VerticalAxisChanged (OBJECT processAnalyst, OBJECT pen)
END

CursorMoved [Event] This event is raised whenever the cursor position changes.
Defined As
„ [VBA] CursorMoved(cursor As Object, position As Integer)
„ [Cicode] CursorMoved (OBJECT processAnalyst, OBJECT cursor, INT
position)
„ [C++] CursorMoved (IPen* pen, int position)
Parameters
cursor
[in] Refers to the cursor that has moved.
position
[in] Indicates the new position of the cursor.
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only).
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_CursorMoved(pen As Object, position As Integer)
End Sub
[Cicode]
FUNCTION myPage_AN35_CursorMoved(OBJECT processAnalyst, OBJECT cursor, INT position)
END

Error [Event] This event is raised whenever an error is generated from the Process Analyst.
Defined As
„ [VBA] Error(errorCode As Integer, errorMessage As String)
„ [Cicode] Error(OBJECT processAnalyst, INT errorCode, STRING
errorMessage)
„ [C++] Error(ErrorNotifyCode errorCode, BSTR errorMessage)
Parameters
errorCode
[in] Indicates the error that occurred. See the ErrorNotifyCode
enumeration.
errorMessage
[in] Contains the message associated with the error code.
224

processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only)
See Also ErrorNotifyCode [Enumeration]
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_Error(errorCode As Integer, errorMessage As String)
End Sub
[Cicode]
FUNCTION myPage_AN35_Error(OBJECT processAnalyst, INT errorCode, STRING errorMessage)
END

PropertyChanged This event is raised whenever a property that has been subscribed to has
[Event] changed.
Defined As
„ [VBA] PropertyChanged(interfaceName As String, propertyName As
String)
„ [Cicode] PropertyChanged (OBJECT processAnalyst, STRING
interfaceName, STRING propertyName)
„ [C++] PropertyChanged (BSTR interfaceName, BSTR propertyName)
Parameters
interfaceName
[in] Indicates which interface the property which has changed belongs to.
propertyName
[in] Indicates which property has changed.
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only)
Remarks
For this event to be raised you must subscribe to one or more properties.
See Also IProcessAnalyst.SubscribeForPropertyChange [Method],
IProcessAnalyst.UnsubscribePropertyChange [Method]
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_PropertyChanged(interfaceName As String, propertyName As String)
End Sub
225

[Cicode]
FUNCTION myPage_AN35_PropertyChanged(OBJECT processAnalyst, STRING interfaceName, STRING
propertyName)
END

OVItemAdded [Event] This event is raised whenever an item is added to the ObjectView.
Defined As
„ [VBA] OVItemAdded(item As Object)
„ [Cicode] OVItemAdded (OBJECT processAnalyst, OBJECT item)
„ [C++] OVItemAdded (IObjectViewItem* item)
Parameters
item
[in] A reference to the item that was added to the ObjectView.
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only)
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_OVItemAdded(item As Object)
End Sub
[Cicode]
FUNCTION myPage_AN35_OVItemAdded(OBJECT processAnalyst, OBJECT item)
END

OVItemRemoved This event is raised whenever an item is added to the ObjectView.


[Event] Defined As
„ [VBA] OVItemRemoved(item As Object)
„ [Cicode] OVItemRemoved(OBJECT processAnalyst, OBJECT item)
„ [C++] OVItemRemoved(IObjectViewItem* item)
Parameters
item
[in] A reference to the item that was removed from the ObjectView.
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only)
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
226

[VBA]
Sub myPage_AN35_OVItemRemoved(item As Object)
End Sub
[Cicode]
FUNCTION myPage_AN35_OVItemRemoved(OBJECT processAnalyst, OBJECT
item)
END

OVItemSelected [Event] This event is raised whenever an item is selected in the ObjectView.
Defined As
„ [VBA] OVItemSelected(item As Object)
„ [Cicode] OVItemSelected(OBJECT processAnalyst, OBJECT item)
„ [C++] OVItemSelected(IObjectViewItem* item)
Parameters
item
[in] A reference to the item that was selected in the ObjectView.
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only)
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_OVItemSelected(item As Object)
End Sub
[Cicode]
FUNCTION myPage_AN35_OVItemSelected(OBJECT processAnalyst, OBJECT item)
END

OVItemChecked [Event] This event is raised whenever an item is checked in the ObjectView.
Defined As
„ [VBA] OVItemChecked(item As Object)
„ [Cicode] OVItemChecked(OBJECT processAnalyst, OBJECT item)
„ [C++] OVItemChecked(IObjectViewItem* item)
Parameters
item
[in] A reference to the item that was checked in the ObjectView.
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only)
227

Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_OVItemChecked(item As Object)
End Sub
[Cicode]
FUNCTION myPage_AN35_OVItemChecked(OBJECT processAnalyst, OBJECT item)
END

OVColumnAdded This event is raised whenever a column is added to the ObjectView.


[Event] Defined As
„ [VBA] OVColumnAdded(name As String)
„ [Cicode] OVColumnAdded(OBJECT processAnalyst, STRING name)
„ [C++] OVColumnAdded(BSTR name)
Parameters
item
[in] The name of the column that has been added
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only)
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_OVColumnAdded(name As String)
End Sub
[Cicode]
FUNCTION myPage_AN35_OVColumnAdded(OBJECT processAnalyst, STRING name)
END

OVColumnRemoved This event is raised whenever a column is removed to the ObjectView.


[Event] Defined As
„ [VBA] OVColumnRemoved(name As String)
„ [Cicode] OVColumnRemoved(OBJECT processAnalyst, STRING name)
„ [C++] OVColumnRemoved(BSTR name)
Parameters
item
[in] The name of the column that has been removed.
228

processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only)
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_OVColumnRemoved(name As String)
End Sub
[Cicode]
FUNCTION myPage_AN35_OVColumnRemoved(OBJECT processAnalyst, STRING name)
END

CommandExecuted This event is raised when a command is executed.


[Event] Defined As
„ [VBA] CommandExecuted(commandId As String)
„ [Cicode] CommandExecuted (OBJECT processAnalyst, STRING
commandId)
„ [C++] CommandExecuted (BSTR commandId)
Parameters
commandId
[in] Contains the unique identifier of the command that was executed.
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only)
Remarks
Each toolbar button is associated with a command so when they are pressed this
event will be raised with the unique identifier of that command. You can then
use that identifier to determine which command was executed.
By using this event you can implement your own custom commands.
See Also UpdateCommand [Event], ICommandSystem.Execute [Method]

Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_CommandExecuted(commandId As String)
End Sub
[Cicode]
FUNCTION myPage_AN35_CommandExecuted(OBJECT processAnalyst, STRING commandId)
END
229

UpdateCommand This event is raised whenever the Process Analyst needs to refresh the state of its
[Event] toolbars.
Defined As
„ [VBA] UpdateCommand(commandId As String)
„ [Cicode] UpdateCommand(OBJECT processAnalyst, STRING commandId)
„ [C++] UpdateCommand(BSTR commandId)
Parameters
commandId
[in] Contains the unique identifier of the command that needs to be
refreshed.
processAnalyst
[in] Indicates the Process Analyst object which raised the event. (Cicode
only)
Remarks
This event is only raised for custom commands. You should use this event as an
opportunity to update the enable and/or the pressed state of the toolbar button
associated with the command.
This event will be raised frequently so you should limit the amount of code
executed in response to this event.
An Update will be triggered in at least the following scenarios:
„ Selection changes
„ Command execution
Calling Syntax
Assumes you have a Process Analyst on a page with an event class defined as
myPage_AN35.
[VBA]
Sub myPage_AN35_UpdateCommand(commandId As Integer)
End Sub
[Cicode]
FUNCTION myPage_AN35_UpdateCommand(OBJECT processAnalyst, INT commandId)
END

AlarmType Specifies the visual representation for an alarm pen.


[Enumeration] Defined As
„ [VBA] Integer
„ [Cicode] INT
„ [C++] AlarmType
230

Members
Member Name Description Value
AlarmType_Digital The tag is digital alarm 0
AlarmType_Analog The tag is an analog alarm 1
AlarmType_Advanced The tag is an advanced alarm 2
AlarmType_TimeStamped The tag is a time-stamped alarm 3
AlarmType_MultiDigital The tag is a multi-digital alarm 4
AlarmType_ArgyleAnalog The tag is a legacy Argyle analog alarm 5
AlarmType_TimeStampedDigital The tag is a digital time-stamped alarm 6
AlarmType_TimeStampedAnalog The tag is a analog time-stamped alarm 7
See Also IAlarmPen.AlarmType [Property][Get/Set]

AxisLabelType Specifies how the labels are drawn on the vertical axis.
[Enumeration] Defined As
„ [VBA] Integer
„ [Cicode] INT
„ [C++] AxisLabelType
Members
Member Name Description Value
AxisLabelType_NONE No labels will be visible on axis 0
AxisLabelType_DOUBLE Displays in decimal format 1
AxisLabelType_INTEGER Displays in integer format 2
AxisLabelType_PERCENT Displays as “%” 3
AxisLabelType_AMPS Displays as “A” 4
AxisLabelType_DEGREES Displays as “deg” 5
AxisLabelType_FEET Displays as “ft” 6
AxisLabelType_FEETPERMIN Displays as “ft/min” 7
AxisLabelType_FEETPERSEC Displays as “ft/s” 8
AxisLabelType_GALLONS Displays as “gal” 9
AxisLabelType_GALLONSPERHR Displays as “gal/h” 10
AxisLabelType_GALLONSPERMIN Displays as “gal/min” 11
AxisLabelType_GALLONSPERSEC Displays as “gal/s” 12
AxisLabelType_HERTZ Displays as “Hz” 13
AxisLabelType_KILOGRAMS Displays as “kg” 14
AxisLabelType_KILOGRAMSPERHR Displays as “kg/h” 15
AxisLabelType_KILOGRAMSPERMIN Displays as “kg/min” 16
AxisLabelType_KILOGRAMSPERSEC Displays as “kg/s” 17
AxisLabelType_KILOMETRESPERHR Displays as “kg/h” 18
AxisLabelType_KILOPASCALS Displays as “kPa” 19
AxisLabelType_KILOWATTS Displays as “kW” 20
AxisLabelType_LITRES Displays as “l” 21
AxisLabelType_LITRESPERHR Displays as “l/h” 22
AxisLabelType_LITRESPERMIN Displays as “l/min” 23
AxisLabelType_LITRESPERSEC Displays as “l/s” 24
231

Member Name Description Value


AxisLabelType_METRES Displays as “m” 25
AxisLabelType_METRESPERMIN Displays as “m/min” 26
AxisLabelType_METRESPERSEC Displays as “m/s” 27
AxisLabelType_REVS Displays as “Rev” 28
AxisLabelType_REVSPERHR Displays as “Rev/h” 29
AxisLabelType_REVSPERMIN Displays as “RPM” 30
AxisLabelType_TONNES Displays as “t” 31
AxisLabelType_TONNESPERHR Displays as “t/h” 32
AxisLabelType_VOLTS Displays as “V” 33
AxisLabelType_WATTS Displays as “W” 34
AxisLabelType_LOOKUP Displays user-defined text for label 35

LineStyle [Enumeration] Defines the drawing style for a line.


Defined As
„ [VBA] Integer
„ [Cicode] INT
„ [C++] LineStyle
Values
Member Name Description Value
LineStyle_SOLID Draws a solid line (all line widths) 0
LineStyle_DASH Draws a dashed line (line width 1 only) 1
LineStyle_DOT Draws a dot line (line width 1 only) 2
LineStyle_DASHDOT Draws a dash dot (line width 1 only) 3
LineStyle_DASHDOTDOT Draws a dash dot dot (line width 1 only) 4
LineStyle_NONE Draws no line 5

HatchStyle Defines the filling style for Alarm pens.


[Enumeration] Defined As
„ [VBA] Integer
„ [Cicode] INT
„ [C++] HatchStyle
Members
Member Name Description Value
HatchStyle_None No pattern 0
HatchStyle_Horizontal Horizontal line pattern 1
HatchStyle_Vertical Vertical line pattern 2
HatchStyle_ForwardDiagonal Forward diagonal line pattern 3
HatchStyle_BackwardDiagonal Backward diagonal line pattern 4
HatchStyle_Cross Cross pattern 5
HatchStyle_DiagonalCross Diagonal cross pattern 6
See Also IAlarmPen.SetHatchStyle [Method], IAlarmPen.GetHatchStyle [Method]
232

PenNameMode Defines how the pen name will be generated. It is used in conjunction with the
[Enumeration] IPens.Create method.
Defined As
„ [VBA] Integer
„ [Cicode] INT
„ [C++] PenNameMode
Members
Member Name Description Value
PenNameMode_Comment The comment field obtained from the Vijeo Citect trend/alarm tag 1
will be used as the pen name.
PenNameMode_Tag The value of the IPen.DataPoint property will be used as the pen 2
name.
PenNameMode_Custom Indicates that you will be setting the name using the IPen.Name 3
property.
See Also IPens.Create [Method], IPen.DataPoint [Property][Get/Set],
IPen.Name [Property][Get/Set]

PenType [Enumeration] Defines the plotting style of a Process Analyst pen.


Defined As
„ [VBA] Integer
„ [Cicode] INT
„ [C++] PenType
Members
Member Name Description Value
PenType_ANALOG A pen with an analog range 4097
PenType_DIGITAL A pen with a range of 0 and 1 4098
PenType_ALARM A pen represented as states 4099
See Also IPens.Create [Method]

PointType Defines the visual cue applied to samples of a pen.


[Enumeration] Defined As
„ [VBA] Integer
„ [Cicode] INT
„ [C++] PointType
Members
Member Name Description Value
PointType_NONE No marker 0
PointType_RECT A rectangular marker 1
PointType_CIRCLE A circular marker 2
PointType_PLUS A plus marker 3
233

Member Name Description Value


PointType_CROSS A cross marker 4
PointType_TRIANGLE A triangular marker 5
PointType_ELLIPSE A elliptical marker 6
See Also IPen.SetQualityCompactionPointType [Method]

RequestMode Defines the data acquisition method for a pen.


[Enumeration] Defined As
„ [VBA] Integer
„ [Cicode] INT
„ [C++] RequestMode
Members
Member Name Description Value
RequestMode_Average The value will be an average of all the individual samples within the 0
multiple sample, as will the timestamp
RequestMode_Minimum The value will be the minimum value out of all the individual samples 1
within the multiple sample. The timestamp will be the average of all the
individual samples.
RequestMode_Maximum The value will be the maximum value out of all the individual samples 2
within the multiple sample. The timestamp will be the average of all the
individual samples.
RequestMode_Newest The value will the latest arrived value out of all the individual samples 3
within the multiple sample. The timestamp will be the average of all the
individual samples.
See Also IPen.RequestMode [Property][Get/Set]

ToolbarButtonType Defines the type of a toolbar button.


[Enumeration] Defined As
„ [VBA] Integer
„ [Cicode] INT
„ [C++] ToolbarButtonType
Members
Member Name Description Value
ToolbarButtonType_Push Standard push button behavior. 0
ToolbarButtonType_Toggle The button has two states: On and Off. 1
ToolbarButtonType_Separato A visual marker used to group buttons. 2
r
See Also ICommandSystem.Create [Method], ICommand.ButtonType [Property][Get]

LineType [Enumeration] Defines the visual representation of the lines between samples of an analog pen.
Defined As
„ [VBA] Integer
234

„ [Cicode] INT
„ [C++] LineType
Members
Member Name Description Value
LineType_STRAIGHT A single line is drawn from point A to point B. 0
LineType_STEPPED The line drawn will maintain the value of the previous sample. When the 1
samples differ, a vertical line will be drawn to the new sample value.
See Also IAnalogPen.LineInterpolation [Property][Get/Set]

ErrorNotifyCode Defines known errors that can occur during operation.


[Enumeration] Defined As
„ [VBA] Integer
„ [Cicode] INT
„ [C++] ErrorNotifyCode
Members
Member Name Description Value
ErrorNotifyCode_None No error. 0
ErrorNotifyCode_InvalidTag Occurs when the tag specified for the pen does not 1
exist.
ErrorNotifyCode_CtapiConnectionOffline Occurs when connections cannot be made to the trend 2
and/or alarm servers.
ErrorNotifyCode_Unknown Occurs when an unknown Vijeo Citect or Windows 3
error occurs.
ErrorNotifyCode_NoServer Occurs when Vijeo Citect cannot find a server to get the 4
data from.
ErrorNotifyCode_InvalidArgument Occurs when an invalid argument is specified. 5
ErrorNotifyCode_OutOfMemory Occurs when a memory error is detected. 6
ErrorNotifyCode_BadVersion Occurs when the trend and/or alarm servers do not 7
match the client version.
ErrorNotifyCode_NoPrivilege Occurs when the current user does not have the 8
required privileges to view the data.
See Also Error [Event]

QualityType Defines the known quality states of data.


[Enumeration] Defined As
„ [VBA] Integer
„ [Cicode] INT
„ [C++] QualityType
Members
Member Name Description Value
QualityType_Good The sample is good 0
QualityType_NA Indicates a loss of connection 1
235

Member Name Description Value


QualityType_Gated Indicates the data was marked as unwanted 2
Remarks
An alarm pens “disabled” state is treated as QualityType_Gated.
See Also IPen.SetQualityLineStyle [Method]

QualityCompactionType Specifies the different types of presentation used for a sample.


[Enumeration] Defined As
„ [VBA] Integer
„ [Cicode] INT
„ [C++] QualityCompactionType
Members
Member Name Description Value
QualityCompactionType_Single Representation when the marker represents a single 0
sample
QualityCompactionType_Multiple Representation when the marker represents a 1
calculation of two or more samples
QualityCompactionType_Interpolated Representation when the marker represents 2
interpolated samples
See Also IPen.SetQualityCompactionPointType [Method]

FileLocation Specifies the location to save and write Process Analyst views to.
[Enumeration] Defined As
„ [VBA] Integer
„ [Cicode] INT
„ [C++] FileLocation
Members
Member Name Description Value
FileLocation_Local Refers to the project folder 0
FileLocation_Server Refers to the both the primary/standby server paths 1
FileLocation_User Refers to the My Documents folder 2
See Also IProcessAnalyst.LoadFromFile [Method], IProcessAnalyst.SaveToFile
[Method]

IToolbar Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IToolbar
236

Methods (0)
Properties (2)
IToolbar.Visible [Property][Get/Set]
IToolbar.Buttons [Property][Get]

IToolbar.Visible Gets and Sets this Toolbars Visible state.


[Property][Get/Set] Defined As
„ [VBA] Boolean Visible
„ [Cicode] INT Visible
„ [C++] VARIANT_BOOL Visible
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Limits
„ True (-1): Visible
„ False (0): Invisible
Remarks
If the toolbar is not visible, all buttons tied to it will not appear. Only the main
toolbar can be hidden. Setting the new toolbar to invisible will result in a
GeneralFailure.
Calling Syntax
This example assumes there is a valid Toolbar object as retrieved from a Process
Analyst’s Toolbars collection. (e.g., VBA: ProcessAnalyst.Toolbars.Item(1))
[VBA]
Sub Example(Toolbar As Object)
Dim visible As Boolean
‘Getting Property value
visible = Command.Visible
‘Setting Property value
Command.Visible = False
End Sub
[Cicode]
FUNCTION Example(OBJECT hToolbar)
// Getting property value
INT nVisible = _ObjectGetProperty(hToolbar, "Visible");
// Setting property value
_ObjectSetProperty(hToolbar, "Visible", 0);
END

IToolbar.Buttons Gets this Toolbars collection of Buttons.


[Property][Get] Defined As
„ [VBA] Object Buttons
237

„ [Cicode] OBJECT Buttons


„ [C++] IToolbarButtons* Buttons
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Calling Syntax
This example assumes there is a valid Toolbar object as retrieved from a Process
Analyst’s Toolbars collection. (e.g., VBA: ProcessAnalyst.Toolbars.Item(1))
[VBA]
Sub Example(Toolbar As Object)
Dim buttons As Object
‘Getting Property value
Set buttons = Command.Buttons
End Sub
[Cicode]
FUNCTION Example(OBJECT hToolbar)
// Getting property value
OBJECT hButtons = _ObjectGetProperty(hToolbar, "Buttons");
END

IToolbars Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IToolbar
Methods (0)
Properties (3)
IToolbars.Count [Property][Get]
IToolbars.Item [Property][Get]
IToolbars._NewEnum [Property][Get]

IToolbars.Count Gets the number of Toolbars in this collection.


[Property][Get] Defined As
„ [VBA] Long Count
„ [Cicode] INT Count
„ [C++] int Count
Execution Result
If the property get succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument.
Calling Syntax
238

This example assumes there is a valid Toolbars collection as retrieved from an


ObjectView. (e.g., VBA: objectView.Toolbars).
[VBA]
Sub Example(Toolbars As Object)
Dim count As Long
‘Getting Property value
count = Toolbars.Count
End Sub
[Cicode]
FUNCTION Example(OBJECT hToolbars)
// Getting property value
INT nCount= _ObjectGetProperty(hToolbars, "Count");
END

IToolbars.Item Gets the Toolbar at a supplied index location in this collection.


[Property][Get] Defined As
„ [VBA] Item(index As Long) as Object
„ [Cicode] OBJECT Item(INT index)
„ [C++] Item(int index, IToolbar* Item)
Parameters
index
[in] Indicates the index location of the child item to return from this
collection. (One based) 1 = Main toolbar; 2 = Navigation toolbar.
Execution Result
If the property get succeeds, the return value will be Success. If the index is out
of range, the return value will be InvalidArgument.
Calling Syntax
This example assumes there is a valid Toolbars collection as retrieved from an
ObjectView. (e.g., VBA: objectView.Toolbars)
[VBA]
Sub Example(Toolbars As Object)
Dim toolbar As Object
‘Getting Property value
Set toolbar = Toolbars.Item(1)
End Sub
[Cicode]
FUNCTION Example(OBJECT hToolbars)
// Getting property value
OBJECT hToolbar = _ObjectCallMethod(hToolbars, "get_Item", 1);
END

IToolbars._NewEnum This allows For.. Each.. Next integration in VB.


[Property][Get] Calling Syntax
239

This example assumes there is a valid Toolbars collection as retrieved from an


ObjectView (e.g., VBA: objectView.Toolbars). This property is not applicable to
Cicode.
[VBA]
Sub Example(Toolbars As Object)
Dim toolbar As Object
Dim count Object
‘Using Property
For Each toolbar In Toolbars
count = count + 1
Next toolbar
End Sub

IToolbarButton Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IToolbar
Methods (0)
Properties (1)
IToolbarButton.CommandId [Property][Get]

IToolbarButton.Comma Gets the ID of the associated command for this button.


ndId [Property][Get] Defined As
„ [VBA] String CommandId
„ [Cicode] STRING CommandId
„ [C++] BSTR CommandId
Calling Syntax
This example assumes there is a valid ToolbarButtons collection as retrieved
from an ObjectView (e.g., VBA: objectView.Toolbars.Item(1).Buttons).
[VBA]
Sub Example(Buttons As Object)
Dim commandId As String
‘Getting Property value
commandId = Buttons.CommandId
End Sub
[Cicode]
FUNCTION Example(OBJECT hButtons)
// Getting property value
STRING nCommandId = _ObjectGetProperty(hButtons, "CommandId");
END
240

IToolbarButtons Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] IToolbar
Methods (3)
IToolbarButtons.Add [Method]
IToolbarButtons.Remove [Method]
IToolbarButtons.RemoveAll [Method]
Properties (3)
IToolbarButtons.Count [Property][Get]
IToolbarButtons.Item [Property][Get]
IToolbarButtons._NewEnum [Property][Get]

IToolbarButtons.Add Adds a toolbar button linked to the command identified by the supplied
[Method] Command Id to this Toolbar.
Defined As
„ [VBA] Add(CommandId as String)
„ [Cicode] Add (STRING CommandId)
„ [C++] HRESULT Add (BSTR CommandId)
Parameters
CommandId
[in] The Command ID of a command to link to the new button that is being
added.
Execution Result
If this method succeeds, the return value will be Success. If the command ID is
invalid, the return value will be InvalidArgument.
Remarks
If this method succeeds, the ID supplied will be linked to the new button that is
added. The Commands properties will be applied to that button. (its icon,
tooltip, security) If this button is pressed, the CommandExecuted event will
raise with this Command ID.
See Also CommandExecuted [Event]

Calling Syntax
This example assumes there is a valid ToolbarButtons collection as retrieved
from an ObjectView (e.g., VBA: objectView.Toolbars.Item(1).Buttons).
[VBA]
Sub Example(Buttons As Object)
Buttons.Add(“Citect_Command_Help”)
End Sub
241

[Cicode]
FUNCTION Example(OBJECT hButtons)
_ObjectCallMethod(hButtons, “Add”, “Citect_Command_Help”);
END

IToolbarButtons.Remov Removes a button from this toolbar at the supplied index.


e [Method] Defined As
„ [VBA] Remove(Index as Integer)
„ [Cicode] Remove (INT Index)
„ [C++] HRESULT Remove (int Index)
Parameters
Index
[in] The index of the button to remove from this toolbar. (1 Based)

Execution Results
If the method succeeds, the return value will be Success. If the index is out of
range, the return value will be InvalidRange. If the method fails, the return value
will be GeneralFailure.
Calling Syntax
This example assumes there is a valid ToolbarButtons collection as retrieved
from an ObjectView. (e.g., VBA: objectView.Toolbars.Item(1).Buttons).
[VBA]
Sub Example(Buttons As Object)
Buttons.Remove(1)
End Sub
[Cicode]
FUNCTION Example(OBJECT hButtons)
_ObjectCallMethod(hButtons, “Remove”, 1);
END

IToolbarButtons.Remov Removes all buttons from this Toolbar.


eAll [Method] Defined As
„ [VBA] RemoveAll()
„ [Cicode] RemoveAll()
„ [C++] HRESULT RemoveAll()
Execution Results
If this method succeeds, the return value will be Success. If this method fails, the
return value will be GeneralFailure.
Calling Syntax
This example assumes there is a valid ToolbarButtons collection as retrieved
from an ObjectView. (e.g., VBA: objectView.Toolbars.Item(1).Buttons)
242

[VBA]
Sub Example(Buttons As Object)
Buttons.RemoveAll()
End Sub
[Cicode]
FUNCTION Example(OBJECT hButtons)
_ObjectCallMethod(hButtons, “RemoveAll”);
END

IToolbarButtons.Count Gets the number of Buttons in this collection.


[Property][Get] Defined As
„ [VBA] Long Count
„ [Cicode] INT Count
„ [C++] int Count
Calling Syntax
This example assumes there is a valid ToolbarButtons collection as retrieved
from an ObjectView. (e.g., VBA: objectView.Toolbars.Item(1).Buttons).
[VBA]
Sub Example(Buttons As Object)
Dim count As Long
‘Getting Property value
count = Buttons.Count
End Sub
[Cicode]
FUNCTION Example(OBJECT hButtons)
// Getting property value
INT nCount = _ObjectGetProperty(hButtons, "Count");
END

IToolbarButtons.Item Gets the button at a supplied index location in this collection.


[Property][Get] Defined As
„ [VBA] Item(index As Long) as Object
„ [Cicode] OBJECT Item(INT index)
„ [C++] Item(int index, IToolbarButton* Item)
Parameters
index
[in] Indicates the index location of the button to return from this collection.
(One based)
Execution Results
If the property get succeeds, the return value will be success. If the index is out
of range, the return value will be InvalidArgument. If the method fails, the
return value will be GeneralFailure.
243

Calling Syntax
This example assumes there is a valid ToolbarButtons collection as retrieved
from an ObjectView (e.g., VBA: objectView.Toolbars.Item(1).Buttons).
[VBA]
Sub Example(Buttons As Object)
Dim toolbar As Object
‘Getting Property value
Set toolbar = Buttons.Item(1)
End Sub
[Cicode]
FUNCTION Example(OBJECT hButtons)
// Getting property value
OBJECT hToolbar = _ObjectCallMethod(hButtons, "get_Item", 1);
END

IToolbarButtons._NewE This allows For.. Each.. Next integration in VB.


num [Property][Get] Calling Syntax
This example assumes there is a valid ToolbarButtons collection as retrieved
from an ObjectView (e.g., VBA: objectView.Toolbars.Item(1).Buttons). This
property is not applicable to Cicode.
[VBA]
Sub Example(Buttons As Object)
Dim button As Object
Dim count Object
‘Using Property
For Each button In Buttons
count = count + 1
Next button
End Sub

ITrendCursor Interface
Defined As
„ [VBA] Object
„ [Cicode] OBJECT
„ [C++] ITrendCursor
Methods
ITrendCursor.GetValue [Method]
ITrendCursor.Delete [Method]
Properties
ITrendCursor.Color [Property][Get/Set]
ITrendCursor.Width [Property][Get/Set]
ITrendCursor.Position [Property][Get/Set]
ITrendCursor.Visible [Property][Get/Set]
ITrendCursor.Collection [Property][Get]
ITrendCursor.Name [Property][Get/Set]
244

ITrendCursor.PenLabelVisible [Property][Get/Set]
ITrendCursor.PenLabelWidth [Property][Get/Set]
ITrendCursor.PenLabelHeight [Property][Get/Set]
ITrendCursor.PenLabelX [Property][Get/Set]
ITrendCursor.PenLabelY [Property][Get/Set]
ITrendCursor.LabelsLocked [Property][Get/Set]

ITrendCursor.GetValue Gets the value at the cursor for the given pen.
[Method] Defined As
„ [VBA] GetValue(pen As Object, asLocal As Boolean, time As Date, milli As
Integer, value As String)
„ [Cicode] GetValue(OBJECT pen, INT asLocal, REAL time, INT milli,
STRING value)
„ [C++] HRESULT Create GetValue(IPen* pen, VARIANT_BOOL asLocal,
DATE *time, short *milli, BSTR *value)
Parameters
pen
[in] The pen for which the value is required.
asLocal
[in] Set to True (-1) if returned time is required in Local form (False (0) for
UTC).
time
[out] The time represented by the cursor position. This is accurate to one
second and must be combined with milli to give millisecond accuracy.
milli
[out] Added to time (see above) to give cursor time in millisecond
accuracy.
value
[out] The value of the trend for the given pen at the returned time.
Execution Result
If the function succeeds, the return value will be Success. If one of the return
variables are bad, then the return value will be InvalidArgument. If the cursor is
deleted, the return value will be GeneralFailure.
Calling Syntax
This example assumes you have a valid reference to a cursor and a pen.
[VBA]
Sub Example(cursor As Object, pen As Object)
Dim asLocal As Boolean
Dim cursorTime As Date
Dim milli As Integer
Dim cursorValue As String
245

asLocal = 0
cursor.GetValue pen, asLocal, cursorTime, milli, cursorValue
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor, OBJECT hPen)
INT asLocal = 0;
REAL time;
INT milli;
STRING value;
_ObjectCallMethod(hCursor , "GetValue", hPen, asLocal, time, milli, value);
END

ITrendCursor.Delete Deletes the cursor.


[Method] Defined As
„ [VBA] Delete()
„ [Cicode] Delete()
„ [C++] HRESULT Delete()
Execution Result
If the function succeeds, the return value will be Success. If the cursor is deleted,
the return value will be GeneralFailure.
Remarks
This method will remove the cursor from the Process Analyst. Any current
references to the cursor will continue to be valid; however, operations on them
will result in failure.
Calling Syntax
This example assumes you have a valid reference to a cursor.
[VBA]
Sub Example(cursor As Object)
cursor.Delete
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor)
_ObjectCallMethod(hCursor, "Delete");
END

ITrendCursor.Color Gets or Sets the line color of the cursor.


[Property][Get/Set] Defined As
„ [VBA] Long Color
„ [Cicode] INT Color
„ [C++] OLE_COLOR Color
Execution Result
246

If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the cursor is
deleted the return value will be GeneralFailure.
Remarks
The Cicode function PackedRGB can be used to convert an RGB color
specification to the OLE_COLOR type used by the Process Analyst.
Calling Syntax
This example assumes you have a valid reference to a cursor.
[VBA]
Sub Example(cursor As Object)
Dim trendCursorColor As Long
‘Getting Property value
trendCursorColor = cursor.Color
‘Setting Property value (to red)
cursor.Color = 255
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor)
INT trendCursorColor;
// Getting current property value
trendCursorColor = _ObjectGetProperty(hCursor, “Color”);
// Setting Property to blue
_ObjectSetProperty(hCursor, “Color”, PackedRGB(0, 0, 255));
END

ITrendCursor.Width Gets or Sets the line width of the cursor.


[Property][Get/Set] Defined As
„ [VBA] Long Width
„ [Cicode] INT Width
„ [C++] int Width
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the cursor is
deleted the return value will be GeneralFailure.
Limits
„ Minimum (0)
„ Maximum (8)
Calling Syntax
This example assumes you have a valid reference to a cursor.
[VBA]
Sub Example(cursor As Object)
Dim lineWidth As Long
‘Getting Property value
247

lineWidth = cursor.Width
‘Setting Property value
cursor.Width = 5
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor)
INT lineWidth;
// Getting current property value
lineWidth = _ObjectGetProperty(hCursor, “Width”);
// Setting Property to 5
_ObjectSetProperty(hCursor, “Width”, 5);
END

ITrendCursor.Position Get or Set the cursor’s physical position in the Process Analyst.
[Property][Get/Set] Defined As
„ [VBA] Long Position
„ [Cicode] INT Position
„ [C++] int Position
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the cursor is
deleted, the return value will be GeneralFailure.
Remarks
The cursor position is measured as the number of pixels from the left of the
Process Analyst graph.
Calling Syntax
This example assumes you have a valid reference to a cursor.
[VBA]
Sub Example(cursor As Object)
Dim position As Integer
‘Getting Property value
position = cursor.Position
‘Setting Property value
cursor.Position = 300
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor)
INT position;
// Getting current property value
position = _ObjectGetProperty(hCursor, “Position”);
// Setting Property to (300)
_ObjectSetProperty(hCursor, “Position”, 300);
END

ITrendCursor.Visible Get or Set whether the cursor is visible.


[Property][Get/Set] Defined As
248

„ [VBA] Boolean Visible


„ [Cicode] INT Visible
„ [C++] VARIANT_BOOL Visible
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the cursor is
deleted, the return value will be GeneralFailure.
Remarks
This property controls the visibility of the cursor. The visibility is also applied to
all labels associated with the cursor.
See Also ITrendCursor.PenLabelVisible [Property][Get/Set]
Calling Syntax
This example assumes you have a valid reference to a cursor.
[VBA]
Sub Example(cursor As Object)
Dim visibility As Boolean
‘Getting Property value
visibility = cursor.Visible
‘Setting Property value (False)
cursor.Visible = False
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor)
INT visibility;
// Getting current property value
visibility = _ObjectGetProperty(hCursor, “Visible”);
// Setting Property to False (0)
_ObjectSetProperty(hCursor, “Visible”, 0);
END

ITrendCursor.Collection Obtain a reference to the ICursors collection that contains the cursor.
[Property][Get] Defined As
„ [VBA] Object Collection
„ [Cicode] OBJECT Collection
„ [C++] HRESULT Collection(ICursors **cursor)
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the cursor is
deleted, the return value will be GeneralFailure.
Calling Syntax
This example assumes you have a valid reference to a cursor.
249

[VBA]
Sub Example(cursor As Object)
Dim cursors As Object
‘Getting Property collection
Set cursors = cursor.Collection
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor)
OBJECT hCursors;
// Getting collection
hCursors = _ObjectGetProperty(hCursor, “Collection”);
END

ITrendCursor.Name Get or Set the Name of the cursor.


[Property][Get/Set] Defined As
„ [VBA] String Name
„ [Cicode] STRING Name
„ [C++] BSTR Name
Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the name is 0
characters or greater than 250, the return value will be InvalidArgument.
If the cursor is deleted, the return value will be GeneralFailure.
Remarks
When setting the name property, remember that cursor names must be unique.
Setting the Name property will fail if a cursor with that name already exists.
Calling Syntax
This example assumes you have a valid reference to a cursor.
[VBA]
Sub Example(cursor As Object)
Dim name As String
‘Getting Property value
name = cursor.Name
‘Setting Property value
cursor.Name = “NewCursor”
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor)
STRING name;
// Getting current property value
name = _ObjectGetProperty(hCursor, “Name”);
// Setting Property
_ObjectSetProperty(hCursor, “Name”, “NewCursor”);
END
250

ITrendCursor.PenLabel Get or Set the label visibility of the specified pen on this cursor.
Visible [Property][Get/ Defined As
Set]
„ [VBA] Boolean PenLabelVisible(pen As Object)
„ [Cicode] INT PenLabelVisible(OBJECT pen)
„ [C++] HRESULT PenLabelVisible(IPen* pen, VARIANT_BOOL labelVisible)
Parameters
pen
[in] The pen for which cursor label is to be referenced.

Execution Result
If the property get/set succeeds, the return value will be Success. If the return
variable is bad, the return value will be InvalidArgument. If the cursor is
deleted, the return value will be GeneralFailure.
Limits
„ True (-1): Label is visible.
„ False (0): Label is hidden.
Remarks
Setting the visibility of the cursor using the Visible property will override the
pen label visibility. For example, if a particular label is hidden using
PenLabelVisible, this label will be shown again if Visible is set to True (-1).
See Also ITrendCursor.Visible [Property][Get/Set]
Calling Syntax
This example assumes you have a valid reference to a cursor and a pen.
[VBA]
Sub Example(cursor As Object, pen As Object)
Dim labelVisible As Boolean
‘Getting Property value
labelVisible = cursor.PenLabelVisible(pen)
‘Setting Property value (False)
cursor.PenLabelVisible(pen) = False
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor, OBJECT hPen)
INT labelVisible;
// Getting current property value
labelVisible = _ObjectCallMethod(hCursor,
"get_PenLabelVisible", hPen);
// Setting Property to FALSE
_ObjectCallMethod(hCursor , "put_PenLabelVisible", hPen, 0);
END
251

ITrendCursor.PenLabel Get or Set the label width of the specified pen on this cursor.
Width [Property][Get/ Defined As
Set]
„ [VBA] Double PenLabelWidth(pen As Object)
„ [Cicode] REAL PenLabelWidth (OBJECT pen)
„ [C++] HRESULT PenLabelWidth (IPen* pen, double labelWidth)
Parameters
pen
[in] The pen for which cursor label is to be referenced.
Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the cursor is
deleted the return value will be GeneralFailure.
Remarks
The value of width is represented in pixels.
See Also ITrendCursor.PenLabelHeight [Property][Get/Set],
ITrendCursor.PenLabelX [Property][Get/Set], ITrendCursor.PenLabelY
[Property][Get/Set]
Calling Syntax
This example assumes you have a valid reference to a cursor and a pen.
[VBA]
Sub Example(cursor As Object, pen As Object)
Dim labelWidth As Double
‘Getting Property value
labelWidth = cursor.PenLabelWidth(pen)
‘Setting Property value (100)
cursor.PenLabelWidth(pen) = 100
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor, OBJECT hPen)
REAL labelWidth;
// Getting current property value
labelWidth = _ObjectCallMethod(hCursor , "get_PenLabelWidth", hPen);
// Setting Property to 100
_ObjectCallMethod(hCursor , "put_PenLabelWidth", hPen, 100);
END

ITrendCursor.PenLabel Get or Set the label height of the specified pen on this cursor.
Height [Property][Get/ Defined As
Set]
„ [VBA] Double PenLabelHeight(pen As Object)
„ [Cicode] REAL PenLabelHeight (OBJECT pen)
„ [C++] HRESULT PenLabelHeight (IPen* pen, double labelHeight)
Parameters
252

pen
[in] The pen for which cursor label is to be referenced.

Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the cursor is
deleted the return value will be GeneralFailure.
Remarks
The value of height is represented in pixels.
See Also ITrendCursor.PenLabelWidth [Property][Get/Set],
ITrendCursor.PenLabelX [Property][Get/Set], ITrendCursor.PenLabelY
[Property][Get/Set]
Calling Syntax
This example assumes you have a valid reference to a cursor and a pen.
[VBA]
Sub Example(cursor As Object, pen As Object)
Dim labelHeight As Double
‘Getting Property value
labelHeight = cursor.PenLabelHeight(pen)
‘Setting Property value (100)
cursor.PenLabelHeight (pen) = 100
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor, OBJECT hPen)
REAL labelHeight;
// Getting current property value
labelHeight = _ObjectCallMethod(hCursor , "get_PenLabelHeight", hPen);
// Setting Property to 100
_ObjectCallMethod(hCursor , "put_PenLabelHeight", hPen, 100);
END

ITrendCursor.PenLabel Get or Set the label’s X-Axis position of the specified pen on this cursor.
X [Property][Get/Set] Defined As
„ [VBA] Double PenLabelX(pen As Object)
„ [Cicode] REAL PenLabelX (OBJECT pen)
„ [C++] HRESULT PenLabelX (IPen* pen, double labelX)
Parameters
pen
[in] The pen for which cursor label is to be referenced.

Execution Result
If the property get/set succeeds the return value will be Success. If the return
variable is bad then the return value will be InvalidArgument. If the cursor is
deleted the return value will be GeneralFailure.
253

Remarks
The label position is represented in pixels.
See Also ITrendCursor.PenLabelWidth [Property][Get/Set],
ITrendCursor.PenLabelHeight [Property][Get/Set],
ITrendCursor.PenLabelY [Property][Get/Set]
Calling Syntax
This example assumes you have a valid reference to a cursor and a pen.
[VBA]
Sub Example(cursor As Object, pen As Object)
Dim labelX As Double
‘Getting Property value
labelX = cursor.PenLabelX(pen)
‘Setting Property value (100)
cursor.PenLabelX(pen) = 100
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor, OBJECT hPen)
REAL labelX;
// Getting current property value
labelX = _ObjectCallMethod(hCursor , "get_PenLabelX", hPen);
// Setting Property to 100
_ObjectCallMethod(hCursor , "put_PenLabelX", hPen, 100);
END

ITrendCursor.PenLabel Get or Set the label’s Y-Axis position of the specified pen on this cursor.
Y [Property][Get/Set] Defined As
„ [VBA] Double PenLabelY(pen As Object)
„ [Cicode] REAL PenLabelY (OBJECT pen)
„ [C++] HRESULT PenLabelY (IPen* pIPen, double labelY)
Remarks
The label position is represented in pixels

Syntax ITrendCursor.PenLabelWidth [Property][Get/Set],


ITrendCursor.PenLabelHeight [Property][Get/Set],
ITrendCursor.PenLabelX [Property][Get/Set]
Calling Syntax
This example assumes you have a valid reference to a cursor and a pen.
[VBA]
Sub Example(cursor As Object, pen As Object)
Dim labelY As Double
‘Getting Property value
labelY = cursor.PenLabelY(pen)
‘Setting Property value (100)
cursor.PenLabelY(pen) = 100
End Sub
254

[Cicode]
FUNCTION Example(OBJECT hCursor, OBJECT hPen)
REAL labelY;
// Getting current property value
labelY = _ObjectCallMethod(hCursor , "get_PenLabelY", hPen);
// Setting Property to 100
_ObjectCallMethod(hCursor , "put_PenLabelY", hPen, 100);
END

ITrendCursor.LabelsLo Get or Set whether the cursor label positions are locked.
cked [Property][Get/Set] Defined As
„ [VBA] Boolean LabelsLocked
„ [Cicode] INT LabelsLocked
„ [C++] VARIANT_BOOL LabelsLocked
Limits
„ True (-1): Labels are locked
„ False (0): Labels are unlocked
Remarks
If labels are locked, they will not move when the cursor position is changed.
Calling Syntax
This example assumes you have a valid reference to a cursor.
[VBA]
Sub Example(cursor As Object)
Dim labelsLocked As Boolean
‘Getting Property value
labelsLocked = cursor.LabelsLocked
‘Setting Property value (False)
cursor.LabelsLocked = False
End Sub
[Cicode]
FUNCTION Example(OBJECT hCursor)
INT labelsLocked;
// Getting current property value
labelsLocked = _ObjectGetProperty(hCursor, “LabelsLocked”);
// Setting Property to False (0)
_ObjectSetProperty(hCursor, “LabelsLocked”, 0);
END
Chapter 13: Cicode Programming Reference

Automation Examples
The best way of understanding how to use the Process Analyst’s automation
model is to see some example code. The following examples cover the most
important concepts of extensibility offered by the Process Analyst:
„ Event handling
„ Enumerating collections
„ Custom commands
„ Custom columns
All of the samples assume you are using the CSV example project and have
pasted a new Process Analyst onto the test page provided by the project.
You will also need to configure the Process Analyst object’s Name and Event
class by doing the following:
1 In the CSV example project open the “test” page in Graphics Builder
2 Click the Process Analyst icon in the toolbox to insert the control.
3 Resize the control to fit the test page.
4 Double-click the Process Analyst.
5 Click the Access/Identification tab.
6 Change the Object Name to CPA.
7 Change the Event class to CPA_E.
8 Click Apply and OK.

Handling an Event The Process Analyst contains many events that are triggered when certain
actions occur. See “Events”.
To handle an event you must provide a handler for the event by prepending
your Process Analyst’s event class name with the event name you want to
handle and an underscore. To configure the event class, see “Automation
Examples”.
The example below shows how to define a handler for the “MouseClick” event
with an event class defined as “CPA_E”.
[VBA]
Sub CPA_E_MouseClick(pen As Object, button As Integer)
End Sub
[Cicode]
FUNCTION CPA_E_MouseClick(OBJECT hPA, OBJECT hPen, INT button)
END
The following example uses the MouseClick event to cancel the box zoom
operation when the right mouse button is clicked.
256

Note: When referring to an ActiveX object in VBA, you need to prepend it with
the page name and an underscore. In the example below, the page name is called
“test”. The object name is “CPA” and the event class name is “CPA_E”.
[VBA]
Sub CPA_MouseClick(pen As Object, button As Integer)
Dim bZoomMode As Boolean

If (button = 1) Then
bZoomMode = test_CPA.ZoomMode

If (bZoomMode = True) Then


test_CPA.ZoomMode = False
End If
End If
End Sub
[Cicode]
FUNCTION CPA_E_MouseClick(OBJECT hPA, OBJECT hPen, INT button)
INT bZoomMode = 0;
IF (button = 1) THEN
bZoomMode = _ObjectGetProperty(hPA, "ZoomMode")
IF (bZoomMode = -1) THEN
_ObjectSetProperty(hPA, "ZoomMode", 0)
END
END
END

Enumerating The Process Analyst contains many “collections” such as Panes, Pens, Cursors,
collections Commands, and so on. This example shows you how to enumerate through the
buttons on the navigation toolbar.
[VBA]
Sub EnumerateToolbarButtons()
Dim navBar As Object
Dim iButton As Integer
Dim button As Object
Dim nButtons As Integer

‘ The Navigation toolbar is the 2nd toolbar in the collection


Set navBar = test_CPA.Toolbars.Item(2)
If IsNull(navBar) = False Then
nButtons = navBar.Buttons.Count
For iButton = 1 To nButtons
Set button = navBar.Buttons(iButton)
Next iButton
End If
End Sub
[Cicode]
FUNCTION EnumerateToolbarButtons()
OBJECT hPA = ObjectByName("CPA");
OBJECT hToolbars = _ObjectGetProperty(hPA, "Toolbars");
// The Navigation toolbar is the 2nd toolbar in the collection
OBJECT hNavBar = _ObjectCallMethod(hToolbars, "get_Item", 2);
OBJECT hButtons;
257

OBJECT hButton;
INT nButtons;
INT iButton;

IF (ObjectIsValid(hNavBar)) THEN
hButtons = _ObjectGetProperty(hNavBar, "Buttons");
nButtons = _ObjectGetProperty(hButtons, "Count");

FOR iButton = 1 TO nButtons DO


hButton = _ObjectCallMethod(hButtons, "get_Item", iButton);
END
END
END
Note: Many collections have an ItemById property that allows you to get the
item you want without having to enumerate through the collection to find the
item you want.

Implementing a custom Custom commands are easy to implement and involve creating a new
command command, adding it to a toolbar, and responding to the CommandExecuted
event.
To add a new command and add it to the toolbar as a button:
1 Display the properties for your Process Analyst in the Graphics Builder
2 See Adding New Commands.
3 Use the following settings:
„ ID =“SelectedPen”
„ Tooltip = “Show the name of the selected pen”
„ Button style = <Push>
„ Enabled = <Checked>
Once you’ve done this, you need to write an event handler for the
CommandExecuted event. This event will be called when the command is
executed, whether by Cicode or by clicking on the respective toolbar button.
The CommandExecuted event when triggered has a commandId parameter
identifying the command executed by the operator.
This example implements a command that displays a message box showing the
name of the primary selected pen.
See Also “CommandExecuted [Event]”
[VBA]
Sub CPA_E_CommandExecuted(commandId As String)
Select Case commandId
Case "SelectedPen"
Call OnSelectedPen()
End Select
End Sub

Sub OnSelectedPen()
Dim pen As Object
Dim sName As String
258

Dim sMessage As String

Set pen = test_CPA.LastSelectedPen

If IsNull(pen) = False Then


sName = pen.Name
End If
sMessage = "The name of the selected pen is:" + Chr(13) + sName
MsgBox sMessage, 48, "Citect"
End Sub

[Cicode]
FUNCTION CPA_E_CommandExecuted(OBJECT hPA, STRING commandId)
SELECT CASE commandId
CASE "SelectedPen"
OnSelectedPen(hPA);
END SELECT
END

FUNCTION OnSelectedPen(OBJECT hPA)


OBJECT hPen;
STRING sName;
STRING sMessage;
IF ObjectIsValid(hPA) THEN
hPen = _ObjectGetProperty(hPA, "LastSelectedPen");

IF ObjectIsValid(hPen) THEN
sName = _ObjectGetProperty(hPen, "Name");
END
sMessage = "The name of the selected pen is:^n" + sName;
Message("Citect", sMessage, 48);
END
END

Enabling and Disabling a Command


You can also respond to the UpdateCommand event to control the enable/disable
state of the command’s toolbar button. The example below disables the button if
there are no pens.
[VBA]
Sub CPA_E_UpdateCommand(commandId As String)
Select Case commandId
Case "SelectedPen"
Call OnUpdatedSelectedPen()
End Select
End Sub

Sub OnUpdatedSelectedPen()
Dim pen As Object
Dim command As Object
Dim sName As String

On Error Goto errHandler


259

Set command = test_CPA.CommandSystem.ItemById("SelectedPen")


Set pen = test_CPA.LastSelectedPen

sName = pen.Name
command.Enabled = True
Exit Sub

errHandler:
command.Enabled = False
End Sub
[Cicode]
FUNCTION CPA_E_UpdateCommand(OBJECT hPA, STRING commandId)
SELECT CASE commandId
CASE "PaneLock"
OnUpdatePaneLock(hPA);
CASE "SelectedPen"
OnUpdateSelectedPen(hPA);
END SELECT
END

FUNCTION OnUpdateSelectedPen(OBJECT hPA)


OBJECT hPen = _ObjectGetProperty(hPA, "LastSelectedPen");
OBJECT hCommandSystem = _ObjectGetProperty(hPA,"CommandSystem");
OBJECT hCommand = _ObjectCallMethod(hCommandSystem,"get_ItemById", "SelectedPen");
INT iError = 0;

ErrSet(1);
_ObjectGetProperty(hPen, "Name");
iError = IsError();

IF (iError <> 0) THEN


_ObjectSetProperty(hCommand, "Enabled", 0);
ELSE
_ObjectSetProperty(hCommand, "Enabled", -1);
END
ErrSet(0);
END
See Also “UpdateCommand [Event]”

Implementing a custom Custom columns are added to the Object View allowing you to display your
column own information associated with a pen.
The sample below implements a column that calculates the “Display Period” for
each pen on the Process Analyst. The sample consists of three functions: an
update function and two event handlers to ensure the column is updated when
new pens are added and when the time span is changed.

The Update Function


The update function is complex since it needs to match an Object View pen item
with a real pen object; however, this isn’t too difficult because the Object View
tree always reflects how many panes and pens are being displayed.
260

The code achieves this by iterating through each pane and pen object in the
Process Analyst while simultaneously keeping a running index count of which
pane/pen item it matches up to in the Object View tree.
By using these indexes the code knows which row to update. A row update is
achieved using the PutField method.
Note: Implementing your own column is CPU-intensive. Try to keep the amount
of code required to calculate a row value as efficient as possible and be aware
how often the code will be executed. Note also that, for efficiency, the
BlockUpdates and UnblockUpdates functions are used to limit the number of
updates made to the Object View.

Event Handlers
Once you have a function that implements your custom column, you need to
know when to update that column. The most common method of doing this is to
implement event handlers for particular Process Analyst events. The example
below uses the PenCreated event and the HorizontalAxisChanged event.
These events will ensure that the column values will be updated when pens are
added to the display and when the time span changes.
See Also “IObjectViewItem.PutField [Method]”, “IProcessAnalyst.BlockUpdates
[Method]”, “IProcessAnalyst.UnBlockUpdates [Method]”, “PenCreated
[Event]”, “HorizontalAxisChanged [Event]”
[VBA]
Sub UpdateMyColumn()
Dim iPaneItem As Integer
Dim iPane As Integer
Dim nPanes As Integer
Dim nSamples As Integer

Dim penItem As Object


Dim paneItem As Object

nSamples = test_CPA.NumberOfSamples
iPaneItem = 0
nPanes = test_CPA.Panes.Count
For iPane = 1 To nPanes
Dim pane As Object

Set pane = test_CPA.Panes.Item(iPane)


If IsNUll(pane) = False Then
Dim pen As Object
Dim iPen As Integer
Dim iPenItem As Integer
Dim nPens As Integer

iPaneItem = iPaneItem + 1

Set paneItem = test_CPA.ObjectView.Items.Item(iPaneItem)

test_CPA.BlockUpdates
iPenItem = 0
nPens = pane.Pens.Count
For iPen = 1 To nPens
261

Set pen = pane.pens.Item(iPen)

If IsNUll(pen) = False Then


Dim dDiff As Double
Dim sText As string

Dim dtStart As Date


Dim dtEnd As Date
Dim dtStartMs As Integer
Dim dtEndMs As Integer

iPenItem = iPenItem + 1

pen.GetHorizontalAxisTimeSpan dtStart, dtStartMs, dtEnd, dtEndMs, False

dDiff = ((CDbl(dtEnd) - CDbl(dtStart)) / nSamples) * 86400


If (dDiff >= 0.001) Then
sText = CStr(Format(dDiff, "#0.000")) + " seconds"
Else
sText = "0.001 seconds"
End If
Set penItem = paneItem.Items.Item(iPenItem)

If IsNUll(penItem) = False Then


penItem.Putfield "DisplayPeriod", sText
End If
End If
Next
test_CPA.UnblockUpdates
End If
Next
End Sub

Sub CPA_E_HorizontalAxisChanged(hPen As Object)


UpdateMyColumn
End Sub

Sub CPA_E_PenCreated(hPen As Object)


UpdateMyColumn
End Sub

[Cicode]
FUNCTION UpdateMyColumn()
OBJECThPA = ObjectByName("CPA");
OBJECThPanes = _ObjectGetProperty(hPA, "Panes");
OBJECThPane;
OBJECThPens;
OBJECThPen;
OBJECThObjectView = _ObjectGetProperty(hPA, "ObjectView");
OBJECThPaneItems = _OBJECTGetProperty(hObjectView, "Items");
OBJECThPaneItem;
OBJECThPenItems;
OBJECThPenItem;

INT nPanes = _ObjectGetProperty(hPanes, "Count");


262

INT nPens;
INT iPen;
INT iPane = 0;
INT nSamples = _ObjectGetProperty(hPA, "NumberOfsamples");
INT iPenItem = 0;
INT iPaneItem = 0;

REAL dDiff;
REAL dtStart;
REAL dtEnd;
INT dtStartMs;
INT dtEndMs;

STRINGsText;

FOR iPane = 1 TO nPanes DO


hPane = _ObjectCallMethod(hPanes, "get_Item", iPane);

IF ObjectIsValid(hPane) THEN
hPens = _ObjectGetProperty(hPane, "Pens");
nPens = _ObjectGetProperty(hPens, "Count");

iPaneItem = iPaneItem + 1;

_ObjectCallMethod(hPA, "BlockUpdates");
hPaneItem = _ObjectCallMethod(hPaneItems, "get_Item", iPaneItem);
iPenItem = 0;
FOR iPen = 1 TO nPens DO
hPen = _ObjectCallMethod(hPens, "get_Item", iPen);

IF ObjectIsValid(hPen) THEN

iPenItem = iPenItem + 1;
_ObjectCallMethod(hPen, "GetHorizontalAxisTimeSpan", dtStart, dtStartMs,
dtEnd, dtEndMs, 0);

dDiff = ((dtEnd - dtStart) / nSamples) * 86400;

IF dDiff > 0.001 THEN


sText = StrFormat(dDiff, 10, 3, "seconds");
ELSE
sText = "0.001 seconds"
END
hPenItems = _ObjectGetProperty(hPaneItem, "Items");
hPenItem = _ObjectCallMethod(hPenItems, "get_Item", iPenItem);

_ObjectCallMethod(hPenItem, "PutField", "DisplayPeriod", sText);


END
END
_ObjectCallMethod(hPA, "UnblockUpdates");
END
END
END

FUNCTION CPA_E_HorizontalAxisChanged(OBJECT hPA, OBJECT hPen)


UpdateMyColumn();
263

END

FUNCTION CPA_E_PenCreated(OBJECT hPA, OBJECT hPen)


UpdateMyColumn();
END
264
Index Add Cursor, 25
Add Pane, 43, 61
Add Pen, 61
adding new, 77
A Autoscale Vertical Axis, 61
acknowledgement, alarm, 12 Autoscroll, 21
Add Cursor command, 25 Back Half a Span, 60
Add New Pens dialog box, 27 Back One Span, 60
Add Pane command, 43, 61 Copy to Clipboard, 37, 60
Add Pen command, 61 Copy to File, 37
adding Edit Span, 22, 60
panes, 43 Edit Vertical Scale, 23, 60
pens, 27 editing, 78
toolbar commands, 53, 77 export, 60
alarm acknowledgement, 12 Forward Half a Span, 60
alarm label value, 26 Forward One Span, 60
alarm pen types, 13 general, 61
alarm pens, 11, 45 Help, 61
alarm states, 12 interface, 61
alarm types, 11 Load View, 56, 59
AlarmType enumeration, 229 Lock/Unlock Cursor Labels, 25, 61
analog pens, 10 Lock/Unlock Pens, 16, 61
association, tag, 65 Lock/Unlock Vertical Axis Scrolling, 61
automation model, 83 navigation, 60
Autoscale Vertical Axis command, 61 Print, 61
autoscaling, 61 Refresh Data, 61
Autoscroll command, 21 Remove Pane, 61
autoscrolling, 21 Remove Pen, 28, 61
axis Reset to Default Span, 23, 60
configuring, 47 Save View, 56, 59
horizontal, 7 Show Properties, 61
vertical, 8 Show/Hide Cursor, 25, 61
AxisLabelType enumeration, 230 Show/Hide Cursor Labels, 25, 61
Show/Hide Points, 61
B Synchronize to Now, 21, 60
Back Half a Span command, 60 Toggle Auto-Scrolling, 21, 60
Back One Span command, 60 Toggle Box Zoom, 21, 59
background color, configuring, 41, 43 Toggle Object View, 32, 61
Boolean terms during searches, 27 Toggle Span Lock, 20, 60
Undo Last Zoom, 21, 60
C view, 59
zoom, 59
columns, configuring Object View, 54
Zoom In 50%, 21
command system, 81
Zoom in 50%, 59
CommandExecuted event, 81, 228
Zoom Out 50%, 21
commands
266

Zoom out 50%, 59 Daylight Savings, 18


compaction, data, 5 Daylight Savings time, 8
comparison, trend, 16 defaults, configuring, 52
configuring deleting
appearance of pens, 44 pens, 28
axes, 47 design time properties, configuring, 77
chart panes, 43 digital pens, 11
chart-wide properties, 41 display, time, 7
columns in Object View, 54
cursor labels, 50 E
cursors, 51 Edit Command dialog box, 78
data connection, 50 Edit Span command, 22, 60
defaults, 52 Edit Span dialog box, 22
design time properties, 77 Edit Vertical Scale command, 23, 60
general properties, 41 Edit Vertical Scale dialog box, 23
gridlines, 46 editing commands, 78
pen quality, 49 effect, halo, 15
refresh rate, 41 end time, specifying, 18
report options, 34, 36 enumerations, automation model, 85
server paths, 42 Error event, 223
toolbars, 53 ErrorNotifyCode enumeration, 234
connection, data, 50 execution result, 83
context menu. See right-click menu export commands, 60
Copy to Clipboard command, 37, 60 exporting data, 37
Copy to File command, 37
copying data, 37
Create method, 81 F
creating custom commands, 81 FileLocation enumeration, 235
cursor labels, 24, 50 filtering pens, 27
CursorMoved event, 223 Fit to unit, 20
cursors, 24 fixed height for panes, specifying, 44
configuring, 51 Forward Half a Span command, 60
custom commands, 81 Forward One Span command, 60
custom commands, adding, 77
G
D general commands, 61
data general properties, configuring, 41
copying, 37 GetCommandSystem() property, 81
exporting, 37 graphics page, inserting onto, 65
data compaction, 5 gridlines, 9, 46
data connection, configuring, 50
data quality, 6 H
data request mode, 50 halo effect, 15
data request rate, configuring, 41 HatchStyle enumeration, 231
date/time axis, 7 Help command, 61
267

HorizontalAxisChanged event, 221 Insert ActiveX dialog box, 65


interface commands, 61
I interfaces, automation model, 84
IAlarmPen interface, 85 interpolation, 10, 45
IAlarmPen.AlarmType property, 87 IObjectView interface, 111
IAlarmPen.GetFillColor method, 88 IObjectView.BackgroundColor property, 113
IAlarmPen.GetHatchColor method, 89 IObjectView.Columns property, 115
IAlarmPen.GetHatchStyle method, 91 IObjectView.ForeColor property, 114
IAlarmPen.LineColor property, 85 IObjectView.Height property, 113
IAlarmPen.LineWidth property, 86 IObjectView.Items property, 115
IAlarmPen.SetFillColor method, 88 IObjectView.SelectedItem property, 116
IAlarmPen.SetHatchColor method, 90 IObjectView.Visible property, 112
IAlarmPen.SetHatchStyle method, 91 IObjectViewColumn interface, 117
IAnalogPen interface, 92 IObjectViewColumn.Name property, 117
IAnalogPen.LineColor property, 92 IObjectViewColumn.Text property, 117
IAnalogPen.LineInterpolation property, 93 IObjectViewColumn.Width property, 118
IAnalogPen.LineWidth property, 94 IObjectViewColumns interface, 119
ICommand interface, 95 IObjectViewColumns._NewEnum property, 124
ICommand.ButtonType property, 96 IObjectViewColumns.Add method, 119
ICommand.CommandId property, 95 IObjectViewColumns.Count property, 122
ICommand.Enabled property, 96 IObjectViewColumns.Hide method, 120
ICommand.Pressed property, 97 IObjectViewColumns.Item property, 122
ICommand.Privilege property, 99 IObjectViewColumns.ItemByName property, 123
ICommand.Tooltip property, 98 IObjectViewColumns.Remove method, 120
ICommandSystem interface, 99 IObjectViewColumns.Show method, 121
ICommandSystem._NewEnum property, 101 IObjectViewItem interface, 124
ICommandSystem.Count property, 100 IObjectViewItem.Expanded property, 126
ICommandSystem.Create method, 102 IObjectViewItem.GetField method, 124
ICommandSystem.Execute method, 103 IObjectViewItem.Items property, 128
ICommandSystem.Item property, 100 IObjectViewItem.PutField method, 125
ICommandSystem.ItemById property, 101 IObjectViewItem.Tag property, 127
ICommandSystem.Remove method, 103 IObjectViewItems interface, 128
icons, custom, 81 IObjectViewItems._NewEnum property, 130
ICursors interface, 104 IObjectViewItems.Count property, 129
ICursors._NewEnum property, 106 IObjectViewItems.Item property, 129
ICursors.Count property, 107 IObjectViewPenItem interface, 130
ICursors.Create method, 104 IObjectViewPenItem.BlockColor property, 130
ICursors.Item property, 106 IObjectViewPenItem.Checked property, 131
ICursors.ItemByName property, 107 IObjectViewPenItem.Selected property, 132
ICursors.RemoveAll method, 105 IPane interface, 132
IDigitalPen interface, 108 IPane.BackgroundColor property, 136
IDigitalPen.Fill property, 111 IPane.Collection property, 134
IDigitalPen.FillColor property, 108 IPane.Delete method, 133
IDigitalPen.LineColor property, 109 IPane.FixedHeight property, 136
IDigitalPen.LineWidth property, 110 IPane.Height property, 133
268

IPane.Name property, 135 IPen.ResetToDefaultSpan method, 156


IPane.Pens property, 137 IPen.Select method, 156
IPanes interface, 138 IPen.SetDefaultSpan method, 157
IPanes._NewEnum property, 141 IPen.SetQualityCompactionPointType method, 158
IPanes.Count property, 139 IPen.SetQualityLineStyle method, 158
IPanes.Create method, 138 IPen.SetVerticalAxisLabelValue method, 159
IPanes.Item property, 140 IPen.Stacked property, 176
IPanes.ItemByName property, 141 IPen.TrendCursorLabelFillColor property, 177
IPanes.RemoveAll method, 139 IPen.TrendCursorLabelLineColor property, 178
IPen interface, 142 IPen.TrendCursorLabelTextColor property, 178
IPen.AddSample method, 143 IPen.VerticalAxisAutoscale property, 179
IPen.AxisBackgroundColor property, 162 IPen.VerticalAxisColor property, 180
IPen.BlockRepaint property, 162 IPen.VerticalAxisLabelType property, 181
IPen.Clear method, 144 IPen.VerticalAxisResize property, 181
IPen.Collection property, 163 IPen.VerticalAxisScroll property, 182
IPen.DataPoint property, 164 IPen.VerticalAxisWidth property, 183
IPen.DataServer property, 164 IPen.VerticalGridlinesColor property, 184
IPen.Delete method, 144 IPen.VerticalGridlinesStyle property, 185
IPen.GetDefaultSpan method, 145 IPen.VerticalGridlinesWidth property, 185
IPen.GetHorizontalAxisTimeSpan method, 146 IPen.VerticalMinorGridlinesColor property, 186
IPen.GetInformation method, 147 IPen.VerticalMinorGridlinesStyle property, 187
IPen.GetStatistic method, 149 IPen.VerticalScrollBy method, 160
IPen.GetVerticalAxisSpan method, 149 IPen.VerticalZoom method, 161
IPen.GoToNow method, 150 IPen.Visible property, 187
IPen.Height property, 165 IPens interface, 188
IPen.HorizontalAxisColor property, 166 IPens._NewEnum property, 191
IPen.HorizontalAxisResize property, 167 IPens.Count property, 190
IPen.HorizontalAxisScroll property, 168 IPens.Create method, 189
IPen.HorizontalAxisWidth property, 168 IPens.Item property, 191
IPen.HorizontalGridlinesColor property, 169 IPens.ItemByName property, 191
IPen.HorizontalGridlinesStyle property, 170 IPens.Pane property, 192
IPen.HorizontalGridlinesWidth property, 171 IPens.RemoveAll method, 190
IPen.HorizontalMinorGridlinesColor property, 171 IProcessAnalyst interface, 81, 193
IPen.HorizontalMinorGridlinesStyle property, 172 IProcessAnalyst.AdminPrivilegeLevel property, 203
IPen.HorizontalScrollBy method, 151 IProcessAnalyst.AutoScroll property, 204
IPen.HorizontalZoom method, 151 IProcessAnalyst.BackgroundColor property, 204
IPen.IsDeleted property, 173 IProcessAnalyst.BlockUpdates method, 194
IPen.IsSelected property, 173 IProcessAnalyst.CommandSystem property, 205
IPen.LocalTime property, 174 IProcessAnalyst.ContextMenu property, 206
IPen.Name property, 175 IProcessAnalyst.CopyToClipboard method, 195
IPen.PointsVisible property, 152 IProcessAnalyst.CopyToFile method, 196
IPen.PutHorizontalAxisTimeSpan method, 153 IProcessAnalyst.Cursors property, 207
IPen.PutVerticalAxisSpan method, 154 IProcessAnalyst.DataRequestRate property, 207
IPen.RefreshData method, 155 IProcessAnalyst.DisplayRefreshRate property, 208
IPen.RequestMode property, 175 IProcessAnalyst.Language property, 209
269

IProcessAnalyst.LastSelectedPen property, 210 ITrendCursor.PenLabelX property, 252


IProcessAnalyst.LoadFromFile method, 197 ITrendCursor.PenLabelY property, 253
IProcessAnalyst.LockedPens property, 211 ITrendCursor.Position property, 247
IProcessAnalyst.ObjectView property, 212 ITrendCursor.Visible property, 247
IProcessAnalyst.Panes property, 213 ITrendCursor.Width property, 246
IProcessAnalyst.PrimaryPath property, 214
IProcessAnalyst.PrintAll method, 198 L
IProcessAnalyst.SaveToFile method, 199 label value, alarm, 26
IProcessAnalyst.SecondaryPath property, 215 legends, report, 35
IProcessAnalyst.ShowProperties method, 200 line styles, 6
IProcessAnalyst.SubscribeForPropertyChange LineStyle enumeration, 231
method, 200 LineType enumeration, 233
IProcessAnalyst.SynchroniseToNow method, 201 Load dialog box, 56
IProcessAnalyst.Toolbars property, 216 Load View command, 56, 59
IProcessAnalyst.UnBlockUpdates method, 194 loading views, 56
IProcessAnalyst.UnsubscribePropertyChange meth- Lock pens check box, 42
od, 202 Lock/Unlock Cursor Labels, 61
IProcessAnalyst.WritePrivilegeLevel property, 216 Lock/Unlock Cursor Labels command, 25
IProcessAnalyst.ZoomMode property, 217 Lock/Unlock Pens command, 16, 61
IToolbar interface, 235 Lock/Unlock Vertical Axis Scrolling command, 61
IToolbar.Buttons property, 236 locked pens, 16
IToolbar.Visible property, 236
IToolbarButton interface, 239
IToolbarButton.CommandId property, 239 M
IToolbarButtons interface, 240 main page (Properties dialog), 39
IToolbarButtons._NewEnum property, 243 main toolbar, 3
IToolbarButtons.Add method, 240 menu, right-click, 26
IToolbarButtons.Count property, 242 mode, request, 6
IToolbarButtons.Item property, 242 model, automation, 83
IToolbarButtons.Remove method, 241 mouse, using for interaction, 26
IToolbarButtons.RemoveAll method, 241 MouseClick event, 218
IToolbars interface, 237 MouseDoubleClick event, 218
IToolbars._NewEnum property, 238 multi-language support, 67
IToolbars.Count property, 237 multiple samples, 5
IToolbars.Item property, 238
ITrendCursor interface, 243 N
ITrendCursor.Collection property, 248 navigating time, 20
ITrendCursor.Color property, 245 navigation commands, 60
ITrendCursor.Delete method, 245 navigation toolbar, 17
ITrendCursor.GetValue method, 244 New Command dialog box, 77
ITrendCursor.LabelsLocked property, 254 Now indicator, 8
ITrendCursor.Name property, 249 number of samples, 42
ITrendCursor.PenLabelHeight property, 251
ITrendCursor.PenLabelVisible property, 250 O
ITrendCursor.PenLabelWidth property, 251 Object View, 31
270

basic functions, 32 persistence, 81


configuring columns, 54 point styles, 5
creating columns, 79 pointer, mouse, 26
default columns for, 32 PointType enumeration, 232
editing columns, 79 primary file server, 43
Object View (Properties dialog), 40 Print command, 61
Operator (term defined), 1 Print dialog box, 34
OVColumnAdded event, 227 printing reports, 34
OVColumnRemoved event, 227 Process Analyst button, 65
overlaying pens, 9 Properties dialog box, 39
OVItemAdded event, 225 property tree, 39
OVItemChecked event, 226 PropertyChanged event, 224
OVItemRemoved event, 225
OVItemSelected event, 226 Q
quality
P configuring pen, 49
panes quality, data, 6
adding, 43 QualityCompactionType enumeration, 235
configuring, 43 QualityType enumeration, 234
paths, server, configuring, 42
Pen Details box, 28 R
PenCreated event, 219 Refresh Data command, 61
PenDeleted event, 220 refresh rate, configuring, 41
PenNameMode enumeration, 232 Remove Pane command, 61
PenRenamed event, 220 Remove Pen command, 28, 61
pens removing
adding, 27 chart panes, 43
alarm, 11 toolbar commands, 53
analog, 10 report legends, 35
appearance, 44 report options, configuring, 34, 36
axes, configuring, 47 reports, 33
deleting, 28 configuring, 34
digital, 11 printing, 34
filtering, 27 request mode, data, 6, 50
gridlines, configuring, 46 RequestMode enumeration, 233
locked, 16 Reset to Default Span command, 23, 60
overlaying, 9 result, execution, 83
quality, configuring, 49 right-click menu, 26, 40
selecting, 15
stacking, 9
unlocked, 16 S
viewing details, 28 samples, number of, 42
PenSelectionChanged event, 221 Save Process Analyst View dialog box, 56
PenType enumeration, 232 Save View command, 56, 59
permissions, 65 saving views, 56
271

scaling, 17 toolbar, navigation, 17


scrolling, 16 ToolbarButtonType enumeration, 233
security, 65 toolbars
selecting adding commands to, 53
pens, 15 changing order of commands, 54
time span, 20 configuring, 53
server paths, configuring, 42 removing commands from, 53
Shift by unit, 19 toolbars (Properties dialog), 40
Show Properties command, 61 Tooltip text, 78
Show/Hide Cursor command, 25, 61 tree, property, 39
Show/Hide Cursor Labels command, 25, 61 types, alarm, 11
Show/Hide Points command, 61 types, alarm pen, 13
Span Picker, 20
stacked pens, 9 U
standby file server, 43 Undo Last Zoom command, 21, 60
start time, specifying, 18 universal time coordinate (UTC) format, 48
states, alarm, 12 unlocked pens, 16
statistical analysis options (reports), 35 unstacked pens, 9
stepped interpolation, 10, 45 UpdateCommand event, 81, 229
straight interpolation, 10, 45 User (term defined), 1
styles
line, 6
point, 5 V
Synchronize to Now command, 21, 60 value, alarm label, 26
system, command, 81 variable height for panes, specifying, 44
vertical (value) axis, 8
VerticalAxisChanged event, 222
T view commands, 59
tag association, 65 viewing
tag properties, viewing, 28 pen details, 28
time display, 7 views, 55
time format, 18 loading, 56
time span saving, 56
editing, 22
term defined, 20
time, navigating, 20 Z
Toggle Auto-Scrolling command, 60 zoom commands, 59
Toggle Auto-scrolling command, 21 Zoom In 50% command, 21
Toggle Box Zoom command, 21, 59 Zoom in 50% command, 59
Toggle Object View command, 32, 61 Zoom Out 50% command, 21
Toggle Span Lock command, 20, 60 Zoom out 50% command, 59
272

Das könnte Ihnen auch gefallen