Utility Class Methods

The CloseIPForm() method closes the specified dialog.

The ConvertStringToEnum() method converts the supplied string to an enumeration value. Enumeration values are case-sensitive. If the supplied enumeration string does not match any of the existing enumeration values, a null value is returned.

The FindButtonBar() method searches for the named button bar on the top level container or .NET form.

The FormatDuration() method converts the passed duration value in seconds into the hhh:mm:ss format.

The GetAutoLoginUserID() method retrieves the user ID of the user to be automatically logged on, if any, from the configuration file.

The GetAutoLoginUserPw() method retrieves the password of the user to be automatically logged on, if any such user exists, from the configuration file.

The GetAutoLoginEntId() method retrieves the single entity that should be logged onto automatically, if any, from the configuration file. If multiple entities are to be logged onto automatically, this method retrieves the first in the list.

The GetAutoLogonEntIds() method retrieves the list of entities that should be logged onto automatically, if any, from the configuration file.

The GetCodeColor() method retrieves the color value from the "color" field of the specified database table name, field name of an integer field in that table, and integer value for that field.

The GetItemGrade() method retrieves the associated item grade and color for the specified item reason code.

The GetListIndex() method performs a search through all items in a combo box for a specified item.

The GetOperEntLinkData() method retrieves the requested rows from the Oper_Ent_Link table that links operations to entities. The returned rows can be filtered by the process ID, the operation ID, and the entity ID.

The GetStringFromConfigFile() method retrieves the entry from the configuration file that is specified by the configKey parameter.

The GetTopLevelForm() method searches for the form that contains the specified control. Once the form is found, the method returns the form as a control.

The GetTopLevelFormName() method searches for the form that contains the specified control. Once the form is found, the method returns the name of that form.

The InspectCurrentUserPassword() method opens a dialog to allow a current user to enter password for verification .

This overload of the method opens an frmVerifyCurrentUserCredentials dialog that does not contain a Notes text box.

The InspectorLogin() method opens a dialog to allow an inspector to log on.

The ItemIDorDesc() method returns the item ID for a given item description, or the item description for a given item ID.

The LaunchExternalApplication() method launches the specified application. It takes a string that contains the external program to execute, along with any parameters to be passed. If a parameter is preceded by an @ symbol, it is assumed to be global; otherwise, the parameter is added to the command line as a literal string. If parameters are passed, they must be separated by commas and cannot have a space either before or after them. Literals must also be separated from parameters by commas.

The LaunchStepDocument() method finds the viewer of the specified document based on its specified type, and then runs the viewer, passing it the path to the document.

The OpenIPForm() method modally opens the specified dialog.

The PadDuration() method pads an elapsed time value in the hhh:mm:ss format with leading zeros where necessary.

The ParseDuration() method parses out and returns the hours, minutes, and seconds of a duration specified in the hhh:mm:ss format (with or without leading zeros) as separate integer values.

The ParseNameAndArgs() method takes a string that contains a name (that is, an external program or form name) and any arguments to be passed and parses out and returns the name and arguments. If a parameter is preceded by an @ symbol, it assumed to be global; otherwise, the parameter is assumed to be part of the current grid row. If a parameter is not found, it is added to the command line as a literal string.

If parameters are included, they must be separated by commas and cannot have a space either before or after them. Literals must also be separated from parameters by commas.

The PopupContextMenu() method uses the PopupMenu class to display a context menu based on the array of strings passed to it.

The PopupDateTimeEntry() method opens a DateTime entry dialog, which supports an empty date and time (for example, for a Filter dialog). This dialog supports touch screen entry. Note that the "parent" control should be a TextBox, not a DateTimePicker control.

This overload of the PopupDurationEntry() method opens a duration entry dialog, which allows a duration in hours, minutes, and seconds to be entered. Minutes and seconds are limited to the range 0 - 59. The maximum allowable value for hours (for example, 9999) must be specified. This dialog supports touch screen entry. Note that the parent control should be a TextBox, not a DateTimePicker control. The control's Text property is set to the entered duration in hhh:mm:ss format.

The PopupEntitySelection() method opens the Entity dialog, which allows entities to be selected based on a specified capability.

For this overload of the method:

• All entities in the entity tree can be seen, but only entities with the specified capability can be selected.
• A flag specifies whether multiple entities can be selected.
• One entity can be singled out to be unselectable even if the entity has the specified capability.

The PopupHideControlsForm() method opens the Hide Controls dialog. This allows a user to configure, at run-time, which controls are hidden or shown.

This overload saves changes to the Ui_Config table.

The PopupHideTabsForm() method opens the Hide Tabs dialog. This allows a user to configure, at run-time, which tabs are hidden or shown.

The PopupItemReasonSelection() method opens an Item Reason Selection dialog. This dialog displays a list of Reason Groups on the left and the specific Reasons associated with the selected group on the right.

This overload of the method allows the item reasons to be filtered by item ID, entity, and/or only rejected reasons.

The PopupKeyboard() method displays the Virtual Keyboard dialog, which allows a user to enter an arbitrary sequence of characters without using an actual keyboard.

The PopupKeyboard() method displays the Virtual Keypad dialog. This dialog provides for numerical entry via a touch screen. This overload of the method returns the keypad entry as DialogResult.

The PopupLotAttributes() method opens a dialog to allow the user to view or edit the lot attributes of the specified item/lot number combination.

This overload of the method includes a flag that allows the attributes to only be viewed.

The PopupNotesDlg() method displays the Notes dialog to allow viewing and editing of work order, job, item and folders notes.

The PopupOperationSelection() method opens an operation selection dialog. This dialog displays a list of operations that match the specified pattern. The selected operation (the oper_ID) is placed into the specified control.

The PopupUtilReasonSelection() method opens a Utilization Reason Selection dialog. This dialog displays a list of Reason Groups on the left and the specific Reasons associated with the selected group on the right.

The PopupWorkOrderSelection() method opens a Work Order Selection dialog. This dialog, given a search pattern, displays a list of work orders that match the pattern. The selected work order is placed into the specified control.

The ResizeWindowBasedOnFont() method resizes the specified dialog based on the ratio of the size of the font originally used to the new font size.

The SetFont() method recursively descends through all the controls contained by the control passed in and sets the font to the value specified.

The SetTextFromKeyPad() method accepts a text box control and a keypad value as a string. It inserts the keypad value string into the proper place in the control or removes the proper text if a "<--" character is passed. This method pays attention to the selected text and makes sure that the cursor is positioned in the proper place.

The ShowHelpFile() methods opens the Help file.

The ShowJobFlowDiagram() method shows the Job Flow Diagram for the specified work order.

The TranslateForm() method recursively descends through all the controls contained within the specified control and translates all the displayed language strings (for example, translates all translatable strings in the controls' Text property). A translatable string is a string with "nnn" within angle brackets appended, where nnn is the string_ID from the Language table.

In this overload of the method, the language of the current user is used as the target language.