Custom Instrument GUI - Available Standard Components

Frozen Content

Table 1 lists all of the standard components available for use when designing the GUI for a Custom Instrument. These are components that are used as standard in scripting and, as such, can all be found on the Tool Palette panel that is used when writing general scripts in Altium Designer.

Table 1. Standard components for use on the instrument form.
Palette Icon
Component Name
Description
Component Type

TActionList

Used to create and maintain a list of actions (event handling code) that can be subsequently 'called' by different components (e.g. pop-up menu entries and buttons) on the instrument panel.
 
Actions are added and maintained using a dedicated editing dialog (accessed by double-clicking on the placed component).

Non-Visual

TBevel

Used to add a beveled outline to the instrument panel. The bevel can appear raised or lowered, by setting its Style property to bsRaised or bsLowered, respectively.

Visual

TImage

Used to display a graphical image on the instrument panel, such as a bitmap, icon, or metafile.

Visual

TImageList

Used to provide a repository in which to store a collection of same-sized images (icons, bitmaps, or metafiles). All images in an image list are contained in a single, wide bitmap in screen device format. An image list may also include a monochrome bitmap that contains masks used to draw images transparently (icon style).
 
Images are added and maintained using a dedicated editing dialog (accessed by double-clicking on the placed component).
 
Images are retrieved via their index (in the range 0 to n-1).

Non-Visual

TPanel

Used to visually group components together on the instrument panel. To maintain the same relative position when the instrument panel is resized, set the component's Align property to alTop.

Visual

TPaintBox

Used to render an image on the instrument panel, which is drawn directly under script control. Typically, you would link the underlying script code (event handler) to this component using the OnPaint event.

Visual

TPopupMenu

Used to define a pop-up menu that appears when the user right-clicks over a particular control on the instrument panel. To make the pop-up menu available for the target control, simply assign the TPopupMenu object to that control's PopupMenu property.

Non-Visual

TShape

Used to draw a geometric shape on the instrument panel.

Visual

TTimer

Used to trigger an event periodically, based on a defined time interval. The code (event handler) in the underlying script is hooked up to the TTimer component's OnTimer event, which is triggered every time the value for the component's Interval property has elapsed.

Non-Visual

TOpenDialog

Used to display a modal Windows dialog for selecting and opening files. The dialog does not appear at runtime until it is activated by a call to the Execute method. When the Open button in the dialog is clicked, the dialog closes and the selected file(s) are stored in the component's FileName property.

Non-Visual

TSaveDialog

Used to display a modal Windows dialog for selecting and saving files. The dialog does not appear at runtime until it is activated by a call to the Execute method. When the Save button in the dialog is clicked, the dialog closes and the selected file(s) are stored in the component's FileName property.

Non-Visual

TFontDialog

Used to display a modal Windows dialog for selecting fonts. The dialog does not appear at runtime until it is activated by a call to the Execute method. When a font is selected and the OK button in the dialog is clicked, the dialog closes and the selected font is stored in the component's Font property.

Non-Visual

TColorDialog

Used to display a modal Windows dialog for selecting colors. The dialog does not appear at runtime until it is activated by a call to the Execute method. When a color is selected and the OK button in the dialog is clicked, the dialog closes and the selected color is stored in the component's Color property.

Non-Visual

TPrintDialog

Used to display a modal Windows dialog for sending jobs to a printer. The dialog does not appear at runtime until it is activated by a call to the Execute method. When print options have been defined and the OK button in the dialog is clicked, the dialog closes and the relevant print job information is stored in the component's corresponding properties.

Non-Visual

TPrinterSetupDialog

Used to display a modal Windows dialog for configuring printers. The dialog does not appear at runtime until it is activated by a call to the Execute method.

Non-Visual

TPageSetupDialog

Used to display a modal Windows dialog for configuring the page. The dialog does not appear at runtime until it is activated by a call to the Execute method. When page options have been defined (such as paper size, orientation and margins) and the OK button in the dialog is clicked, the dialog closes and the relevant information is stored in the component's corresponding properties.

Non-Visual

TFindDialog

Used to display a modeless Windows dialog that prompts the user for a search string. The dialog does not appear at runtime until it is activated by a call to the Execute method. When a string is entered and the OK button in the dialog is clicked, the dialog closes and the entered search text is stored in the component's FindText property.

Non-Visual

TReplaceDialog

Used to display a modeless Windows dialog that prompts the user for a search string and a replace string. The dialog does not appear at runtime until it is activated by a call to the Execute method. When both strings are entered and the OK button in the dialog is clicked, the dialog closes. The entered search text is stored in the component's FindText property. The entered replacement text is stored in the component's ReplaceText property.

Non-Visual

Properties, Events and Methods

Properties and events associated to each component can be viewed on the Properties and Events panels respectively. For more information on the methods supported for each component, refer to the relevant page of the Component Reference.

Additionally, for more detailed information on each of these components, refer to external documentation for the Borland Delphi Visual Component Library.

You are reporting an issue with the following selected text and/or image within the active document: