ii RSBatch ActiveX Controls Library Reference Guide

Transcription

1

2 Contacting Rockwell Software Technical Support Telephone Technical Support Fax World Wide Web Copyright Notice 1998 Rockwell Software Inc. All rights reserved Printed in the United States of America Portions copyrighted by Allen-Bradley Company, Inc. and used with permission. This manual and any accompanying Rockwell Software products are copyrighted by Rockwell Software Inc. Any reproduction and/or distribution without prior written consent from Rockwell Software Inc. is strictly prohibited. Please refer to the license agreement for details. Trademark Notices WINtelligent Series is a registered trademark, and the Rockwell Software logo, RSAssistant, RSBatch, RSChart, RSData, RSDataPlayer, RSLogix Emulate 5, RSLogix Emulate 500, RSGuardian, RSHarmony, RSKeys, RSLinx, RSLogix 5, RSLogix 500, RSNetworx for ControlNet, RSNetworx for DeviceNet, RSPower, RSPowerCFG, RSPowerRUN, RSRules, RSServer32, RSServer, RSServer OPC Toolkit, RSSidewinderX, RSSoftLogix5, RSSql, RSToolbox, RSTrainer, RSTrend, RSTune, RSView32, RSView, RSWire, A.I. Series, Advanced Interface (A.I.) Series, AdvanceDDE, ControlGuardian, ControlView, INTERCHANGE, Packed DDE, WINtelligent, WINtelligent LINX, WINtelligent LOGIC 5, WINtelligent VIEW, WINtelligent RECIPE, WINtelligent VISION, and WINtelligent VISION2 are trademarks of Rockwell Software Inc. PLC, PLC-2, PLC-3 and PLC-5 are registered trademarks, and Data Highway Plus, DH+, DHII, DTL, Network DTL, Pyramid Integrator, PanelBuilder, PanelView, PLC-5/250, PLC-5/20E, PLC-5/40E, PLC-5/80E, SLC, SLC 5/01, SLC 5/02, SLC 5/03, SLC 5/04, SLC 5/05, and SLC 500 are trademarks of the Allen-Bradley Company, Inc. Microsoft, MS-DOS, Windows, and Visual Basic are registered trademarks, and Windows NT and Microsoft Access are trademarks of the Microsoft Corporation. Ethernet is a registered trademark of Digital Equipment Corporation, Intel, and Xerox Corporation. ControlNet is a trademark of ControlNet International. IBM is a registered trademark of International Business Machines Corporation. AIX, PowerPC, Power Series, RISC System/6000 are trademarks of International Business Machines Corporation. UNIX is a registered trademark in the United States and other countries, licensed exclusively through X/Open Company Limited. All other trademarks are the property of their respective holders and are hereby acknowledged. Warranty This Rockwell Software product is warranted in accord with the product license. The product's performance will be affected by system configuration, the application being performed, operator control and other related factors. The product's implementation may vary among users. This manual is as up-to-date as possible at the time of printing; however, the accompanying software may have changed since that time. Rockwell Software reserves the right to change any information contained in this manual or the software at anytime without prior notice. The instructions in this manual do not claim to cover all the details or variations in the equipment, procedure, or process described, nor to provide directions for meeting every possible contingency during installation, operation, or maintenance. ii RSBatch ActiveX Controls Library Reference Guide

3 Table of contents Introduction to the ActiveX Controls Library...11 Properties, methods, and events...11 ControlRecipeList control...12 PromptsList control...13 Methods...15 AbortControlRecipe method...15 Acknowledge method...16 AcknowledgeUI method...17 ClearFailuresOnControlRecipe method...18 CommandControlRecipe method...19 CommentControlRecipe method...20 CreateControlRecipe method...21 GetColumnText method...22 GetColumnWidth method...23 GetFilterPattern method...24 HoldControlRecipe method...26 Login method...27 LoginDefaultUser method...28 LoginUI method...29 PauseControlRecipe method...30 PromptIDIsValid method...31 iii

4 Refresh method...32 RemoveControlRecipe method...33 RestartControlRecipe method...34 ResumeControlRecipe method...35 SelectControlRecipe method...36 SelectPrompt method...37 SetColumnText method...38 SetColumnWidth method...39 SetControlRecipeMode method...40 SetFilterPattern method...41 ShowAboutBox method...43 StartControlRecipe method...44 StopControlRecipe method...45 Properties...47 AreaColumnText property...47 AreaColumnWidth property...48 AreaFilterPattern property...49 Arrange property...50 AutoSizeColumns property...51 BackColor, ForeColor Properties...52 BatchIDColumnText property...53 BatchIDColumnWidth property...54 BatchIDFilterPattern property...55 BorderStyle property...56 iv RSBatch ActiveX Controls Library Reference Guide

5 CanAbort property...57 CanAcknowledge property...58 CanBindAcknowledge property...59 CanClearFailures property...60 CanComment property...61 CanCreateControlRecipe property...62 CanHold property...63 CanPause property...64 CanRemove property...65 CanRestart property...66 CanResume property...67 CanSetAutomatic property...68 CanSetManual property...69 CanSetSemiAuto property...70 CanStart property...71 CanStop property...72 Connection property...73 ConnectTimeout property...74 ControlRecipes property...75 CreateIDColumnText property...76 CreateIDColumnWidth property...77 CreateIDFilterPattern property...78 DefaultBatchID property...79 DefaultScale property...80 Table of contents v

6 ColumnText property...81 ColumnWidth property...82 FilterPattern property...83 ElapsedTimeColumnText property...84 ElapsedTimeColumnWidth property...85 ElapsedTimeFilterPattern property...86 Enabled property...87 EUColumnText property...88 EUColumnWidth property...89 EUFilterPattern property...90 FailureColumnText property...91 FailureColumnWidth property...92 FailureFilterPattern property...93 FilteredControlRecipeCount property...94 FilteredPromptCount property...95 Font property...96 Height, Width Properties...97 HideColumnHeaders property...98 Interval property...99 LabelWrap property ListSeparator property MatchAmbientBackColor property MatchAmbientFont property MatchAmbientForeColor property vi RSBatch ActiveX Controls Library Reference Guide

7 ModeColumnText property ModeColumnWidth property ModeFilterPattern property MouseIcon property MousePointer property Node property PhaseColumnText property PhaseColumnWidth property PhaseFilterPattern property PhasesColumnText property PhasesColumnWidth property PhasesFilterPattern property ProcessCellColumnText property ProcessCellColumnWidth property ProcessCellFilterPattern property PromptIDColumnText property PromptIDColumnWidth property PromptIDFilterPattern property Prompts property PromptTypeColumnText property PromptTypeColumnWidth property PromptTypeFilterPattern property RecipeColumnText property RecipeColumnWidth property Table of contents vii

8 RecipeFilterPattern property SelectedControlRecipe property SelectedPrompt property ShowMenu property Sorted property SortKey property SortOrder property StartTimeColumnText property StartTimeColumnWidth property StartTimeFilterPattern property StateColumnText property StateColumnWidth property StateFilterPattern property TimeColumnText property TimeColumnWidth property TimeFilterPattern property TimeOutPeriod property UnitColumnText property UnitColumnWidth property UnitFilterPattern property UnitsColumnText property UnitsColumnWidth property UnitsFilterPattern property User property viii RSBatch ActiveX Controls Library Reference Guide

9 UserContext property ValueColumnText property ValueColumnWidth property ValueFilterPattern property View property Events Click event OnSelChange event OnUpdate event SimpleOnSelChange event Creating an ActiveX Control application ActiveX Batch Control Example ActiveX Batch Control Example interface Using the Controls properties, methods and events ControlRecipeList PromptsList Command buttons Mode buttons Unacknowledged Prompts button Index Table of contents ix

10 x RSBatch ActiveX Controls Library Reference Guide

11 Chapter 1 Introduction to the ActiveX Controls Library The ActiveX Controls Library is a set of ActiveX Custom Controls that lets you create a dynamic picture of batch automation system data. Use the ActiveX controls to create a custom look for your interface. The ActiveX Controls Library is designed especially for the manufacturing and process control industry. Configuring the ActiveX controls is easily accomplished by setting their properties, and does not require you to write any code. The ActiveX Controls Library contains two controls which make up the BatchView components: the ControlRecipeList control and the PromptsList control. These components equate to the Batch List window and the Unacknowledged Prompts window in the View component of RSBatch. Properties, methods, and events Properties, methods and events apply to s. An is a combination of code that can be treated as a unit, such as a control, form, or application. Each is defined by a class. There are two classes provided in the library: ControlRecipeList and PromptsList. A property is a named attribute of a control, form, application or other. Properties define characteristics such as size, color, and screen location, or they can define the state of an (e.g., enabled, disabled). A method is a procedure that acts on an. An event is an action recognized by an (such as clicking the mouse or pressing a key) for which you can write code to respond. Events can occur as a result of a user action or program code, or can be triggered by the control. 11

12 Properties, methods and events apply to the ActiveX controls. Use these properties, methods and events to customize the s created by the ActiveX controls to meet your needs. The common properties, events and methods for the ActiveX controls are described in this manual. ControlRecipeList control The ControlRecipeList control provides the mechanism to create a control recipe, command a control recipe, and remove a control recipe. The operator can select an existing control recipe from the control recipe list, or create a new control recipe by using the Create Control recipe menu option. Once a control recipe has been created it can be commanded by the operator using the ControlRecipeList menu. The control recipe list contains all of the control recipes that have been created, and not yet removed. Information specific to each control recipe is displayed in this control. You can specify what data is to be displayed in this list, and configure how it is displayed, using the control s properties, events and methods. The ControlRecipeList control displays items using one of four different views. You can arrange items into columns with or without column headings as well as display accompanying icons and text. With a ControlRecipeList control, you can organize control recipes into one of four different views: Large Icons Small Icons List Report The View property determines which view the control uses to display the items in the list. You can also control whether the labels associated with items in the list wrap to more than one line using the LabelWrap property. In addition, you can manage how items in the list are sorted. You can choose to display column headings in the ControlRecipeList control using the HideColumnHeaders property. 12 RSBatch ActiveX Controls Library Reference Guide

13 Note The ControlRecipeList control is part of a group of ActiveX controls that are found in the BATCHV01.OCX file. When distributing your application, install the BATCHV01.OCX file in the user's Microsoft Windows System or System32 directory. (Refer to the Visual Basic Programmer's Guide for more information on how to add an ActiveX control to a Visual Basic project.) PromptsList control While a control recipe is running, it may occasionally generate messages called prompts which require operator input. For instance, the control recipe may require the operator to enter a value for a parameter, or to specify a unit to which a unit procedure in the control recipe should be bound. The Prompts property allows access to information regarding each prompt in the list. The Count property associated with the Prompts property indicates the number of prompts requiring operator input. Prompts will be removed from the list when they have been acknowledged and the control recipe has successfully completed the acknowledgment. The operator can select the prompt to which he wishes to respond. When only one prompt is displayed in the list, it will automatically be selected when the list is displayed. Entries are made to the event journal when the control recipe generates the prompt, and when acknowledgment is completed successfully. The UserContext property supplies the operator s machine name and userid to the event journal. You can arrange items in the prompts list into columns with or without column headings as well as display accompanying icons and text. With a PromptsList control, you can organize prompts into one of four different views: Large Icons Small Icons List Report The View property determines which view the control uses to display the items in the list. You can also control whether the labels associated with items in the list wrap to more than one line using the LabelWrap property. In addition, you can manage how items in the list are sorted. Introduction to the ActiveX Controls Library 13

14 You can choose to display column headings in the PromptsList control using the HideColumnHeaders property. Note The PromptsList control is part of a group of ActiveX controls that are found in the BATCHV01.OCXfile. When distributing your application, install the BATCHV01.OCXfile in the user's Microsoft Windows System or System32 directory. (Refer to the Visual Basic Programmer's Guide for more information on how to add an ActiveX control to a Visual Basic project.) 14 RSBatch ActiveX Controls Library Reference Guide

15 Chapter 2 Methods AbortControlRecipe method ControlRecipeList Control Aborts the indicated control recipe..abortcontrolrecipe ID The AbortControlRecipe method syntax has these parts: ID An expression that evaluates to an in the list. Required. Integer representing the create ID of the control recipe to abort. If the ID argument identifies a control recipe that does not exist, this method will raise an error. 15

16 Acknowledge method PromptsList Control Acknowledges a prompt. [result =].Acknowledge ID, value The Acknowledge method syntax has these parts: result ID value Boolean value indicating the success (True) or failure (False) of the Acknowledge method. An expression that evaluates to an in the list. The Prompt ID of the prompt to be acknowledged. (of type long) Value with which the prompt is to be acknowledged If the prompt is a unit binding, the value supplied should be the unit ID to which the unit procedure is to be bound, as configured in the Equipment Editor. If the ID argument identifies a prompt that does not exist, or the value argument is of the wrong type, this method will raise an error and result will be False. 16 RSBatch ActiveX Controls Library Reference Guide

17 AcknowledgeUI method PromptsList Control Displays either the acknowledge or binding dialog box, based on the type of the prompt identified by the given Prompt ID, allowing the user an opportunity to acknowledge that prompt. [result =].AcknowledgeUI ID The AcknowledgeUI method syntax has these parts: result ID Boolean value indicating the success (True) or failure (False) of the display of the acknowledge dialog box or binding dialog box (based on the type of the prompt). An expression that evaluates to an in the list. The Prompt ID of the prompt to which the resulting dialog box should be specific. (of type long) If the ID argument identifies a prompt that does not exist, no dialog box is displayed, and result is False. Methods 17

18 ClearFailuresOnControlRecipe method ControlRecipeList Control Clears any failures on the indicated control recipe..clearfailuresoncontrolrecipe ID The ClearFailuresOnControlRecipe method syntax has these parts: ID An expression that evaluates to an in the list. Required. Integer representing the create ID of the control recipe to clear failures on. If the ID argument identifies a control recipe that does not exist, this method will raise an error. 18 RSBatch ActiveX Controls Library Reference Guide

19 CommandControlRecipe method ControlRecipeList Control This method provides a means for sending any command to a control recipe..commandcontrolrecipe ID, command The CommandControlRecipe method syntax has these parts: ID command An expression that evaluates to an in the list. Required. Integer representing the create ID of the control recipe to command. Required. An integer or constant specifying the command, as described in Settings. Settings The settings for command are: Constant Value crcommandcreatecontrolreci 4 Create the control recipe. pe crcommandstart 24 Start the control recipe. crcommandrestart 21 Restart the control recipe. crcommandhold 11 Hold the control recipe. crcommandabort 1 Abort the control recipe. crcommandstop 26 Stop the control recipe. crcommandresume 22 Resume the control recipe. crcommandclearfailures 8 Clear failures on the control recipe. crcommandremove 17 Remove the control recipe. If the ID argument identifies a control recipe that does not exist, this method will raise an error. If the currently logged-in user does not have permission to carryout the command identified by the command argument, the method will run without error, but will have no effect. Methods 19

20 CommentControlRecipe method ControlRecipeList Control This method provides a means for recording a comment in the event journal for the selected batch..commandcontrolrecipe ID, comment The CommentControlRecipe method syntax has these parts: ID comment An expression that evaluates to an in the list. Required. Integer representing the create ID of the control recipe to which the comment is to be added. String representing the comment to be added to the event journal for the indicated batch. 20 RSBatch ActiveX Controls Library Reference Guide

21 CreateControlRecipe method ControlRecipeList Control Displays the Master Recipe List dialog box, allowing the operator to choose a master recipe, and proceed to the Create Control Recipe Wizard. [result =].CreateControlRecipe The CreateControlRecipe method syntax has these parts: result Boolean value indicating if the current user does (True) or does not (False) possess permission to create a control recipe. An expression that evaluates to an in the list. Methods 21

22 GetColumnText method ControlRecipeList Control, PromptsList Control Returns the column header text for the specified column in the control. [result =].GetColumnText index The GetColumnText method syntax has these parts: result index String that is assigned the column header text of the specified column. An expression that evaluates to an in the list. Required. Integer identifying the column whose header text is returned. Columns are indexed from left to right, with the first column having an index of one. If the index argument is less than one, or greater than the number of columns (12), this method will raise an error. 22 RSBatch ActiveX Controls Library Reference Guide

23 GetColumnWidth method ControlRecipeList Control, PromptsList Control Returns the width of the specified column in the control. [result =].GetColumnWidth index The GetColumnWidth method syntax has these parts: result index Integer that is assigned the width of the specified column. An expression that evaluates to an in the list. Required. Integer identifying the column whose width is returned. Columns are indexed from left to right, with the left-most column having an index of one. If the index argument is less than one or greater than the number of columns (12), this method will raise an error. Column widths are specified in units of twips. Methods 23

24 GetFilterPattern method ControlRecipeList Control, PromptsList Control Returns the filter pattern for the specified column in the control. [pattern =].GetFilterPattern index The GetFilterPattern method syntax has these parts: pattern index String that is assigned the filter pattern for the specified column. An expression that evaluates to an in the list. Required. Integer identifying the column whose filter pattern is returned. This filter is used to filter the control recipe list to only show control recipes that match all filter patterns. If you do not want the column to be filtered, leave the default of *. Characters in pattern Matches in string? Any single character. * Zero or more characters. # Any single digit (0 9). [charlist] Any single character in charlist. [!charlist] Any single character not in charlist. A group of one or more characters (charlist) enclosed in brackets ([ ]) can be used to match any single character in a string and can include almost any character code, including digits. Note To match the special characters left bracket ( [ ), question mark (? ), number sign ( # ), and asterisk ( * ), enclose them in brackets. The right bracket ( ] ) can't be used within a group to match itself, but it can be used outside a group as an individual character. By using a hyphen ( ) to separate the upper and lower bounds of the range, charlist can specify a range of characters. For example, [A-Z] results in a match if the corresponding character position in a string contains any uppercase letters in the range A Z. Multiple ranges are included within the brackets without delimiters. 24 RSBatch ActiveX Controls Library Reference Guide

25 If the index argument is less than one or greater than the number of columns (12), this method will raise an error. Methods 25

26 HoldControlRecipe method ControlRecipeList Control Puts the indicated control recipe into hold..holdcontrolrecipe ID The HoldControlRecipe method syntax has these parts: ID An expression that evaluates to an in the list. Required. Integer representing the create ID of the control recipe to hold. If the ID argument identifies a control recipe that does not exist, this method will raise an error. 26 RSBatch ActiveX Controls Library Reference Guide

27 Login method ControlRecipeList Control, PromptsList Control Logs in the specified user. [result =].Login user, password The Login method syntax has these parts: result user password Boolean value indicating the success (True) or failure (False) of the login attempt. An expression that evaluates to an in the list. Required. String representing the name of the user to login. Required. String representing the password of the user to login. If the user/password combination provided does not correspond to an existing user account that is known to the machine which verifies user information, this method will return False. Methods 27

28 LoginDefaultUser method ControlRecipeList Control, PromptsList Control Logs in the default user. [result =].LoginDefaultUser The LoginDefaultUser method syntax has these parts: result Boolean value indicating the success (True) or failure (False) of the login attempt. An expression that evaluates to an in the list. If the user/password that has been specified as the default user does not correspond to an existing user account that is known to the machine which verifies user information, this method will return False. 28 RSBatch ActiveX Controls Library Reference Guide

29 LoginUI method ControlRecipeList Control, PromptsList Control Displays the login dialog box in modal fashion, providing the operator with an opportunity to login. [result =].LoginUI The LoginUI method syntax has these parts: result Boolean value indicating the success (True) or failure (False) of the login attempt. An expression that evaluates to an in the list. Methods 29

30 PauseControlRecipe method ControlRecipeList Control Pauses the indicated control recipe..pausecontrolrecipe ID The PauseControlRecipe method syntax has these parts: ID An expression that evaluates to an in the list. Required. Integer representing the create ID of the control recipe to pause. If the ID argument identifies a control recipe that does not exist, this method will raise an error. 30 RSBatch ActiveX Controls Library Reference Guide

31 PromptIDIsValid method PromptsList Control Determines if a given prompt ID identifies an existing prompt. [result =].PromptIDIsValid ID The PromptIDIsValid method syntax has these parts: result ID Boolean value indicating that the ID does (True) or does not (False) correspond to an existing prompt. An expression that evaluates to an in the list. Required. Integer representing the prompt ID of the prompt to be verified as valid. Methods 31

32 Refresh method ControlRecipeList Control, PromptsList Control Forces a complete repaint of a control..refresh The Refresh method syntax has these parts: An expression that evaluates to an in the list. 32 RSBatch ActiveX Controls Library Reference Guide

