Altium Designer Documentation

Scripting Instrument Controls in Altium Designer

Created: January 9, 2020 | Updated: September 24, 2021

Parent page: Component Categories

The Tool Palette's Instrument Controls tab contains components (controls) that are used to design an Altium Designer Custom Instrument panel GUI. These controls are specifically for use with the Custom Instrument.

While instrument controls are available for use in Altium Designer's scripting environment, note that support of FPGA designs within which signals can be monitored and controlled with custom instruments are not supported in Altium Designer starting from version 18.0.

► See Custom Instrument GUI - Available Instrument Controls for a functional description of each Instrument Control.

To view the associated Properties and Events for an Instrument Control component placed on a script Form, use the Properties or Events tab in the Object Inspector panel (View » Panels » Object Inspector).

To find a particular Method (or Property) for an Instrument Control, use the Code Completion feature (see Script Editor Tools). For example, by typing TInstrumentCheckBox.get the Code Completion window will show a suitably filtered list of methods and properties for TInstrumentCheckBox component. Use Ctrl+Space to manually instigate the Code Completion window.

Use the Code Completion (Ctrl+Space) feature to see the available Methods or Properties for a component.
Use the Code Completion (Ctrl+Space) feature to see the available Methods or Properties for a component.

Inheritance

The majority of Instrument Control classes inherit their Methods (and Properties and Events) from the Delphi VCL TGraphicControl or TCustomControl base classes. Therefore the Instrument Control methods covered here are in addition to one of those base classes, as noted in each entry reference.

By way of example, the descending inheritance for the TInstrumentCheckBox control is as follows:

Inheritance path Methods
TGraphicControl See the matching Delphi reference.
    TCustomInstrumentCheckBox See the TXPCheckBox entry below.
        TInstrumentCheckBox See the TXPCheckBox entry below.

Component Methods

The Altium Instrument Control components are based on core classes from the Embarcadero Visual Component Library (VCL). Each Instrument Control inherits the methods, properties and events from its VCL source, and most offer additional custom methods. For example, both the TInstrumentCheckBox component and the standard TCheckBox component offer the Click method, whereas the TInstrumentCheckBox component also provides the Changed method.

Use the following list to navigate to information on the methods available for each component in the Instrument Controls category:

TSignalLinkManager Instrument signal linking manager.
TInstrumentBackgroundPanel Instrument panel background color.
TInstrumentBackground Instrument background color.
TInstrumentButton Instrument push button.
TInstrumentCaption Instrument panel caption.
TInstrumentCheckBox Instrument check box.
TInstrumentEdit Instrument edit box.
TInstrumentGauge Analog style instrument gauge/meter.
TInstrumentGlyphButton Instrument speed button graphic image.
TInstrumentGraph Instrument graph display.
TInstrumentKnob Instrument rotary control knob.
TInstrumentLabel Instrument panel label.
TInstrumentLEDDigits 7-segment digital LED display.
TInstrumentLEDsPanel Grouped LED indicator row.
TInstrumentMultiGraph Multiple trace graph display.
TInstrumentNumericPanel Instrument numeric readout.
TInstrumentPanel Instrument panel area.
TInstrumentProgressBar LED bar signal/progress indicator
TInstrumentRadioButton Instrument radio button selector.
TInstrumentRadioGroup Instrument group control for radio buttons.
TInstrumentScrollbar Instrument scroll bar control.
TInstrumentShape Instrument panel geometric shape.
TInstrumentSilkScreen Instrument panel silk screen overlay.
TInstrumentTerminal Instrument character display terminal window.
TInstrumentTrackBar Instrument slider bar control.

TSignalLinkManager

TSignalLinkManager inherits its methods from the base TComponent class. The TSignalLinkManager class provides the following additional methods:

TSignalLinkManager:
Procedure DoPoll;
Procedure ClearSignalLinks;
Procedure UpdateSignals(AInput, AOutput : LongBool);

TInstrumentBackgroundPanel

