Schematic API Types reference

Created: 5月 13, 2013 | Updated: 3月 06, 2024

Note: The Altium Designer SDK is currently in the Beta phase and therefore evolving along with its documentation. This reference document, derived from the Altium Designer RTL documentation, is a work in progress and includes some aspects that are different to the new SDK.

The enumerated types are used for many of the schematic interfaces methods which are covered in this section.

For example the ISch_Port interface has a ConnectedEnd property which returns a TPortConnectedEnd type. You can use this Enumerated Types section to check what the range is for the TPortConnectedEnd type.

TAngle Copy Link Copied

TAngle = TReal;

TAutoPanStyle Copy Link Copied

TAutoPanStyle = (
eAutoPanOff,
eAutoPanFixedJump,
eAutoPanReCenter
);

TCrossSheetConnectorStyle Copy Link Copied

TCrossSheetConnectorStyle = (
eCrossSheetLeft,
eCrossSheetRight
);

TCoordRect Copy Link Copied

TCoordRect = Record
Case Integer of
0 :(left, bottom, right, top : TCoord);
1 :(x1, y1, x2, y2 : TCoord);
2 :(Location1, Location2 : TLocation);
End;

TCoord Copy Link Copied

TCoord = Integer;

TConnectivityScope Copy Link Copied

TConnectivityScope = (eConnectivity_ConnectionOnly, eConnectivity_WholeNet);

TConnectionNodeType Copy Link Copied

TConnectionNodeType = (eConnectionNode_IntraSheetLink, eConnectionNode_InterSheetLink, eConnectionNode_Hidden);

TComponentDisplay Copy Link Copied

TComponentDisplay = (
eCompBlock,
eCompDevice,
eCompPower,
eCompSymbol
);

TColor Copy Link Copied

Syntax
TColor = Graphics.TColor;
Notes
The TColor value specifies a 6 digit hexadecimal number of the $FFFFFF format. For example the color blue would be RGB:0,0,255 and Hex:FF0000 therefore the converted decimal value would be 16711680. The following formula may be used to calculate the required value, R+256*(G+(256*B)).
This TColor value is defined from the Graphics Unit of the Borland Delphi's VCL library.

Examples
Color=0 is black, Color=255 is red, Color=65280 is green Color=16711680 is blue Color=16777215 is white. Decimal or hexadecimal values can be assigned.
See also
ISch_Preferences
IComponentPainterView
ISch_GraphicalObject
ISch_TextFrame
ISch_SheetEntry
ISch_HarnessEntry
ISch_Component

TChosenDocumentScope Copy Link Copied

TChosenDocumentScope = (eScope_None, eScope_SingleDocument, eScope_ProjectDocuments, eScope_OpenDocuments);

TCursorMove Copy Link Copied

TCursorMove = (
eCursorLeft,
eCursorRight,
eCursorTop,
eCursorBottom);

TCursorShape Copy Link Copied

TCursorShape = (
eLargeCursor90,
eSmallCursor90,
eSmallCursor45,
eTinyCursor45);

TDistance Copy Link Copied

TDistance = Integer;

TDrawMode Copy Link Copied

TDrawMode = (
eDrawFull,
eDrawDraft,
eDrawHidden);

TDrawQuality Copy Link Copied

TDrawQuality = (eFullQuality,eDraftQuality);

TDynamicStirng Copy Link Copied

TDynamicString = AnsiString;

T FindReplaceIdentifierScope Copy Link Copied

TFindReplaceIdentifierScope = (
eFindReplace_AllIdentifiers,
eFindReplace_NetIdentifiersOnly,
eFindReplace_DesignatorsOnly);

THorizontalAlign Copy Link Copied

THorizontalAlign = (
eHorizontalCentreAlign, // eVerticalCentreAlign
eLeftAlign, // eTopAlign
eRightAlign // eBottomAlign
);

THitTestMode Copy Link Copied

THitTestMode = (
eHitTest_AllObjects,
eHitTest_OnlyAccessible
);

TEditingAction Copy Link Copied

TEditingAction = (eEditAction_DontCare, eEditAction_Move, eEditAction_Change,eEditAction_Delete,eEditAction_Select);

TFontName Copy Link Copied

TFontName = String lf_FaceSize + 1;

TFontID Copy Link Copied

TFontID = Integer;

TFileName Copy Link Copied

TFileName = TString;

TGridPreset Copy Link Copied

TGridPreset = (eDXPPreset, eCoarse2, eCoarse3, eFine2, eFine3, eElectrical);

TIterationDepth Copy Link Copied

TIterationDepth = (eIterateFirstLevel, eIterateFilteredLevels, eIterateAllLevels);

TLeftRightSide Copy Link Copied

TLeftRightSide = (
eLeftSide,
eRightSide,
eTopSide,
eBottomSide
);

TLibraryAutoZoom Copy Link Copied

TLibraryAutoZoom = (lazNoZoomChange, lazRememberLast, lazCenter);

TLibraryScope Copy Link Copied

TLibraryScope = (lsCurrentComponnet, lsAllComponents);

TLineStyle Copy Link Copied

TLineStyle = (
eLineStyleSolid,
eLineStyleDashed,
eLineStyleDotted
);

TMyRect Copy Link Copied

TMyRect = Record
Left,Right,Top, Bottom, Width, Height : Integer;
End;

TObjectCreationMode Copy Link Copied

TObjectCreationMode = (eCreate_Default, eCreate_GlobalCopy);

TObjectSet Copy Link Copied

TObjectSet = Set Of TObjectID;

TOpenBusPortType Copy Link Copied