33 RemoveControlRecipe method ControlRecipeList Control Removes the indicated control recipe..removecontrolrecipe ID The RemoveControlRecipe method syntax has these parts: ID An expression that evaluates to an in the list. Required. Integer representing the create ID of the control recipe to remove. If the ID argument identifies a control recipe that does not exist, this method will raise an error. Methods 33

34 RestartControlRecipe method ControlRecipeList Control Restarts the indicated control recipe..restartcontrolrecipe ID The RestartControlRecipe method syntax has these parts: ID An expression that evaluates to an in the list. Required. Integer representing the create ID of the control recipe to restart. If the ID argument identifies a control recipe that does not exist, this method will raise an error. 34 RSBatch ActiveX Controls Library Reference Guide

35 ResumeControlRecipe method ControlRecipeList Control Resumes the indicated control recipe..resumecontrolrecipe ID The ResumeControlRecipe method syntax has these parts: ID An expression that evaluates to an in the list. Required. Integer representing the create ID of the control recipe to resume. If the ID argument identifies a control recipe that does not exist, this method will raise an error. Methods 35

36 SelectControlRecipe method ControlRecipeList Control Selects the indicated control recipe..selectcontrolrecipe ID The SelectControlRecipe method syntax has these parts: ID An expression that evaluates to an in the list. Required. Integer representing the create ID of the control recipe to select. If the ID argument identifies a control recipe that does not exist, this method will have no effect. Calling this method causes the OnSelChange event to fire. 36 RSBatch ActiveX Controls Library Reference Guide

37 SelectPrompt method PromptsList Control Selects the indicated prompt..selectprompt ID The SelectPrompt method syntax has these parts: ID An expression that evaluates to an in the list. Required. Integer representing the prompt ID of the prompt to select. If the ID argument identifies a prompt that does not exist, this method will not change which prompt is selected. Calling this method causes the OnSelChange event to fire. Methods 37

38 SetColumnText method ControlRecipeList Control, PromptsList Control Sets the text for the specified column in the control..setcolumntext index, text The SetColumnText method syntax has these parts: index text An expression that evaluates to an in the list. Required. Integer representing the column to set text on. Required. String containing new column header text. If the index argument is less than one or greater than the number of columns (12), or the text argument is Null, this method will raise an error. 38 RSBatch ActiveX Controls Library Reference Guide

39 SetColumnWidth method ControlRecipeList Control, PromptsList Control Sets the width in twips for the specified column in the control..setcolumnwidth index, width The SetColumnWidth method syntax has these parts: index width An expression that evaluates to an in the list. Required. Integer representing the column to set width on. Required. Integer representing the new column width. If the index argument is less than one or greater than the number of columns (12), or the width argument is less than zero, this method will raise an error. Methods 39

40 SetControlRecipeMode method ControlRecipeList Control Sets the indicated control recipe s mode..setcontrolrecipemode ID, mode The SetControlRecipeMode method syntax has these parts: ID mode An expression that evaluates to an in the list. Required. Integer representing the create ID of the control recipe to command. Required. An integer or constant specifying the mode, as described in Settings. Settings The settings for mode are: Constant Value crmodemanual 12 Put the control recipe into manual. crmodeauto 5 Put the control recipe into automatic. crmodesemiauto 26 Put the control recipe into semiautomatic. If the ID argument identifies a control recipe that does not exist, this method will raise an error. If the currently logged-in user does not have permission to change the mode of a control recipe, this method will have no effect. 40 RSBatch ActiveX Controls Library Reference Guide

41 SetFilterPattern method ControlRecipeList Control, PromptsList Control Sets the filter pattern for the specified column in the control..setfilterpattern index, pattern The SetFilterPattern method syntax has these parts: An expression that evaluates to an in the list. index Required. Integer representing the column to get filter pattern from. pattern Required. String representing the new filter pattern. The default value is *. This filter is used to filter the control recipe list to only show control recipes that match all filter patterns. If you do not want the column to be filtered, leave the default of *. Characters in pattern Matches in string? Any single character. * Zero or more characters. # Any single digit (0 9). [charlist] Any single character in charlist. [!charlist] Any single character not in charlist. A group of one or more characters (charlist) enclosed in brackets ([ ]) can be used to match any single character in a string and can include almost any character code, including digits. Note To match the special characters left bracket ( [ ), question mark (? ), number sign ( # ), and asterisk ( * ), enclose them in parens. The right bracket ( ] ) can't be used within a group to match itself, but it can be used outside a group as an individual character. By using a hyphen ( ) to separate the upper and lower bounds of the range, charlist can specify a range of characters. For example, [A-Z] results in a match if the corresponding character position in a string contains any uppercase letters in the range A Z. Multiple ranges are included within the brackets without delimiters. Methods 41

42 If the index argument is less than one or greater than the number of columns (12), or the pattern argument is Null, this method will raise an error. 42 RSBatch ActiveX Controls Library Reference Guide

43 ShowAboutBox method ControlRecipeList Control, PromptsList Control Displays the about box for this control..showaboutbox The ShowAboutBox method syntax has these parts: An expression that evaluates to an in the list. Methods 43

44 StartControlRecipe method ControlRecipeList Control Starts the indicated control recipe..startcontrolrecipe ID The StartControlRecipe method syntax has these parts: ID An expression that evaluates to an in the list. Required. Integer representing the create ID of the control recipe to start. If the ID argument identifies a control recipe that does not exist, this method will raise an error. 44 RSBatch ActiveX Controls Library Reference Guide

45 StopControlRecipe method ControlRecipeList Control Stops the indicated control recipe..stopcontrolrecipe ID The StopControlRecipe method syntax has these parts: ID An expression that evaluates to an in the list. Required. Integer representing the create ID of the control recipe to stop. If the ID argument identifies a control recipe that does not exist, this method will raise an error. Methods 45

46 46 RSBatch ActiveX Controls Library Reference Guide

47 Chapter 3 Properties AreaColumnText property PromptsList Control Returns or sets a value that determines the text displayed in the header of the Area column in the list..areacolumntext [= text] The AreaColumnText property syntax has these parts: text An expression that evaluates to an in the list. String to be displayed as the column header text for the Area column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. 47

48 AreaColumnWidth property PromptsList Control Returns or sets a value that determines the width of the Area column in the list..areacolumnwidth [= value] The AreaColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Area column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. 48 RSBatch ActiveX Controls Library Reference Guide

49 AreaFilterPattern property PromptsList Control Returns or sets the filter pattern for the Area column..areafilterpattern [= pattern] The AreaFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Area column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Area of a particular prompt in the prompts list does not match the AreaFilterPattern, that prompt is not included in the prompts list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 Properties 49

50 Arrange property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines how the icons in a ControlRecipeList control's Icon or SmallIcon view are arranged..arrange [= value] The Arrange property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines how the icons or small icons are arranged, as described in Settings. Settings The settings for value are: Constant Value lvwnoarrange 0 (Default) None. lvwautoleft 1 Left. Items are aligned automatically along the left side of the control. lvwautotop 2 Top. Items are aligned automatically along the top of the control. Setting this property to a value other than the valid Constants defined above will raise an error. 50 RSBatch ActiveX Controls Library Reference Guide

51 AutoSizeColumns property ControlRecipeList Control, PromptsList Control Sets the widths of all columns to automatically adjust to the largest column entry, including the header..autosizecolumns [= value] The AutoSizeColumns property syntax has these parts: value An expression that evaluates to an in the list. Boolean expression specifying whether the columns are auto-sized or not. Settings The settings for value are: Setting True False (Default) Columns are auto-sized. Columns are not auto-sized. Properties 51

52 BackColor, ForeColor Properties ControlRecipeList Control, PromptsList Control BackColor returns or sets the background color of an. ForeColor returns or sets the foreground color used to display text and graphics in an..backcolor [= color].forecolor [= color] The BackColor and ForeColor properties syntax have these parts: color An expression that evaluates to an in the list. A value or constant that determines the background or foreground color of an, as described below. The valid range for a normal RGB color is 0 to 16,777,215 (&HFFFFFF). The high byte of a number in this range equals 0; the lower 3 bytes, from least to most significant byte, determine the amount of red, green, and blue, respectively. The red, green, and blue components are each represented by a number between 0 and 255 (&HFF). If the high byte isn't 0, system colors are used. To display text in the Windows operating environment, both the text and background colors must be solid. If the text or background colors you've selected aren't displayed, one of the selected colors may be dithered that is, comprised of up to three different-colored pixels. If you choose a dithered color for either the text or background, the nearest solid color will be substituted. Setting either of these properties to a value outside of the allowable range (0 to &HFFFFFF) will raise an error. 52 RSBatch ActiveX Controls Library Reference Guide

53 BatchIDColumnText property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines the text displayed in the header of the Batch ID column in the list..batchidcolumntext [= text] The BatchIDColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Batch ID column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. Properties 53

54 BatchIDColumnWidth property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines the width of the Batch ID column in the list..batchidcolumnwidth [= value] The BatchIDColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Batch ID column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. 54 RSBatch ActiveX Controls Library Reference Guide

55 BatchIDFilterPattern property ControlRecipeList Control, PromptsList Control Returns or sets the filter pattern for the Batch ID column..batchidfilterpattern [= pattern] The BatchIDFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Batch ID column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Batch ID of a particular control recipe in the control recipe list does not match the BatchIDFilterPattern, that control recipe is not included in the control recipe list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 Properties 55

56 BorderStyle property ControlRecipeList Control, PromptsList Control Returns or sets the border style for the control..borderstyle [= value] The BorderStyle property syntax has these parts: value An expression that evaluates to an in the list. Integer or constant that determines the border style, as described in Settings. Settings The settings for value are: Value 0 None. 1 (Default) Fixed Single. 56 RSBatch ActiveX Controls Library Reference Guide

57 CanAbort property ControlRecipeList Control The CanAbort property is not available at design time, and is read-only at run time. Returns whether the indicated control recipe can be aborted. [result =].CanAbort ID The CanAbort property syntax has these parts: result ID Boolean expression that specifies if the Abort command is valid for the specified control recipe. An expression that evaluates to an in the list. Required. Integer that evaluates to the unique create ID of a control recipe. Settings The settings for result are: Setting True False Control recipe can be aborted. Abort is not a valid command for the specified control recipe. The CanAbort property is True only when the currently logged-in user has permission to abort control recipes, and the specified control recipe is in the RUNNING, STOPPING, HOLDING, RESTARTING or HELD state. Properties 57