TInstrumentBackgroundPanel inherits its methods from the base TCustomControl class. The TXPCustomControl, TXPCustomExtPanel and TCustomInstrumentBackgroundPanel classes provide the following additional methods:

TXPCustomControl:
Procedure UpdateSmoothDraw;
Function  GetModified : Boolean;
Procedure ClearModified;

TXPCustomExtPanel:
Function  GetDrawingMode : TXPDrawingMode;
Function  UseRegion      : Boolean;
Function  DoCreateRegion : HRGN;
Procedure BeginUpdate;
Procedure EndUpdate;

TCustomInstrumentBackgroundPanel:
Procedure UpdateBackgroundImage;
Procedure UpdateChildControls;

TInstrumentBackground

TInstrumentBackground inherits its methods from the base TGraphicControl class. The TCustomGraphicInstrumentWithBackground and TCustomGraphicInstrumentWithInterior classes provide the following additional methods:

TCustomGraphicInstrumentWithBackground:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;

TCustomGraphicInstrumentWithInterior:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;
Procedure DoPaint(ACanvas : TCanvas; X : Integer = 0; Y : Integer = 0);
Procedure PaintInterior(ACanvas : TCanvas; ARect : TRect);
Function  UseCreamBackground : Boolean;

TInstrumentButton

TInstrumentButton inherits its methods from the base TCustomControl class. The TXPCustomControl, TXPCustomTransparentControl, TXPBaseCustomSpeedButton, TXPCustomSpeedButton and TCustomInstrumentButton classes provide the following additional methods:

TXPCustomControl:
Procedure UpdateSmoothDraw;
Function  GetModified : Boolean;
Procedure ClearModified;

TXPCustomTransparentControl:
Procedure TransparentChanged;

TXPBaseCustomSpeedButton:
Function  GetShiftContentIfPressed : Boolean;
Procedure VCLClick;
Procedure PaintStandard    (ARect,ARectDrop : TRect; APushed : Boolean);
Procedure PaintFading      (Const ARectDrop : TRect; APushed : Boolean);
Procedure DrawImage        (Canvas : TCanvas; Const ARect : TRect; AEnabled : Boolean);
Procedure DrawFadingImage  (Canvas : TCanvas; Const ARect : TRect);
Procedure CopyToImage      (AlphaImage : TAlphaBitmap);
Procedure RedrawImage      (Const ARect : TRect);
Procedure RedrawCaption    (Const ARect : TRect; Const ACaption : String; AFontColor : TColor);
Procedure RedrawInside     (ARect : TRect; AFontColor : TColor; DoFontFading : Boolean);
Procedure CalculatePositions(Const ARect : TRect; Out TotalSize : TPoint; Out GlyphPos : TPoint; Out TextBounds : TRect);
Function  NeedPaintDropdown    : Boolean;
Function  PushOnClick          : Boolean;
Function  GetDrawCaptionFlags  : TXPDrawCaptionFlags;
Function  GetEllipsisPosition  : TEllipsisPosition;
Function  GetFadingEnabled     : Boolean;
Function  GetGlyphSize(Out GlyphSize : TSize) : Boolean;
Procedure UpdateExclusive;
Procedure AppearanceChanged(AChange : TAppearanceChange);
Procedure KindChanged;

TXPCustomSpeedButton:
Procedure GlyphChanged   (Sender : TObject);
Procedure GetGlyphInfo   (Out GlyphToDraw : TGraphic; Out NumGlyphsToDraw : Integer);
Function  GetImageState : Integer;

TCustomInstrumentButton:
Function  GetCaptionFontColor(ADown, AOn : Boolean) : TColor;
Function  GetDrawFlags       (ADown, AOn : Boolean) : TDrawInstrumentButtonFlags;
Function  GetDrawCaptionStyle(ADown, AOn : Boolean) : TDrawInstrumentButtonCaptionStyle;
Function  GetGlowIntensity : TGlowIntensity;
Procedure BackgroundChanged(Sender : TObject);
Procedure UpdateBitmaps;

TInstrumentCaption

TInstrumentCaption inherits its methods from the base TCustomLabel class. The TCustomInstrumentLabel class provides the following additional method:

TCustomInstrumentLabel:
Procedure DoPaint(ACanvas : TCanvas; Const ARect : TRect);

TInstrumentCheckBox

TInstrumentCheckBox inherits its methods from the base TGraphicControl class. The TCustomInstrumentCheckBox class provides the following additional method:

TCustomInstrumentCheckBox:
Procedure Changed;

TInstrumentEdit

TInstrumentEdit inherits its methods from the base TCustomControl class. The TXPCustomControl and TCustomXPEdit classes provide the following additional methods:

TXPCustomControl:
Procedure UpdateSmoothDraw;
Function GetModified : Boolean;
Procedure ClearModified;

TCustomXPEdit:
Function  CalcInternalHeight : Integer;
Procedure Change;
Procedure ChangeHotFont(IsHot : Boolean);
Procedure Clear;
Procedure ClearSelection;
Procedure ClearUndo;
Procedure CopyToClipboard;
Procedure CreateCaret;
Procedure CutToClipboard;
Procedure DestroyCaret;
Procedure DoEndCapture;
Procedure DrawInside(ARect : TRect; AColor, AFrameColor, AHLTextColor, AHLColor, AFontColor : TColor);
Function  GetAutoWidth : Integer;
Function  GetCursorPos : TPoint;
Function  GetEditDetails : TThemedElementDetails;
Function  GetEditorBounds : TRect;
Function  GetEditState : TThemedEdit;
Function  GetExcludeRect : TRect;
Procedure InsertString(Str : TXPString);
Procedure InternalSetCursor;
Procedure NumberFormatChanged;
Procedure SelectAll;
Procedure SetCaretPos(Value : Integer);
Procedure SetText       (Const Value : TCaption);
Procedure SetTransparent(Const Value : Boolean);
Procedure Undo;

TInstrumentGauge

TInstrumentGauge inherits its methods from the base TGraphicControl class. The TCustomGraphicInstrumentWithBackground, TCustomGraphicInstrumentWithNoise and TCustomInstrumentGauge classes provide the following additional methods:

TCustomGraphicInstrumentWithBackground:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;

TCustomGraphicInstrumentWithNoise:
Procedure PaintOnPanel(APanel : TCustomInstrumentBackgroundPanel);
Procedure PaintControlBackground(ABitmap : TBitmap; X, Y : Integer);
Procedure PaintControlForeground(ABitmap : TBitmap; X, Y : Integer);

TCustomInstrumentGauge:
Procedure SetMax(Const Value : TProgressValue);
Procedure SetMin(Const Value : TProgressValue);
Procedure DoGetScaleLabel(AValue : TGaugeValue; Var ALabelString : String);

TInstrumentGlyphButton

TInstrumentGlyphButton inherits its methods from the base TCustomControl class. The TXPCustomControl, TXPCustomTransparentControl, TXPBaseCustomSpeedButton, TXPCustomSpeedButton, TCustomInstrumentButton and TCustomInstrumentGlyphButton classes provide the following additional methods:

TXPCustomControl:
Procedure UpdateSmoothDraw;
Function  GetModified : Boolean;
Procedure ClearModified;

TXPCustomTransparentControl:
Procedure TransparentChanged;

