PageProcessAnalystPens

Cicode Programming Reference > Cicode Function Categories > Page Functions Introduction > PageProcessAnalystPens

Display a page and add the specified pens to the first pane of the specified PA object on the page. If a PAV file is also specified, it will be loaded first, and the pens in the first pane will be removed before the specified pens are created on the PA.

Syntax

PageProcessAnlaystPens(sPage, sTag1 [, sTag2..sTag8 [, iButtonMask [, sObjName [, iPane [, sPAVFile [, iFileLocation ]]]]]])

sPage:

The name of the page that displays the PA.

sTag1..sTag8:

Up to 8 Trend tags can be added to the PA.

iButtonMask:

Mask to remove button(s) from the main tool bar of PA. The following values can be combined to remove multiple buttons:

1 - Load View
2 - Save View
4 - Print
8 - Copy to Clipboard
16 - Copy to File
32 - Add Pens
64 - Remove Pens
128 - Show Properties
256 - Help

sObjName

The name of the PA object. If not specified it is defaulted to "_templatePA1" which is the name used by the built-in templates.

iPane

The pane in PA where the trend or variable tags are added. If this is not specified or less than 1, it is defaulted to 1 (the 1st pane). If the specified pane does not exist in the PA object, a new pane will be created.

sPAVFile:

Optional Process Analyst View file to be loaded, default ="".

iFileLocation:

Optional location of the PAV file. The allowed values are:

0 - Analyst Views subfolder in project folder (default)
1 - Folders specified in properties primary/standby server path
2 - My documents folder

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

PageProcessAnalyst, ProcessAnalystLoadFile, ProcessAnalystPopUp,ProcessAnalystSelect, ProcessAnalystSetPen, ProcessAnalystWin, TrnSetPen, WinNewAt