58 CanAcknowledge property PromptsList Control The CanAcknowledge property is not available at design time, and is read-only at run time. Signifies the current user s right (or lack thereof) to acknowledge a prompt. [result =].CanAcknowledge ID The CanAcknowledge property syntax has these parts: result Object ID Boolean expression indicating if the current user possesses the security clearance necessary to acknowledge a prompt. An expression that evaluates to an in the list. Required. The unique prompt ID of a pending prompt. Settings The settings for result are: Setting True False The currently logged-in user has permission to acknowledge binding prompts. The currently logged-in user does not have permission to acknowledge binding prompts. The CanBindAcknowledge property is True only when the currently logged-in user has permission to acknowledge prompts. 58 RSBatch ActiveX Controls Library Reference Guide

59 CanBindAcknowledge property PromptsList Control Signifies the current user s right (or lack thereof) to resolve a binding at run time (acknowledge a binding prompt). [result =].CanBindAcknowledge The CanBindAcknowledge property syntax has these parts: result Boolean value indicating that the current user does (True) or does not (False) possess the security clearance necessary to acknowledge a binding prompt. An expression that evaluates to an in the list. Properties 59

60 CanClearFailures property ControlRecipeList Control The CanClearFailures property is not available at design time, and is read-only at run time. Returns whether the currently logged-in user has permission to clear failures on control recipes. [result =].CanClearFailures ID The CanClearFailures property syntax has these parts: result ID Boolean expression that specifies if the ClearFailures command is valid for the specified control recipe, as described in Settings. An expression that evaluates to an in the list. Required. Integer that evaluates to the unique create ID of a control recipe. Settings The settings for result are: Setting True False Control recipe can have its failures cleared. The currently logged-in user does not have permission to clear failures on control recipes. The CanClearFailures property is True only when the currently logged-in user has permission to clear failures on control recipes. 60 RSBatch ActiveX Controls Library Reference Guide

61 CanComment property ControlRecipeList Control The CanComment property is not available at design time, and is read-only at run time. Returns whether the currently logged-in user has permission to add a comment to the event log for the currently selected control recipe. [result =].CanComment ID The CanComment property syntax has these parts: result ID Boolean expression that specifies if the currently logged in user can add a comment to a control recipe. An expression that evaluates to an in the list. Required. Integer that evaluates to the unique create ID of a control recipe. Settings The settings for result are: Setting True False User has permission to add a comment to the event log of the selected control recipe. User does not have permission to add a comment to the event log of the selected control recipe. The CanComment property is True only when the currently logged-in user has permission to add comments to control recipes. Properties 61

62 CanCreateControlRecipe property ControlRecipeList Control The CanCreateControlRecipe property is not available at design time, and is read-only at run time. Returns whether the currently logged-in user has permission to create control recipes. [result =].CanCreateControlRecipe The CanCreateControlRecipe property syntax has these parts: result Boolean expression that specifies if the currently logged-in user has permission to create control recipes. An expression that evaluates to an in the list. Settings The settings for result are: Setting True False The currently logged-in user has permission to create control recipes. The currently logged-in user does not have permission to create control recipes. The CanCreateControlRecipe property is True only when the currently logged-in user has permission to create control recipes. 62 RSBatch ActiveX Controls Library Reference Guide

63 CanHold property ControlRecipeList Control The CanHold property is not available at design time, and is read-only at run time. Returns whether the indicated control recipe can be held. [result =].CanHold ID The CanHold property syntax has these parts: result ID Boolean expression that specifies if the Hold command is valid for the specified control recipe. An expression that evaluates to an in the list. Required. Integer that evaluates to the unique create ID of a control recipe. Settings The settings for result are: Setting True False Control recipe can be aborted. Hold is not a valid command for this control recipe. The CanHold property is True only when the currently logged-in user has permission to hold control recipes, and the specified control recipe is in the RUNNING state. Properties 63

64 CanPause property ControlRecipeList Control The CanPause property is not available at design time, and is read-only at run time. Returns whether the indicated control recipe can be paused. [result =].CanPause ID The CanPause property syntax has these parts: result ID Boolean expression that specifies if the Pause command is valid for the specified control recipe. An expression that evaluates to an in the list. Integer that evaluates to the unique create ID of a control recipe. Settings The settings for result are: Setting True False Control recipe can be paused. Pause is not a valid command for this control recipe. 64 RSBatch ActiveX Controls Library Reference Guide

65 CanRemove property ControlRecipeList Control The CanRemove property is not available at design time, and is read-only at run time. Returns whether the indicated control recipe can be removed. [result =].CanRemove ID The CanRemove property syntax has these parts: result ID Boolean expression that specifies if the Remove command is valid for the specified control recipe. An expression that evaluates to an in the list. Required. Integer that evaluated to the unique create ID of a control recipe. Settings The settings for result are: Setting True False Control recipe can be removed. Control recipe cannot be removed. The CanRemove property is True only when the currently logged-in user has permission to remove control recipes, and the specified control recipe is in the IDLE, ABORTED, STOPPED or COMPLETE state. Properties 65

66 CanRestart property ControlRecipeList Control The CanRestart property is not available at design time, and is read-only at run time. Returns whether the indicated control recipe can be restarted. [result =].CanRestart ID The CanRestart property syntax has these parts: result ID Boolean expression that specifies if the Restart command is valid for the specified control recipe. An expression that evaluates to an in the list. Required. Integer that evaluates to the unique create ID of a control recipe. Settings The settings for result are: Setting True False Control recipe can be restarted. Restart is not a valid command for this control recipe. The CanRestart property is True only when the currently logged-in user has permission to restart control recipes, and the specified control recipe is in the HELD state. 66 RSBatch ActiveX Controls Library Reference Guide

67 CanResume property ControlRecipeList Control The CanResume property is not available at design time, and is read-only at run time. Returns whether the indicated control recipe can be resumed. [result =].CanResume ID The CanResume property syntax has these parts: result ID Boolean expression that specifies if the Resume command is valid for the specified control recipe. An expression that evaluates to an in the list. Required. Integer that evaluates to the unique create ID of a control recipe. Settings The settings for result are: Setting True False Control recipe can be resumed. Resume is not a valid command for this control recipe. Properties 67

68 CanSetAutomatic property ControlRecipeList Control The CanSetAutomatic property is not available at design time, and is read-only at run time. Returns whether the indicated control recipe s mode can be changed to Automatic. [result =].CanSetAutomatic ID The CanSetAutomatic property syntax has these parts: result ID Boolean expression that specifies if setting the specified control recipe s mode to AUTO is valid. An expression that evaluates to an in the list. Required. Integer that evalautes to the unique create ID of a control recipe. Settings The settings for result are: Setting True False Control recipe s mode can be changed to Automatic. Control recipe s mode cannot be changed to Automatic. The CanSetAutomatic property is True only when the currently logged-in user has permission to put control recipes in automatic mode, and the specified control recipe is not currently in AUTOMATIC mode. 68 RSBatch ActiveX Controls Library Reference Guide

69 CanSetManual property ControlRecipeList Control The CanSetManual property is not available at design time, and is read-only at run time. Returns whether the indicated control recipe s mode can be changed to Manual. [result =].CanSetManual ID The CanSetManual property syntax has these parts: result ID Boolean expression that specifies if setting the specified control recipe s mode to MANUAL is valid. An expression that evaluates to an in the list. Required. Integer that evalautes to the unique create ID of a control recipe. Settings The settings for result are: Setting True False Control recipe s mode can be changed to Manual. Control recipe s mode cannot be changed to Manual. The CanSetManual property is True only when the currently logged-in user has permission to put control recipes into manual mode, and when the specified control recipe is not already in MANUAL mode. Properties 69

70 CanSetSemiAuto property ControlRecipeList Control The CanSetSemiAuto property is not available at design time, and is read-only at run time. Returns whether the indicated control recipe s mode can be changed to Semi-automatic. [result =].CanSetSemiAuto ID The CanSetSemiAuto property syntax has these parts: result ID Boolean expression that specifies if setting the specified control recipe s mode to SEMI-AUTO is valid. An expression that evaluates to an in the list. Required. Integer that evalautes to the unique create ID of a control recipe. Settings The settings for result are: Setting True False Control recipe s mode can be changed to Semi-Auto. Control recipe s mode cannot be changed to Semi-Auto. The CanSetSemiAuto property is True only when the currently logged-in user has permission to put control recipes into semi-automatic mode, and the mode of the specified control recipe is not already SEMI-AUTO. 70 RSBatch ActiveX Controls Library Reference Guide

71 CanStart property ControlRecipeList Control The CanStart property is not available at design time, and is read-only at run time. Returns whether the indicated control recipe can be started. [result =].CanStart ID The CanStart property syntax has these parts: result ID Boolean expression that specifies if the Start command is valid for the specified control recipe. An expression that evaluates to an in the list. Required. Integer that evalautes to the unique create ID of a control recipe. Settings The settings for result are: Setting True False Control recipe can be started. Start is not a valid command for this control recipe. The CanStart property is True only when the currently logged-in user has permission to start control recipes, and the specified control recipe is in the IDLE state. Properties 71

72 CanStop property ControlRecipeList Control The CanStop property is not available at design time, and is read-only at run time. Returns whether the indicated control recipe can be stopped. [result =].CanStop ID The CanStop property syntax has these parts: result ID Boolean expression that specifies if the Stop command is valid for the specified control recipe. An expression that evaluates to an in the list. Required. Integer that evalautes to the unique create ID of a control recipe. Settings The settings for result are: Setting True False Control recipe can be stopped. Stop is not a valid command for this control recipe. The CanStop property is True only when the currently logged-in user has permission to stop control recipes, and the specified control recipe is in the RUNNING, HOLDING, HELD or RESTARTING state. 72 RSBatch ActiveX Controls Library Reference Guide

73 Connection property ControlRecipeList Control, PromptsList Control Returns a reference to the connection associated with the communication between the ControlRecipeList control or the PromptsList control and the Batch Server. The Connection property is not available at design time, and is read-only at run time. [Set con =].Connection The Connection property syntax has these parts: con An reference that refers to the connection associated with the communication between the ControlRecipeList control and the Batch Server. An expression that evaluates to an in the list. The Connection property has two methods (Execute, GetData) and a property (Status) of its own: The Execute method has one argument, a string, which is a command string to be sent to the Batch Server. Refer to the RSBatch Server API Communications Language Reference Guide for the proper format and contents of this string argument. The GetData method also has one argument, which is also a string, sent to the Batch Server as a COM or DCOM data request. Refer to the RSBatch Server API Communications Language Reference Guide for the proper format and contents of this string argument. The Status property is read-only, and only available at run time. It either has the value OK, indicating that the connection is good, or it s value is a string describing the problem with the connection. Properties 73

74 ConnectTimeout property ControlRecipeList Control, PromptsList Control Returns or sets the number of seconds the Batch Server will wait for a command handshake before issuing a timeout..connecttimeout [= value] The ConnectTimeout property syntax has these parts: value An expression that evaluates to an in the list. A numeric expression specifying the length of time, in seconds, that the Batch Server will wait for a command handshake before issuing a timeout. The default is 60, and the valid range is 5 to 600. Setting this property to a value outside of the allowable range (see above) will raise an error. 74 RSBatch ActiveX Controls Library Reference Guide

75 ControlRecipes property ControlRecipeList Control Returns a reference to a copy of the collection of control recipes in the Batch Server. The ControlRecipes property is not available at design time, and is readonly at run time. [Set col =].ControlRecipes The ControlRecipes property syntax has these parts: col An reference that refers to a copy of ControlRecipes collection associated with the Batch Server. An expression that evaluates to an in the list. The ControlRecipes collection has two methods, Count and Item : The Count method returns a long, signifying the number of control recipes in the collection, and therefore executing in the Batch Server. The Item method allows individual access to the control recipes in the collection. It has one argument, the Index of the desired control recipe within the collection, and returns a reference to the control recipe indicated by the Index argument. The reference returned has fourteen properties. Refer to the SelectedControlRecipe property for a description of the properties available for each item in the collection of control recipes. Properties 75

76 CreateIDColumnText property ControlRecipeList Control Returns or sets a value that determines the text displayed in the header of the Create ID column in the list..createidcolumntext [= text] The CreateIDColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Create ID column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. 76 RSBatch ActiveX Controls Library Reference Guide

77 CreateIDColumnWidth property ControlRecipeList Control Returns or sets a value that determines the width of the Create ID column in the control recipe list..createidcolumnwidth [= value] The CreateIDColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Create ID column. The width of a column is measured in units of twips. Setting this property to Null will raise an error. Properties 77

78 CreateIDFilterPattern property ControlRecipeList Control Returns or sets the filter pattern for the Create ID column..createidfilterpattern [= pattern] The CreateIDFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Create ID column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Create ID of a particular control recipe in the control recipe list does not match the CreateIDFilterPattern, that control recipe is not included in the control recipe list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 78 RSBatch ActiveX Controls Library Reference Guide

79 DefaultBatchID property ControlRecipeList Control Returns or sets the default Batch ID used when creating a new control recipe..defaultbatchid [= text] The DefaultBatchID property syntax has these parts: text An expression that evaluates to an in the list. A string that determines the Batch ID to be used as default when creating a new control recipe. Changes to the DefaultBatchID property at run-time must be made prior to the invocation of the Create Control Recipe command. Once this command has been invoked, and the Master Recipe List dialog box has been displayed, changes to the DefaultBatchID property will not take effect until the current execution of the Create Control Recipe command is completed (the Master Recipe List dialog box and Create Control Recipe wizard forms are no longer displayed). Setting this property to a zero-length string ( ) or Null will raise an error. Properties 79

80 DefaultScale property ControlRecipeList Control Returns or sets the default control recipe scale used when creating a new control recipe. The DefaultScale is interpreted as a percentage of the output of the master recipe..defaultscale [= value] The DefaultScale property syntax has these parts: value An expression that evaluates to an in the list. A string that determines the scale to be used as default when creating a new control recipe. Changes to the DefaultScale property at run-time must be made prior to the invocation of the Create Control Recipe command. Once this command has been invoked, and the Master Recipe List dialog box has been displayed, changes to the DefaultScale property will not take effect until the current execution of Create Control Recipe command is completed (the Master Recipe List dialog box and Create Control Recipe wizard forms are no longer displayed). Setting this property to a zero-length string ( ), to Null, or to a string that cannot be converted to a number will raise an error. 80 RSBatch ActiveX Controls Library Reference Guide

81 ColumnText property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines the text displayed in the header of the column in the list..columntext [= text] The ColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. Properties 81

82 ColumnWidth property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines the width of the column in the list..columnwidth [= value] The ColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. 82 RSBatch ActiveX Controls Library Reference Guide

83 FilterPattern property ControlRecipeList Control, PromptsList Control Returns or sets the filter pattern for the column..filterpattern [= pattern] The FilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the of a particular prompt in the prompts list does not match the FilterPattern, that prompt is not included in the prompts list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 Properties 83

84 ElapsedTimeColumnText property ControlRecipeList Control Returns or sets a value that determines the text displayed in the header of the Elapsed Time column in the list..elapsedtimecolumntext [= text] The ElapsedTimeColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Elapsed Time column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. 84 RSBatch ActiveX Controls Library Reference Guide

85 ElapsedTimeColumnWidth property ControlRecipeList Control Returns or sets a value that determines the width of the Elapsed Time column in the control recipe list..elapsedtimecolumnwidth [= value] The ElapsedTimeColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Elapsed Time column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. Properties 85

86 ElapsedTimeFilterPattern property ControlRecipeList Control Returns or sets the filter pattern for the Elapsed Time column..elapsedtimefilterpattern [= pattern] The ElapsedTimeFilterPattern property syntax has these parts: pattern A string that determines the filter pattern for the Elapsed Time column. An expression that evaluates to an in the list. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Elapsed Time of a particular control recipe in the control recipe list does not match the ElapsedTimeFilterPattern, that control recipe is not included in the control recipe list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 86 RSBatch ActiveX Controls Library Reference Guide

87 Enabled property ControlRecipeList Control, PromptsList Control Specifies whether a control can receive the focus and respond to user-generated events..enabled [= value] The Enabled property syntax has these parts: value An expression that evaluates to an in the list. Optional. Boolean value indicating whether or not the can respond to usergenerated events, as described in Settings. Settings The settings for value are: Value True False The control can receive the focus and respond to user-generated events, and is accessible through code (default). The user cannot interact with the control by using the mouse, keystrokes, accelerators, or hotkeys. The control is still accessible through code. Use the Enabled property to enable and disable controls. A disabled control appears dimmed, while an enabled control does not. Properties 87

88 EUColumnText property PromptsList Control Returns or sets a value that determines the text displayed in the header of the engineering units (EU) column in the list..eucolumntext [= text] The EUColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the EU column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. 88 RSBatch ActiveX Controls Library Reference Guide

89 EUColumnWidth property PromptsList Control Returns or sets a value that determines the width of the engineering units (EU) column in the prompts list..eucolumnwidth [= value] The EUColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the EU column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. Properties 89

90 EUFilterPattern property PromptsList Control Returns or sets the filter pattern for the engineering units (EU) column..eufilterpattern [= pattern] The EUFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the EU column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the engineering units of a particular prompt in the prompts list does not match the EUFilterPattern, that prompt is not included in the prompts list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 90 RSBatch ActiveX Controls Library Reference Guide

91 FailureColumnText property ControlRecipeList Control Returns or sets a value that determines the text displayed in the header of the Failure column in the list..failurecolumntext [= text] The FailureColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Failure column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. Properties 91

92 FailureColumnWidth property ControlRecipeList Control Returns or sets a value that determines the width of the Failure column in the control recipe list..failurecolumnwidth [= value] The FailureColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Failure column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. 92 RSBatch ActiveX Controls Library Reference Guide

93 FailureFilterPattern property ControlRecipeList Control Returns or sets the filter pattern for the Failure column..failurefilterpattern [= pattern] The FailureFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Failure column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Failure of a particular control recipe in the control recipe list does not match the FailureFilterPattern, that control recipe is not included in the control recipe list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 Properties 93

94 FilteredControlRecipeCount property ControlRecipeList Control This property is not available at design time, and is read-only at run time. Returns the number of control recipes that match the filter patterns for the control recipes properties..filteredcontrolrecipecount The FilteredControlRecipeCount property syntax has these parts: An expression that evaluates to an in the list. If all of the filter patterns for the ControlRecipeList control are * (the default), then the FilteredControlRecipeCount property has the same value as the ControlRecipes.Count property. 94 RSBatch ActiveX Controls Library Reference Guide

95 FilteredPromptCount property PromptsList Control This property is not available at design time, and is read-only at run time. Returns the number of prompts that match the filter patterns for the prompts properties..filteredpromptcount The FilteredPromptCount property syntax has these parts: An expression that evaluates to an in the list. If all of the filter patterns for the PromptsList control are * (the default), then the FilteredPromptCount property has the same value as the Prompts.Count property. Properties 95

96 Font property ControlRecipeList Control, PromptsList Control Returns or sets the font of the specified. [Set objfont =].Font The Font property syntax has these parts: objfont A reference to a font. An expression that evaluates to an in the list. Use the Font property of an to identify a specific Font whose properties you want to use. For example, the following code changes the Bold property setting of a Font identified by the Font property of a ControlRecipeList : ControlRecipeList1.Font.Bold = True 96 RSBatch ActiveX Controls Library Reference Guide

97 Height, Width Properties ControlRecipeList Control, PromptsList Control Returns or sets the dimensions of an..height [= value].width [= value] The Height and Width properties syntax have these parts: value An expression that evaluates to an in the list. A numeric expression specifying the dimensions of an, as described in Settings. Settings Height and Width are measured from the center of the control's border so that controls with different border widths align correctly. These properties use the scale units of a control's container. Use the Left, Top, Height, and Width properties for operations based on an 's external dimensions, such as moving or re-sizing. Properties 97

98 HideColumnHeaders property ControlRecipeList Control, PromptsList Control Returns or sets whether the headers in a control are hidden in Report view..hidecolumnheaders [= value] The HideColumnHeaders property syntax has these parts: value An expression that evaluates to an in the list. Boolean expression that specifies if the column headers are visible in Report view, as described in Settings. Settings The settings for value are: Setting True False The column headers are not visible. (Default) The column headers are visible. 98 RSBatch ActiveX Controls Library Reference Guide

99 Interval property ControlRecipeList Control, PromptsList Control Returns or sets the number of milliseconds between data updates..interval [= value] The Interval property syntax has these parts: value An expression that evaluates to an in the list. A numeric expression specifying the number of milliseconds, as described in Settings. Settings The settings for value are: Setting 0 Disables updates. 1 to 65,535 Sets an interval (in milliseconds). For example, a value of 10,000 milliseconds equals 10 seconds. The maximum, 65,535 milliseconds, is equivalent to just over 1 minute. Setting this property to a value outside of the allowable range (see above) will raise an error. Properties 99

100 LabelWrap property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines whether or not labels are wrapped when a list control is in Icon view..labelwrap [= value] The LabelWrap property syntax has these parts: value An expression that evaluates to an in the list. Boolean expression specifying if the labels wrap, as described in Settings. Settings The settings for value are: Setting True False (Default) The labels wrap. The labels don't wrap. The length of the label is determined by setting the icon spacing in the Control Panel, Desktop option, in Windows NT. 100 RSBatch ActiveX Controls Library Reference Guide

101 ListSeparator property ControlRecipeList Control, PromptsList Control Returns the text representing the list separator. Read-only at run time. [text =].ListSeparator The ListSeparator property syntax has these parts: text An expression that evaluates to an in the list. A string specifying the list separator. The default value is a comma.locale-dependant. This property sets and retrieves the text used as the list separator. This list separator will be used in communication with the Batch Server and also in representing lists in the GUI. Setting this property to a zero-length string ( ) or Null will raise an error. Properties 101

102 MatchAmbientBackColor property ControlRecipeList Control, PromptsList Control Returns or sets whether the control s BackColor property should match the container s ambient BackColor property..matchambientbackcolor [= value] The MatchAmbientBackColor property syntax has these parts: value An expression that evaluates to an in the list. Boolean expression that specifies if the background color of the control will always match the container s background color. Settings The settings for value are: Setting True False (Default) The background color will match the container. The background color will not necessarily match the container. If this property is true, when the control is placed in the container, or the container s background color changes, the control s background color will change to match the container s background color. 102 RSBatch ActiveX Controls Library Reference Guide

103 MatchAmbientFont property ControlRecipeList Control, PromptsList Control Returns or sets whether the control s Font property should match the container s ambient Font property..matchambientfont [= value] The MatchAmbientFont property syntax has these parts: value An expression that evaluates to an in the list. Boolean expression that specifies if the font of the control will always match the container s font. Settings The settings for value are: Setting True False (Default) The font will match the container. The font will not necessarily match the container. If this property is true, when the control is placed in the container, or the container s font changes, the control s font will change to match the container s font. Properties 103

104 MatchAmbientForeColor property ControlRecipeList Control, PromptsList Control Returns or sets whether the control s ForeColor property should match the container s ambient ForeColor property..matchambientforecolor [= value] The MatchAmbientForeColor property syntax has these parts: value An expression that evaluates to an in the list. Boolean expression that specifies if the foreground color of the control will always match the container s foreground color. Settings The settings for value are: Setting True False (Default) The foreground color will match the container. The foreground color will not necessarily match the container. If this property is true, when the control is placed in the container, or the container s foreground color changes, the control s foreground color will change to match the container s foreground color. 104 RSBatch ActiveX Controls Library Reference Guide

105 ModeColumnText property ControlRecipeList Control Returns or sets a value that determines the text displayed in the header of the Mode column in the list..modecolumntext [= text] The ModeColumnText property syntax has these parts: text An expression that evaluates to an in the list. String to be displayed as the column header text for the Mode column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. Properties 105

106 ModeColumnWidth property ControlRecipeList Control Returns or sets a value that determines the width of the Mode column in the control recipe list..modecolumnwidth [= value] The ModeColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Mode column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. 106 RSBatch ActiveX Controls Library Reference Guide

107 ModeFilterPattern property ControlRecipeList Control Returns or sets the filter pattern for the Mode column..modefilterpattern [= pattern] The ModeFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Mode column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Mode of a particular control recipe in the control recipe list does not match the ModeFilterPattern, that control recipe is not included in the control recipe list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 Properties 107

108 MouseIcon property ControlRecipeList Control, PromptsList Control Returns or sets a custom mouse icon..mouseicon = LoadPicture pathname.mouseicon [= picture] The ModeColumnText property syntax has these parts: pathname picture An expression that evaluates to an in the list. A string expression specifying the path and filename of the file containing the custom icon. The Picture property of a Form, PictureBox control, or Image control. The MouseIcon property provides a custom icon that is used when the MousePointer property is set to 99. You can use the MouseIcon property to load either cursor or icon files. Color cursor files are displayed in black and white. To display a color cursor, use a color icon file (.ico). The MouseIcon property provides your program with easy access to custom cursors of any size, with any desired hot spot location. 108 RSBatch ActiveX Controls Library Reference Guide

109 MousePointer property ControlRecipeList Control, PromptsList Control Returns or sets a value indicating the type of mouse pointer displayed when the mouse is over a particular part of an at run time..mousepointer [= value] The ModeColumnText property syntax has these parts: value An expression that evaluates to an in the list. An integer specifying the type of mouse pointer displayed, as described in Settings. Settings The settings for value are: Settings 0 (Default) Shape determined by the. 1 Arrow. 2 Cross (crosshair pointer). 3 I beam. 4 Icon (small square within a square). 5 Size (four-pointed arrow pointing north, south, east, and west). 6 Size NE SW (double arrow pointing northeast and southwest). 7 Size N S (double arrow pointing north and south). 8 Size NW SE (double arrow pointing northwest and southeast). 9 Size W E (double arrow pointing west and east). 10 Up Arrow. 11 Hourglass (wait). 12 No Drop. 13 Arrow and hourglass. 14 Arrow and question mark. 15 Size all. 99 Custom icon specified by the MouseIcon property. You can use this property when you want to indicate changes in functionality as the mouse pointer passes over the controls. The Hourglass setting (11) is useful for indicating that the user should wait for a process or operation to finish. Properties 109

110 Node property ControlRecipeList Control, PromptsList Control Returns or sets the node name of a specific computer..node [= text] The Node property syntax has these parts: text An expression that evaluates to an in the list. A string expression specifying the node name of a specific computer. 110 RSBatch ActiveX Controls Library Reference Guide

111 PhaseColumnText property PromptsList Control Returns or sets a value that determines the text displayed in the header of the Phase column in the list..phasecolumntext [= text] The PhaseColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Phase column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. Properties 111

112 PhaseColumnWidth property PromptsList Control Returns or sets a value that determines the width of the Phase column in the prompts list..phasecolumnwidth [= value] The PhaseColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Phase column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. 112 RSBatch ActiveX Controls Library Reference Guide

113 PhaseFilterPattern property PromptsList Control Returns or sets the filter pattern for the Phase column..phasefilterpattern [= pattern] The PhaseFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Phase column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Phase of a particular prompt in the prompts list does not match the PhaseFilterPattern, that prompt is not included in the prompts list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 Properties 113

114 PhasesColumnText property ControlRecipeList Control Returns or sets a value that determines the text displayed in the header of the Phases column in the list..phasescolumntext [= text] The PhasesColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Phases column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. 114 RSBatch ActiveX Controls Library Reference Guide

115 PhasesColumnWidth property ControlRecipeList Control Returns or sets a value that determines the width of the Phases column in the control recipe list..phasescolumnwidth [= value] The PhasesColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Phases column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. Properties 115

116 PhasesFilterPattern property ControlRecipeList Control Returns or sets the filter pattern for the Phases column..phasesfilterpattern [= pattern] The PhasesFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Phases column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Phases of a particular control recipe in the control recipe list does not match the PhasesFilterPattern, that control recipe is not included in the control recipe list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 116 RSBatch ActiveX Controls Library Reference Guide

117 ProcessCellColumnText property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines the text displayed in the header of the Process Cell column in the list..processcellcolumntext [= text] The ProcessCellColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Process Cell column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. Properties 117

118 ProcessCellColumnWidth property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines the width of the Process Cell column in the list..processcellcolumnwidth [= value] The ProcessCellColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Process Cell column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. 118 RSBatch ActiveX Controls Library Reference Guide

119 ProcessCellFilterPattern property ControlRecipeList Control, PromptsList Control Returns or sets the filter pattern for the Process Cell column..processcellfilterpattern [= pattern] The ProcessCellFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Process Cell column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Process Cell of a particular control recipe in the control recipe list does not match the ProcessCellFilterPattern, that control recipe is not included in the control recipe list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 Properties 119

120 PromptIDColumnText property PromptsList Control Returns or sets a value that determines the text displayed in the header of the Prompt ID column in the list..promptidcolumntext [= text] The PromptIDColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Prompt ID column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. 120 RSBatch ActiveX Controls Library Reference Guide

121 PromptIDColumnWidth property PromptsList Control Returns or sets a value that determines the width of the Prompt ID column in the prompts list..promptidcolumnwidth [= value] The PromptIDColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Prompt ID column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. Properties 121

122 PromptIDFilterPattern property PromptsList Control Returns or sets the filter pattern for the Prompt ID column..promptidfilterpattern [= pattern] The PromptIDFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Prompt ID column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Prompt ID of a particular prompt in the prompts list does not match the PromptIDFilterPattern, that prompt is not included in the prompts list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 122 RSBatch ActiveX Controls Library Reference Guide

123 Prompts property PromptsList Control Returns a reference to a copy of the collection of prompts in the Batch Server. The Prompts property is not available at design time, and is read-only at run time. [Set col =].Prompts The Prompts property syntax has these parts: col An reference that refers to a copy of Prompts collection associated with the Batch Server. An expression that evaluates to an in the list. The Prompts collection has two methods, Count and Item. The Count method returns a long, signifying the number of prompts in the collection, and therefore pending in the Batch Server. The Item method allows individual access to the prompts in the collection. It has one argument, the Index of the desired prompt within the collection, and returns a reference to the prompt indicated by the Index argument. The reference returned has sixteen properties. Refer to the SelectedPrompt property for a description of the properties available for each item in the collection of prompts. Properties 123

124 PromptTypeColumnText property PromptsList Control Returns or sets a value that determines the text displayed in the header of the Prompt Type column in the list..prompttypecolumntext [= text] The PromptTypeColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Prompt Type column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. 124 RSBatch ActiveX Controls Library Reference Guide

125 PromptTypeColumnWidth property PromptsList Control Returns or sets a value that determines the width of the Prompt Type column in the prompts list..prompttypecolumnwidth [= value] The PromptTypeColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Prompt Type column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. Properties 125

126 PromptTypeFilterPattern property PromptsList Control Returns or sets the filter pattern for the Prompt Type column..prompttypefilterpattern [= pattern] The PromptTypeFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Prompt Type column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Prompt Type of a particular prompt in the prompts list does not match the PromptTypeFilterPattern, that prompt is not included in the prompts list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 126 RSBatch ActiveX Controls Library Reference Guide

127 RecipeColumnText property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines the text displayed in the header of the Recipe column in the list..recipecolumntext [= text] The RecipeColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Recipe column. Setting this property to a zero-length text ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. Properties 127

128 RecipeColumnWidth property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines the width of the Recipe column in the list..recipecolumnwidth [= value] The RecipeColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Recipe column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. 128 RSBatch ActiveX Controls Library Reference Guide

129 RecipeFilterPattern property ControlRecipeList Control, PromptsList Control Returns or sets the filter pattern for the Recipe column..recipefilterpattern [= pattern] The RecipeFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Recipe column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Recipe of a particular prompt in the prompts list does not match the RecipeFilterPattern, that prompt is not included in the prompts list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 Properties 129

130 SelectedControlRecipe property ControlRecipeList Control Returns a reference to a copy of the currently selected control recipe in the control recipe list. [Set rcp =].SelectedControlRecipe The SelectedControlRecipe property syntax has these parts: rcp A reference to a copy of the currently selected control recipe in the control recipe list. An expression that evaluates to an in the list. The reference to the currently selected control recipe has fourteen properties, as follows: Property Type Area String The area of the control recipe. CreateID String The Create ID of the control recipe. State String The State of the control recipe. Mode String The Mode of the control recipe. Command Mask Long The Command mask of the control recipe. Each of the sixteen bits of the command mask signifies the validity of a particular action that could be taken against the control recipe. If the bit is set, it signifies that the command is valid. Refer to Command Mask Bits below for an explanation of the command associated with each bit. StartTime String The Start Time of the control recipe. ElapsedTime String The Elapsed Time of the control recipe. BatchID String The Batch ID of the control recipe. String The of the control recipe. Failure String The Failure of the control recipe. If the control recipe is currently experiencing a failure, this string property will describe the failure. Recipe String The name of the Master Recipe from which the control recipe was derived. Scale Factor Long The scale factor of the selected control recipe. 130 RSBatch ActiveX Controls Library Reference Guide

131 Property Type ProcessCells Units Phases Collection The collection of Process Cells in which the control recipe is executing. (Refer to Process Cells Collection below for a description of the collection.) Collection The collection of Units owned by the control recipe. (Refer to Units Collection below for a description of the collection.) Collection The collection of Phases owned by the control recipe. (Refer to Phases Collection below for a description of the collection.) Command Mask Bits Each set bit signifies that the corresponding command is valid if the bit is set, where bit 0 is the least significant bit, and bit 15 is the most significant bit. Bit 0 Determines the validity of the Abort command. 1 Determines the validity of the Hold command. 2 Determines the validity of the Stop command. 3 Determines the validity of the Reset command. 4 Determines the validity of the Pause command. 5 Determines the validity of the SemiAuto command. 6 Determines the validity of the Download command. 7 Determines the validity of the Resume command. 8 Determines the validity of the Restart command. 9 Determines the validity of the Start command. 10 Determines the validity of the Automatic mode command. 11 Determines the validity of the Manual mode command. 12 Determines the validity of the Step command. 13 Determines the validity of the Clear Failures command. 14 Determines the validity of the Remove command. 15 Determines the validity of the Bind command. Process Cells Collection The ProcessCells collection property returns a reference to a copy of the collection of process cells for the given control recipe. The ProcessCells property is not available at authoring time, and is read-only at run time. The ProcessCells property has two methods, Count and Item. The Count method returns a long value for the number of process cells in the collection. The Item method of the ProcessCells collection property is the default method for that. Properties 131

132 The Item method has one argument, an integer called Index, that specifies an individual process cell within the collection. The Item method returns a reference to a copy of the process cell indicated by the Index argument. The reference to the process cell that is returned has two properties, ID and Name. The ID property is a string that represents the ID of the process cell. The Name property is a string that provides the name of the process cell. Units Collection The Units collection property returns a reference to a copy of the collection of units for the given control recipe. The Units property is not available at authoring time, and is read-only at run time. The Units property has two methods, Count and Item. The Count method returns a long value for the number of units in the collection. The Item method of the Units collection property is the default method for that. The Item method has one argument, an integer called Index, that specifies an individual unit within the collection. The Item method returns a reference to a copy of the unit indicated by the Index argument. The reference to the unit that is returned has three properties, Class, ID and Name. The Class property is a string that provides the name of the class to which the unit belongs. The ID property is a string that represents the ID of the unit, as defined in the area model against which the Batch Server is executing. The Name property is a string that provides the name of the unit, as defined in the area model against which the Batch Server is executing. Phases Collection The Phases collection property returns a reference to a copy of the collection of phases for the given control recipe. The Phases property is not available at authoring time, and is read-only at run time. The Phases property has two methods, Count and Item. 132 RSBatch ActiveX Controls Library Reference Guide

133 The Count method returns a long value for the number of phases in the collection. The Item method of the Phases collection property is the default method for that. The Item method has one argument, an integer called Index, that specifies an individual phase within the collection. The Item method returns a reference to a copy of the phases indicated by the Index argument. The reference to the phase that is returned has three properties, Class, ID and Name. The Class property is a string that provides the name of the class to which the phase belongs. The ID property is a string that represents the ID of the phase, as defined in the area model against which the Batch Server is executing. The Name property is a string that provides the name of the phase, as defined in the area model against which the Batch Server is executing. Properties 133

134 SelectedPrompt property PromptsList Control Returns a reference to a copy of the currently selected prompt in the prompts list. [Set pmt =].SelectedPrompt The SelectedPrompt property syntax has these parts: pmt A reference to a copy of the currently selected prompt in the prompts list. An expression that evaluates to an in the list. The reference to the currently selected prompt has sixteen properties, as follows: Property Type Area String The area of the prompt. BatchID String The batch ID of the prompt. Default String The default response value for the prompt. String The description of the prompt. EU String The engineering units of the response to the prompt. PromptID Long The unique ID of the prompt. PromptType String The Type of the prompt. Refer to Prompt Types below for an explanation of the possible values of this property. High String The high limit of the response to this prompt. Low String The low limit of the response to this prompt. Phase String The phase that generated this prompt. ProcessCell String The process cell from which this prompt was generated. Recipe String The name of the master recipe from which the control recipe that generated this prompt was derived. ResponseType Long The response type of the prompt. Refer to Response Types below for an explanation of the possible values of this property. Time String The time that the prompt occurred. Unit String The unit to which this prompt pertains. Value String The current response value to this prompt. Prompt Types The PromptType property is a string that identifies the type of the prompt, as follows: 134 RSBatch ActiveX Controls Library Reference Guide

135 Value Prompt A prompt to provide a value for a parameter, or a unit for a unit binding. Response Types The ResponseType property identifies the variable type of the response to an prompt that is expected, as follows: Value 1 The prompt requires a response of type real. 2 The prompt requires a response of type long. 3 The prompt requires a response of type string. 5 The response to the prompt should be a member of a defined enumeration set. 10 The prompt is a binding, whose response should be the ID of the unit that is to be bound to the step alias identified in the prompt. Properties 135

136 ShowMenu property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines if the shortcut menu should be displayed when the control is right-clicked..showmenu [= value] The ShowMenu property syntax has these parts: value An expression that evaluates to an in the list. A boolean expression indicating whether the shortcut menu will be displayed when the control is right-clicked. Settings The settings for value are: Setting True False The shortcut menu will be displayed when the control is right-clicked. The shortcut menu will not be displayed when the control is right-clicked. 136 RSBatch ActiveX Controls Library Reference Guide

137 Sorted property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines whether the items in a control are sorted..sorted [= value] The Sorted property syntax has these parts: value An expression that evaluates to an in the list. A Boolean expression specifying whether the items are sorted, as described in Settings. Settings The settings for value are: Setting True False The list items are sorted alphabetically, according to the SortOrder property. The list items are not sorted. The Sorted property must be set to True for the settings in the SortOrder and SortKey properties to take effect. Properties 137

138 SortKey property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines how the items in a control are sorted..sortkey [= value] The SortKey property syntax has these parts: value An expression that evaluates to an in the list. An integer specifying the sort key, as described in Settings. Settings The settings for value are: Setting Integer Sort using the column whose index is specified here (columns are zero-based) The Sorted property must be set to True before the change takes place. Setting this property to a value less than zero or greater than or equal to the number of columns (12) will raise an error. 138 RSBatch ActiveX Controls Library Reference Guide

139 SortOrder property ControlRecipeList Control, PromptsList Control Returns or sets a value that determines whether items in a control are sorted in ascending or descending order..sortorder [= value] The SortOrder property syntax has these parts: value An expression that evaluates to an in the list. An integer specifying the type of sort order, as described in Settings. Settings The settings for value are: Constant Value lvwascending 0 (Default) Ascending order. Sorts from the beginning of the alphabet (A-Z) or the earliest date. Numbers are sorted as strings, with the first digit determining the initial position in the sort, and subsequent digits determining sub-sorting. lvwdescending 1 Descending order. Sorts from the end of the alphabet (Z-A) or the latest date. Numbers are sorted as strings, with the first digit determining the initial position in the sort, and subsequent digits determining sub-sorting. The Sorted property must be set to True before a list will be sorted in the order specified by SortOrder. Setting this property to a value outside of the allowable range (see above) will raise an error. Properties 139

140 StartTimeColumnText property ControlRecipeList Control Returns or sets a value that determines the text displayed in the header of the Start Time column in the list..starttimecolumntext [= text] The StartTimeColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Start Time column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. 140 RSBatch ActiveX Controls Library Reference Guide

141 StartTimeColumnWidth property ControlRecipeList Control Returns or sets a value that determines the width of the Start Time column in the control recipe list..starttimecolumnwidth [= value] The StartTimeColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Start Time column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. Properties 141

142 StartTimeFilterPattern property ControlRecipeList Control Returns or sets the filter pattern for the Start Time column..starttimefilterpattern [= pattern] The StartTimeFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Start Time column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Start Time of a particular control recipe in the control recipe list does not match the StartTimeFilterPattern, that control recipe is not included in the control recipe list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 142 RSBatch ActiveX Controls Library Reference Guide

143 StateColumnText property ControlRecipeList Control Returns or sets a value that determines the text displayed in the header of the State column in the list..statecolumntext [= text] The StateColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the State column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. Properties 143

144 StateColumnWidth property ControlRecipeList Control Returns or sets a value that determines the width of the State column in the control recipe list..statecolumnwidth [= value] The StateColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the State column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. 144 RSBatch ActiveX Controls Library Reference Guide

145 StateFilterPattern property ControlRecipeList Control Returns or sets the filter pattern for the State column..statefilterpattern [= pattern] The StateFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the State column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the State of a particular control recipe in the control recipe list does not match the StateFilterPattern, that control recipe is not included in the control recipe list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 Properties 145

146 TimeColumnText property PromptsList Control Returns or sets a value that determines the text displayed in the header of the Time column in the list..timecolumntext [= text] The TimeColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Time column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. 146 RSBatch ActiveX Controls Library Reference Guide

147 TimeColumnWidth property PromptsList Control Returns or sets a value that determines the width of the Time column in the prompts list..timecolumnwidth [= value] The TimeColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Time column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. Properties 147

148 TimeFilterPattern property PromptsList Control Returns or sets the filter pattern for the Time column..timefilterpattern [= pattern] The TimeFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Time column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Time of a particular prompt in the prompts list does not match the TimeFilterPattern, that prompt is not included in the prompts list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 148 RSBatch ActiveX Controls Library Reference Guide

149 TimeOutPeriod property ControlRecipeList Control, PromptsList Control Returns or sets the amount of time that the Batch Server should allow itself to respond to a data request. Available at run-time only..timeoutperiod [= value] The TimeOutPeriod property syntax has these parts: value An expression that evaluates to an in the list. The frequency, in milliseconds, of the Batch Server s watchdog timer that checks communication with the Process Connected Device s DDE server. When the timer expires, the server performs the Set/Reset test on the DDE Server watchdog timer, or attempts to reconnect on a failed DDE conversation. The default is Properties 149

150 UnitColumnText property PromptsList Control Returns or sets a value that determines the text displayed in the header of the Unit column in the list..unitcolumntext [= text] The UnitColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Unit column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. 150 RSBatch ActiveX Controls Library Reference Guide

151 UnitColumnWidth property PromptsList Control Returns or sets a value that determines the width of the Unit column in the prompts list..unitcolumnwidth [= value] The UnitColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Unit column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. Properties 151

152 UnitFilterPattern property PromptsList Control Returns or sets the filter pattern for the Unit column..unitfilterpattern [= pattern] The UnitFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Unit column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Unit of a particular prompt in the prompts list does not match the UnitFilterPattern, that prompt is not included in the prompts list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 152 RSBatch ActiveX Controls Library Reference Guide

153 UnitsColumnText property ControlRecipeList Control Returns or sets a value that determines the text displayed in the header of the Units column in the list..unitscolumntext [= text] The UnitsColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Units column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. Properties 153

154 UnitsColumnWidth property ControlRecipeList Control Returns or sets a value that determines the width of the Units column in the control recipe list..unitscolumnwidth [= value] The UnitsColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Units column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. 154 RSBatch ActiveX Controls Library Reference Guide

155 UnitsFilterPattern property ControlRecipeList Control Returns or sets the filter pattern for the Units column..unitsfilterpattern [= pattern] The UnitsFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Units column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Unit of a particular control recipe in the control recipe list does not match the UnitsFilterPattern, that control recipe is not included in the control recipe list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 Properties 155

156 User property ControlRecipeList Control, PromptsList Control The User property is not available at design time, and is read-only at run time. It is used to determine if the operator has permission to execute a particular command..user The User property syntax has these parts: An expression that evaluates to an in the list. This property defaults to the Batch Server s default user. 156 RSBatch ActiveX Controls Library Reference Guide

157 UserContext property ControlRecipeList Control, PromptsList Control Returns a string representing the current user context for the list control, of the form computername/username. The UserContext property is not available at design time, and is read-only at run time..usercontext The UserContext property syntax has these parts: An expression that evaluates to an in the list. The UserContext property is included in all commands sent to the Batch Server, and is recorded in the journal events created when commands are sent to the Batch Server. Properties 157

158 ValueColumnText property PromptsList Control Returns or sets a value that determines the text displayed in the header of the Value column in the list..valuecolumntext [= text] The ValueColumnText property syntax has these parts: text An expression that evaluates to an in the list. A string to be displayed as the column header text for the Value column. Setting this property to a zero-length string ( ) will cause the column header to be displayed without text (empty). Setting this property to Null will raise an error. 158 RSBatch ActiveX Controls Library Reference Guide

159 ValueColumnWidth property PromptsList Control Returns or sets a value that determines the width of the Value column in the prompts list..valuecolumnwidth [= value] The ValueColumnWidth property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant that determines the width of the Value column. Setting this property to a value less than zero will raise an error. The width of a column is measured in units of twips. Properties 159

160 ValueFilterPattern property PromptsList Control Returns or sets the filter pattern for the Value column..valuefilterpattern [= pattern] The ValueFilterPattern property syntax has these parts: pattern An expression that evaluates to an in the list. A string that determines the filter pattern for the Value column. Setting this property to Null will raise an error. A filter pattern is a string that determines the characteristics of strings to be included in a particular column. For example, if the Value of a particular prompt in the prompts list does not match the ValueFilterPattern, that prompt is not included in the prompts list. Filter patterns are defined as follows: Kind of match Pattern Match (returns True) No match (returns False) Multiple characters a*a aa, aba, abbba abc *ab* abc, AABB, Xab azb, bac Special character a[*]a a*a aaa Multiple characters ab* abcdefg, abc cab, aab Single character a?a aaa, a3a, aba abbba Single digit a#a a0a, a1a, a2a aaa, a10a Range of characters [a-z] f, p, j 2, & Outside a range [!a-z] 9, &, % b, a Not a digit [!0-9] A, a, &, ~ 0, 1, 9 Combined a[!b-m]# An9, az0, a99 abc, aj0 160 RSBatch ActiveX Controls Library Reference Guide

161 View property ControlRecipeList Control, PromptsList Control Returns or sets the appearance of the items in a control..view [= value] The View property syntax has these parts: value An expression that evaluates to an in the list. An integer or constant specifying the control's appearance, as described in Settings. Settings The settings for value are: Constant Value lvwicon 0 Icon. Each item is represented by a full-sized (standard) icon and a text label. lvwsmallicon 1 SmallIcon. Each item is represented by a small icon and a text label that appears to the right of the icon. The items appear horizontally. lvwlist 2 List. Each item is represented by a small icon and a text label that appears to the right of the icon. The items are arranged vertically, each on its own line with information arranged in columns. lvwreport 3 (Default) Report. Each item is displayed with its small icon and text labels. In Icon view only, use the LabelWrap property to specify if the ListItem 's labels are wrapped or not. In Report view, you can hide the column headers by setting the HideColumnHeaders property to True. Setting this property to a value outside of the allowable range (see above) will raise an error. Properties 161

162 162 RSBatch ActiveX Controls Library Reference Guide

163 Chapter 4 Events Click event ControlRecipeList Control, PromptsList Control Fires when the mouse is clicked within the specified control. Private Sub _Click( ) The Click event syntax has these parts: An expression that evaluates to an in the list. 163

164 OnSelChange event ControlRecipeList Control, PromptsList Control Fires when the current selection in the list changes. Private Sub _OnSelChange[(item as ControlRecipe )] Private Sub _OnSelChange[(item as Prompt)] The OnSelChange event syntax has these parts: item An expression that evaluates to an in the list. A reference to the newly-selected item in the list. 164 RSBatch ActiveX Controls Library Reference Guide

165 OnUpdate event ControlRecipeList Control, PromptsList Control Fires when the new data has been retrieved from the Batch Server. Private Sub _OnUpdate The OnUpdate event syntax has these parts: An expression that evaluates to an in the list. Use this event procedure to tell the container what to do after each update interval has elapsed. The Interval property specifies the interval between OnUpdate events in milliseconds. Properties 165

166 SimpleOnSelChange event ControlRecipeList Control, PromptsList Control Fires when the currently-selected control recipe in the list changes. Private Sub _SimpleOnSelChange(ValueID) The OnSelChange event syntax has these parts: ValueID An expression that evaluates to an in the list. A reference to the ID of the newly-selected control recipe or event. 166 RSBatch ActiveX Controls Library Reference Guide

167 Chapter 5 Creating an ActiveX Control application This section contains an example application which illustrates the versatility and functionality of the ActiveX Controls Library. The example is intended to provide only a brief overview of the process used to create an application using the RSBatch ActiveX Controls Library. Only selected examples of code are provided. ActiveX controls can be used to: Create a custom interface Filter sensitive information to the operator Send data to the RSBatch Server Receive data from the RSBatch Server ActiveX Batch Control Example The ActiveX Batch Control Example employs both the ControlRecipeList control and the PromptsList control (not visible), allowing you to command a batch and acknowledge prompts. ActiveX Batch Control Example interface The ActiveX Batch Control Example s interface is based on the Batch List View window of the RSBatch View. It is centered on the ControlRecipeList control and features an assortment of command buttons which allow the operator to interact with the Batch Server to create and control batches. 167

168 The ActiveX Batch Control Example consists of the following components: Batch List window The Batch List window displays data relating to all current batches. Batches remain within the Batch List window until removed by the operator or until the RSBatch Server is re-started with a Cold Boot. The Batch List window includes a horizontal scroll bar that can be used to access batch data that extends beyond the viewable width of the window. The columns included are: Batch ID: The user-entered identification of the batch. Recipe: The name of the master recipe from which the batch was created : The description of the master recipe. Start Time: The time the batch was started. Elapsed Time: The elapsed time measured from the start time, updated after completion of a phase. State: The current state of the batch. Mode: The current mode of the batch. Failure: The failure information for the batch. Process Cell: The name of the process cell in which the batch is running. Units in Use: The current units in use by the batch. Phases In Use: The phases that are currently running in the context of the batch. 168 RSBatch ActiveX Controls Library Reference Guide