TXPBaseCustomSpeedButton:
Function  GetShiftContentIfPressed : Boolean;
Procedure VCLClick;
Procedure PaintStandard    (ARect,ARectDrop : TRect; APushed : Boolean);
Procedure PaintFading      (Const ARectDrop : TRect; APushed : Boolean);
Procedure DrawImage        (Canvas : TCanvas; Const ARect : TRect; AEnabled : Boolean);
Procedure DrawFadingImage  (Canvas : TCanvas; Const ARect : TRect);
Procedure CopyToImage      (AlphaImage : TAlphaBitmap);
Procedure RedrawImage      (Const ARect : TRect);
Procedure RedrawCaption    (Const ARect : TRect; Const ACaption : String; AFontColor : TColor);
Procedure RedrawInside     (ARect : TRect; AFontColor : TColor; DoFontFading : Boolean);
Procedure CalculatePositions(Const ARect : TRect; Out TotalSize : TPoint; Out GlyphPos : TPoint; Out TextBounds : TRect);
Function  NeedPaintDropdown    : Boolean;
Function  PushOnClick          : Boolean;
Function  GetDrawCaptionFlags  : TXPDrawCaptionFlags;
Function  GetEllipsisPosition  : TEllipsisPosition;
Function  GetFadingEnabled     : Boolean;
Function  GetGlyphSize(Out GlyphSize : TSize) : Boolean;
Procedure UpdateExclusive;
Procedure AppearanceChanged(AChange : TAppearanceChange);
Procedure KindChanged;

TXPCustomSpeedButton:
Procedure GlyphChanged   (Sender : TObject);
Procedure GetGlyphInfo   (Out GlyphToDraw : TGraphic; Out NumGlyphsToDraw : Integer);
Function  GetImageState : Integer;

TCustomInstrumentButton:
Function  GetCaptionFontColor(ADown, AOn : Boolean) : TColor;
Function  GetDrawFlags       (ADown, AOn : Boolean) : TDrawInstrumentButtonFlags;
Function  GetDrawCaptionStyle(ADown, AOn : Boolean) : TDrawInstrumentButtonCaptionStyle;
Function  GetGlowIntensity : TGlowIntensity;
Procedure BackgroundChanged(Sender : TObject);
Procedure UpdateBitmaps;

TCustomInstrumentGlyphButton:
Procedure LEDChanged;

TInstrumentGraph

TCustomInstrumentGraph inherits its methods from the base TGraphicControl class. The TCustomGraphicInstrumentWithBackground, TCustomGraphicInstrumentWithInterior and TCustomInstrumentGraph classes provide the following additional methods:

TCustomGraphicInstrumentWithBackground:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;

TCustomGraphicInstrumentWithInterior:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;
Procedure DoPaint(ACanvas : TCanvas; X : Integer = 0; Y : Integer = 0);
Procedure PaintInterior(ACanvas : TCanvas; ARect : TRect);
Function  UseCreamBackground : Boolean;

TCustomInstrumentGraph:
Procedure SetMax(Const Value : TProgressValue);
Procedure SetMin(Const Value : TProgressValue);
Procedure DoGetValue(Var AValue : TGraphValue; AIndex : Integer);
Procedure BeginSetValues;
Procedure EndSetValues;

TInstrumentKnob

TInstrumentKnob inherits its methods from the base TCustomControl class. The TXPCustomControl and TCustomInstrumentSlider classes provide the following additional methods:

TXPCustomControl:
Procedure UpdateSmoothDraw;
Function  GetModified : Boolean;
Procedure ClearModified;

