About the naming of form controls
Ensure that you use meaningful nomenclature for the Control name property of any button controls and for controls that allow form users to enter or edit values. The software uses the Control name property when logging changes in the VWorks Main Log and if an audit trail of changes is logged for the form. Control name versus Caption property
Form controls have the following nomenclature properties:
• Control name property. The descriptive name associated with the control. Every control has the Control name property.
Although the Control name does not appear on the form, it does appear in events logged in the Main Log and audit trail reports.
• Caption property. The label for a given control. The Caption appears on the form. A subset of controls have the Caption property, such as the Pushbutton and Checkbox controls and the Specialized Buttons. You can use a Static text control to provide a label for a control that does not have the Caption property.
Nomenclature guidelines for Control name property
By default, the software uses a generic name and a sequential number to assign the Control name property. So, multiple instances of a given control use the following naming convention:
genericName1, genericName2, genericName 3, and so forth
The following table lists the default value and some descriptive alternatives for multiple instances of controls on a single form.
Form control | Control name property | |
|---|---|---|
Default value | Descriptive examples | |
Edit control | operatorConsoleTextBox1 operatorConsoleTextBox2 operatorConsoleTextBox3 operatorConsoleTextBox4 | AspirateVolume DispenseVolume MixCycles NumberOfRuns |
Pushbutton | operatorConsoleButton operatorConsoleButton2 operatorConsoleButton3 operatorConsoleButton4 | Method_Load_Button Method_Save_Button ClearAll Button LiteraturePage_Button |
Run Protocol | runProtocol1 runProtocol2 runProtocol3 | RunProtocol_Button RunTipTransfer_Button StartRun_Button |
As the examples show, the default nomenclature for the Control name property are too generic for the corresponding events captured in the Main Log or logged in an audit report. To ensure that the logged events are recognizable, you should create a set of nomenclature guidelines for the Control name property to ensure that descriptive and meaningful names are used in your forms.
Related information
For information about... | See... |
|---|---|
Audit trails and audit trail reports | |
Workflow for creating or editing a form | |
Controls under General Controls in the Form Designer window | |
Controls under Specialized Buttons in the Form Designer window |