TOpenBusPortType = (obptUnspecified, obptMaster, obptSlave);

TOpenBusComponentKind Copy Link Copied

TOpenBusComponentKind = (obckProcessor, obckArbiter, obckInterconnect, obckPeripheral, obckMemory, obckConnector, obckTerminator);

TOpenBusPortKind Copy Link Copied

TOpenBusPortKind = (obpkPeripheralMaster, obpkPeripheralSlave,
obpkArbiterMaster , obpkArbiterSlave,
obpkInterconMaster , obpkInterconSlave,
obpkConnectorMaster , obpkConnectorSlave)

TOpenBusInternalPinType Copy Link Copied

TOpenBusInternalPinType = (iptInterrupt, iptReset, iptClock);

TParameter_ReadOnlyState Copy Link Copied

TParameter_ReadOnlyState = (
eReadOnly_None,
eReadOnly_Name,
eReadOnly_Value,
eReadOnly_NameAndValue
);

TParameterType Copy Link Copied

TParameterType = (eParameterType_String,
eParameterType_Boolean,
eParameterType_Integer,
eParameterType_Float);

TPlacementMode Copy Link Copied

TPlacementMode = (ePlacementMode_Single, ePlacementMode_Multiple);

TPolylineCutterMode Copy Link Copied

TPolylineCutterMode = (eCutterSnapToSegment, eCutterGridSize, eCutterFixedLength);

TPortConnectedEnd Copy Link Copied

TPortConnectedEnd = (
ePortConnectedEnd_None,
ePortConnectedEnd_Origin, //connected at port Location
ePortConnectedEnd_Extremity, //connected at the other end
ePortConnectedEnd_Both //connected at both ends
);

TPortIO Copy Link Copied

TPortIO = (
ePortUnspecified,
ePortOutput,
ePortInput,
ePortBidirectional
);

TProbeMethod Copy Link Copied

TProbeMethod = (
eProbeMethodAllNets,
eProbeMethodProbedNetsOnly
);

TRotationBy90 Copy Link Copied

TRotationBy90 =
eRotate0,
eRotate90,
eRotate180,
eRotate270
);

TPrintKind Copy Link Copied

TPrintKind = (ePrintKind_FullColor,ePrintKind_GrayScale,ePrintKind_Monochrome);

TPlacementResult Copy Link Copied

TPlacementResult = (eSingleObjectPlacementProcessAborted,eWholeObjectPlacementAborted, eObjectPlacementSuccessfull);

TReal Copy Link Copied

TReal = Double;

TRectangleStyle Copy Link Copied

TRectangleStyle = (
eRectangleHollow,
eRectangleSolid
);

TSchDropAction Copy Link Copied

TSchDropAction = (eDropAction_None,
eDropAction_AskOpenOrInsertText,
eDropAction_WarnBinaryAsText,
eDropAction_OpenInEditor,
eDropAction_OpenAsText,
eDropAction_Insert);

TSelectionState Copy Link Copied

TSelectionState = (eSelectionState_None,
eSelectionState_FirstSelected,
eSelectionState_MultiSelected,
eSelectionState_VerticesSelected);

TSelectionMatch Copy Link Copied

TypeTSelectionMatch = (
eMatchSelected,
eMatchedNotSelected,
eMatchAnySelection
);

TSheetDocumentBorderStyle Copy Link Copied

TSheetDocumentBorderStyle = (
eSheetStandard,
eSheetAnsi
);

TSheetOrientation Copy Link Copied

TSheetOrientation = (eLandscape, ePortrait);

TShowCutterMarkersMode Copy Link Copied

TShowCutterMarkersMode = (eMarkersNever, eMarkersAlways, eMarkersOnPolyline);

TShowCutterBoxMode Copy Link Copied

TShowCutterBoxMode = (eBoxNever, eBoxAlways, eBoxOnPolyline);

TSide Copy Link Copied

TSide = (
eLeft,
eBottom,
eRight,
eTop
);

TSize Copy Link Copied

TSize = (
eZeroSize,
eSmall,
eMedium,
eLarge
);

TStringIncrementStyle Copy Link Copied

TStringIncrementStyle = (eSIS_None, eSIS_HorizontalFirst, eSIS_VerticalFirst);

TTextHorzAnchor Copy Link Copied

TTextHorzAnchor = (
eTextHorzAnchor_None,
eTextHorzAnchor_Both,
eTextHorzAnchor_Left,
eTextHorzAnchor_Right
);

TTextVertAnchor Copy Link Copied

TTextVertAnchor = (
eTextVertAnchor_None,
eTextVertAnchor_Both,
eTextVertAnchor_Top,
eTextVertAnchor_Bottom
);

TUpperLowerCase Copy Link Copied

TUpperLowerCase = (eUpperCase, eLowerCase, eAnyCase);

TUnit Copy Link Copied

TUnit = (eMil, eMM, eIN, eCM, eDXP, eM, eAutoImperial, eAutoMetric);

TUnitSet Copy Link Copied

TUnitSet = Set Of TUnit;

TUnitSystem Copy Link Copied

TUnitSystem = (eImperial, eMetric);

TVerticalAlign Copy Link Copied

TVerticalAlign = (
eVerticalCentreAlign,
eTopAlign,
eBottomAlign
);

TVisibleGrid Copy Link Copied

TVisibleGrid = (
eDotGrid,
eLineGrid
);

TVHOrientation Copy Link Copied

THVOrientation = (
eHorizontal,
eVertical
);

TWidthArray Copy Link Copied

TWidthArray = Array [TSize] of Integer;

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.

印刷用ページ