TCustomInstrumentSlider:
Procedure SetHandleSize(AValue : TInstrumentSize);
Procedure SetMinValue(AValue : Double);
Procedure SetMaxValue(AValue : Double);
Procedure DrawSlot   (ACanvas : TCanvas; xOffset, yOffset : Integer);
Procedure DrawTick   (ACanvas : TCanvas; xOffset, yOffset : Integer; ATicks : TInstrumentTicksFloat; ATickValue : Double; AGraphics : Pointer; APen : Pointer;
Procedure DrawNumber (ACanvas : TCanvas; xOffset, yOffset : Integer; ANumberValue : Double; Const ANumberStr : String);
Procedure DrawHandle (ACanvas : TCanvas; xOffset, yOffset : Integer);
Function  GetPositionFromMouse(X, Y : Integer) : Double;
Function  GetToolTipReferenceRect : TRect;
Procedure DoGetHintText  (AValue : Double; Var AHintText : String);
Procedure DoGetScaleLabel(AValue : Double; Side : TInstrumentSide; Var ALabelString : String);

TInstrumentLabel

TInstrumentLabel inherits its methods from the base TCustomLabel class. The TCustomInstrumentLabel class provides the following additional method:

TInstrumentLabel:
Procedure DoPaint(ACanvas : TCanvas; Const ARect : TRect);

TInstrumentLEDDigits

TInstrumentLEDDigits inherits its methods from the base TGraphicControl class. The TCustomGraphicInstrumentWithBackground, TCustomGraphicInstrumentWithInterior,
TCustomInstrumentDigitsPanel and TCustomInstrumentLEDDigits classes provide the following additional methods:

TCustomGraphicInstrumentWithBackground:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;

TCustomGraphicInstrumentWithInterior:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;
Procedure DoPaint(ACanvas : TCanvas; X : Integer = 0; Y : Integer = 0);
Procedure PaintInterior(ACanvas : TCanvas; ARect : TRect);
Function  UseCreamBackground : Boolean;

TCustomInstrumentDigitsPanel:
Procedure SetDigits       (Const AValue : NaturalNumber);
Procedure SetDigitsInGroup(Const AValue : NaturalNumber);
Procedure SetNumberType   (Const AValue : TNumberType);
Procedure SetPrecision    (Const AValue : TPrecision);
Procedure SetRadix        (Const AValue : TRadix);
Procedure DigitClick      (ADigitIndex : Integer; AButton : TMouseButton);
Function  GetDigitWidth  : Integer;
Function  GetDigitHeight : Integer;
Procedure PaintDigits     (ACanvas : TCanvas; ARect : TRect);
Procedure PaintDigit      (ACanvas : TCanvas; ARect : TRect; AValue : Byte);
Procedure ValueChanged;

TCustomInstrumentLEDDigits:
Procedure SetMax(Const Value : TProgressValue);
Procedure SetMin(Const Value : TProgressValue);

TInstrumentLEDsPanel

TInstrumentLEDsPanel inherits its methods from the base TGraphicControl class. The TCustomGraphicInstrumentWithBackground, TCustomGraphicInstrumentWithInterior,
TCustomInstrumentDigitsPanel and TCustomInstrumentLEDsPanel classes provide the following additional methods:

TCustomGraphicInstrumentWithBackground:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;

TCustomGraphicInstrumentWithInterior:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;
Procedure DoPaint(ACanvas : TCanvas; X : Integer = 0; Y : Integer = 0);
Procedure PaintInterior(ACanvas : TCanvas; ARect : TRect);
Function  UseCreamBackground : Boolean;

TCustomInstrumentDigitsPanel:
Procedure SetDigits       (Const AValue : NaturalNumber);
Procedure SetDigitsInGroup(Const AValue : NaturalNumber);
Procedure SetNumberType   (Const AValue : TNumberType);
Procedure SetPrecision    (Const AValue : TPrecision);
Procedure SetRadix        (Const AValue : TRadix);
Procedure DigitClick      (ADigitIndex : Integer; AButton : TMouseButton);
Function  GetDigitWidth  : Integer;
Function  GetDigitHeight : Integer;
Procedure PaintDigits     (ACanvas : TCanvas; ARect : TRect);
Procedure PaintDigit      (ACanvas : TCanvas; ARect : TRect; AValue : Byte);
Procedure ValueChanged;

TCustomInstrumentLEDsPanel:
Procedure SetMaxValue(Const AValue : LongWord);
Procedure SetMinValue(Const AValue : LongWord);

TInstrumentMultiGraph

TInstrumentMultiGraph inherits its methods from the base TGraphicControl class. The TCustomGraphicInstrumentWithBackground, TCustomGraphicInstrumentWithInterior and TCustomInstrumentGraph classes provide the following additional methods:

TCustomGraphicInstrumentWithBackground:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;

TCustomGraphicInstrumentWithInterior:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;
Procedure DoPaint(ACanvas : TCanvas; X : Integer = 0; Y : Integer = 0);
Procedure PaintInterior(ACanvas : TCanvas; ARect : TRect);
Function  UseCreamBackground : Boolean;

TCustomInstrumentGraph:
Procedure SetMax(Const Value : TProgressValue);
Procedure SetMin(Const Value : TProgressValue);
Procedure DoGetValue(Var AValue : TGraphValue; AIndex : Integer);
Procedure BeginSetValues;
Procedure EndSetValues;

TInstrumentNumericPanel

TInstrumentNumericPanel inherits its methods from the base TGraphicControl class. The TCustomGraphicInstrumentWithBackground, TCustomGraphicInstrumentWithInterior,
TCustomInstrumentDigitsPanel and TCustomInstrumentNumericPanel classes provide the following additional methods:

TCustomGraphicInstrumentWithBackground:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;

TCustomGraphicInstrumentWithInterior:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;
Procedure DoPaint(ACanvas : TCanvas; X : Integer = 0; Y : Integer = 0);
Procedure PaintInterior(ACanvas : TCanvas; ARect : TRect);
Function  UseCreamBackground : Boolean;

TCustomInstrumentDigitsPanel:
Procedure SetDigits       (Const AValue : NaturalNumber);
Procedure SetDigitsInGroup(Const AValue : NaturalNumber);
Procedure SetNumberType   (Const AValue : TNumberType);
Procedure SetPrecision    (Const AValue : TPrecision);
Procedure SetRadix        (Const AValue : TRadix);
Procedure DigitClick      (ADigitIndex : Integer; AButton : TMouseButton);
Function  GetDigitWidth  : Integer;
Function  GetDigitHeight : Integer;
Procedure PaintDigits     (ACanvas : TCanvas; ARect : TRect);
Procedure PaintDigit      (ACanvas : TCanvas; ARect : TRect; AValue : Byte);
Procedure ValueChanged;

TCustomInstrumentNumericPanel:
Procedure SetMaxValue(Const AValue : TNumericValue);
Procedure SetMinValue(Const AValue : TNumericValue);

TInstrumentPanel

TInstrumentPanel inherits its methods from the base TCustomControl class. The TXPCustomControl and TCustomInstrumentPanel classes provide the following additional methods:

TXPCustomControl:
Procedure UpdateSmoothDraw;
Function  GetModified : Boolean;
Procedure ClearModified;

TCustomInstrumentPanel:
Procedure PaintOnPanel(APanel : TCustomInstrumentBackgroundPanel);

TInstrumentProgressBar

TInstrumentProgressBar inherits its methods from the base TGraphicControl class. The TCustomGraphicInstrumentWithBackgroundTCustomGraphicInstrumentWithNoise and TCustomInstrumentProgressBar classes provide the following additional methods:

TCustomGraphicInstrumentWithBackground:
Procedure BackgroundOptionsChanged(AChanges : TInstrumentBackgroundOptions);
Procedure MarginChanged;

TCustomGraphicInstrumentWithNoise:
Procedure PaintOnPanel(APanel : TCustomInstrumentBackgroundPanel);
Procedure PaintControlBackground(ABitmap : TBitmap; X, Y : Integer);
Procedure PaintControlForeground(ABitmap : TBitmap; X, Y : Integer);

TCustomInstrumentProgressBar:
Procedure SetMax(Const Value : TProgressValue);
Procedure SetMin(Const Value : TProgressValue);

TInstrumentRadioButton

TInstrumentRadioButton inherits its methods from the base TGraphicControl class. The TCustomInstrumentCheckBox and TCustomInstrumentRadioButton classes provide the following additional methods:

TCustomInstrumentCheckBox:
Procedure Changed;

TCustomInstrumentRadioButton:
Procedure TurnSiblingsOff;

TInstrumentRadioGroup

TInstrumentRadioGroup inherits its methods from the base TCustomControl class. The TXPCustomControl and TCustomInstrumentPanel classes provide the following additional methods:

TXPCustomControl:
Procedure UpdateSmoothDraw;
Function  GetModified : Boolean;
Procedure ClearModified;

TCustomInstrumentPanel:
Procedure PaintOnPanel(APanel : TCustomInstrumentBackgroundPanel);

TInstrumentScrollbar

TInstrumentScrollbar inherits its methods from the base TCustomControl class. The TXPCustomControl, TCustomXPScrollBar and TCustomInstrumentScrollBar classes provide the following additional methods:

TXPCustomControl:
Procedure UpdateSmoothDraw;
Function  GetModified : Boolean;
Procedure ClearModified;

TCustomXPScrollBar:
Procedure Change;
Procedure Scroll(ScrollCode : TScrollCode; Var ScrollPos : Integer);
Function  IgnoreThemePainting : Boolean;
Procedure DrawShaft   (Const ARect : TRect; AState : Integer);
Procedure DrawArrowBtn(Const ARect : TRect; AState : Integer; AOffset : Integer; AIsUp : Boolean);
Procedure DrawThumb   (Const ARect : TRect; AState : Integer);
Procedure SetParams   (APosition, AMin, AMax : Integer);

TCustomInstrumentScrollBar:
Procedure SetBounds(ALeft, ATop, AWidth, AHeight : Integer);

TInstrumentShape

TInstrumentShape inherits its methods from the base TShape component class.

TInstrumentSilkScreen

TInstrumentSilkScreen inherits its methods from the base TCustomControl class. The TXPCustomControl class provides the following additional methods:

TXPCustomControl:
Procedure UpdateSmoothDraw;
Function  GetModified : Boolean;
Procedure ClearModified;

TInstrumentTerminal

TInstrumentTerminal inherits its methods from the base TCustomControl class. The TXPCustomControlTCustomInstrumentPanel and TCustomInstrumentTerminal classes provide the following additional methods:

TXPCustomControl:
Procedure UpdateSmoothDraw;
Function  GetModified : Boolean;
Procedure ClearModified;

TCustomInstrumentPanel:
Procedure PaintOnPanel(APanel : TCustomInstrumentBackgroundPanel);

TCustomInstrumentTerminal:
Procedure DoTransmitChar(AChar : Char);
Procedure PutChar(AChar : Char ; ATransmit : Boolean);
Procedure PutString(Const AString : String; ATransmit : Boolean);
Procedure Clear;
Procedure GetLines(ALines : TStrings);

TInstrumentTrackBar

TInstrumentTrackBar inherits its methods from the base TCustomControl class. The TXPCustomControl and TCustomInstrumentSlider classes provide the following additional methods:

TXPCustomControl:
Procedure UpdateSmoothDraw;
Function  GetModified : Boolean;
Procedure ClearModified;

TCustomInstrumentSlider:
Procedure SetHandleSize(AValue : TInstrumentSize);
Procedure SetMinValue(AValue : Double);
Procedure SetMaxValue(AValue : Double);
Procedure DrawSlot   (ACanvas : TCanvas; xOffset, yOffset : Integer);
Procedure DrawTick   (ACanvas : TCanvas; xOffset, yOffset : Integer; ATicks : TInstrumentTicksFloat; ATickValue : Double; AGraphics : Pointer; APen : Pointer;
Procedure DrawNumber (ACanvas : TCanvas; xOffset, yOffset : Integer; ANumberValue : Double; Const ANumberStr : String);
Procedure DrawHandle (ACanvas : TCanvas; xOffset, yOffset : Integer);
Function  GetPositionFromMouse(X, Y : Integer) : Double;
Function  GetToolTipReferenceRect : TRect;
Procedure DoGetHintText  (AValue : Double; Var AHintText : String);
Procedure DoGetScaleLabel(AValue : Double; Side : TInstrumentSide; Var ALabelString : String)
Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: