Schematic API Types
The features available depend on your Altium product access level. Compare features included in the various levels of Altium Designer Software Subscription and functionality delivered through applications provided by the Altium 365 platform.
If you don’t see a discussed feature in your software, contact Altium Sales to find out more.
Parent page: Technical Reference - Schematic API
Schematic API: Enumerated Types Reference Copy Link Copied
The Enumerated Types are used for many of the Schematic Interfaces methods covered in this section. For example the ISch_Port
interface has a ConnectedEnd
property which returns a TPortConnectedEnd
type. You can use the Enumerated Types reference to check the range for the TPortConnectedEnd
type.
The Schematic API Enumerated Types reference includes the following content:
TAngle
TAngle = TReal;
TAutoPanStyle
TAutoPanStyle = (
eAutoPanOff,
eAutoPanFixedJump,
eAutoPanReCenter
);
TCrossSheetConnectorStyle
TCrossSheetConnectorStyle = (
eCrossSheetLeft,
eCrossSheetRight
);
TCoordRect
TCoordRect = Record
Case Integer of
0 :(left, bottom, right, top : TCoord);
1 :(x1, y1, x2, y2 : TCoord);
2 :(Location1, Location2 : TLocation);
End;
TCoord
TCoord = Integer;
TConnectivityScope
TConnectivityScope = (eConnectivity_ConnectionOnly, eConnectivity_WholeNet);
TConnectionNodeType
TConnectionNodeType = (eConnectionNode_IntraSheetLink, eConnectionNode_InterSheetLink, eConnectionNode_Hidden);
TComponentDisplay
TComponentDisplay = (
eCompBlock,
eCompDevice,
eCompPower,
eCompSymbol
);
TColor
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
TChosenDocumentScope = (eScope_None, eScope_SingleDocument, eScope_ProjectDocuments, eScope_OpenDocuments);
TCursorMove
TCursorMove = (
eCursorLeft,
eCursorRight,
eCursorTop,
eCursorBottom);
TCursorShape
TCursorShape = (
eLargeCursor90,
eSmallCursor90,
eSmallCursor45,
eTinyCursor45);
TDistance
TDistance = Integer;
TDrawMode
TDrawMode = (
eDrawFull,
eDrawDraft,
eDrawHidden);
TDrawQuality
TDrawQuality = (eFullQuality,eDraftQuality);
TDynamicStirng
TDynamicString = AnsiString;
TIeeeSymbol
TIeeeSymbol = (
eNoSymbol,
eDot,
eRightLeftSignalFlow,
eClock,
eActiveLowInput,
eAnalogSignalIn,
eNotLogicConnection,
eShiftRight,
ePostPonedOutput,
eOpenCollector,
eHiz,
eHighCurrent,
ePulse,
eSchmitt,
eDelay,
eGroupLine,
eGroupBin,
eActiveLowOutput,
ePiSymbol,
eGreaterEqual,
eLessEqual,
eSigma,
eOpenCollectorPullUp,
eOpenEmitter,
eOpenEmitterPullUp,
eDigitalSignalIn,
eAnd,
eInvertor,
eOr,
eXor,
eShiftLeft,
eInputOutput,
eOpenCircuitOutput,
eLeftRightSignalFlow,
eBidirectionalSignalFlow);
TFindReplaceIdentifierScope
TFindReplaceIdentifierScope = (
eFindReplace_AllIdentifiers,
eFindReplace_NetIdentifiersOnly,
eFindReplace_DesignatorsOnly);
THorizontalAlign
THorizontalAlign = (
eHorizontalCentreAlign, // eVerticalCentreAlign
eLeftAlign, // eTopAlign
eRightAlign // eBottomAlign
);
THitTestResult
THitTestResult = (eHitTest_Fail,
eHitTest_NoAction,
eHitTest_Move,
eHitTest_InPlaceEdit,
eHitTest_CopyPaste,
eHitTest_Resize_Any,
eHitTest_Resize_EndAngle,
eHitTest_Resize_StartAngle,
eHitTest_Resize_SecondaryRadius,
eHitTest_Resize_Radius,
eHitTest_Resize_CornerTopLeft,
eHitTest_Resize_CornerTopRight,
eHitTest_Resize_CornerBottomRight,
eHitTest_Resize_CornerBottomLeft,
eHitTest_Resize_SideLeft,
eHitTest_Resize_SideRight,
eHitTest_Resize_SideTop ,
eHitTest_Resize_SideBottom,
eHitTest_Resize_Vertical,
eHitTest_Resize_Horizontal,
eHitTest_Resize_SE_NW,
eHitTest_Resize_SW_NE);
THitTestMode
THitTestMode = (
eHitTest_AllObjects,
eHitTest_OnlyAccessible
);
TEditingAction
TEditingAction = (eEditAction_DontCare, eEditAction_Move, eEditAction_Change,eEditAction_Delete,eEditAction_Select);
TFontName
TFontName = String[lf_FaceSize + 1];
TFontID
TFontID = Integer;
TFileName
TFileName = TString;
TGridPreset
TGridPreset = (eDXPPreset, eCoarse2, eCoarse3, eFine2, eFine3, eElectrical);
TIterationDepth
TIterationDepth = (eIterateFirstLevel, eIterateFilteredLevels, eIterateAllLevels);
TLeftRightSide
TLeftRightSide = (
eLeftSide,
eRightSide,
eTopSide,
eBottomSide
);
TLibraryAutoZoom
TLibraryAutoZoom = (lazNoZoomChange, lazRememberLast, lazCenter);
TLibraryScope
TLibraryScope = (lsCurrentComponnet, lsAllComponents);
TLinePlaceMode
TLinePlaceMode = (eLineAnyAngle,
eLine90Start,
eLine90End,
eLine45Start,
eLine45End,
eLineArcStart,
eLineArcEnd,
eAutoWire );
TLineShape
TLineShape = (
eLineShapeNone,
eLineShapeArrow,
eLineShapeSolidArrow,
eLineShapeTail,
eLineShapeSolidTail,
eLineShapeCircle,
eLineShapeSquare
);
TLineStyle
TLineStyle = (
eLineStyleSolid,
eLineStyleDashed,
eLineStyleDotted
);
TLocation
Type
TLocation = TPoint;
Description
The TLocation
type is used to define a point in X,Y coordinates for a design object.
Where the TPoint = packed record X: Longint; Y: Longint;end;
See also
ISch_GraphicalObject interface
ISch_Line
ISch_Rectangle
ISch_HarnessConnector
ISch_Polygon
IConnection
IConnectionArray
TMyRect
TMyRect = Record
Left,Right,Top, Bottom, Width, Height : Integer;
End;
TOrcadFootprint
TOrcadFootPrint = (
ePartfield1,
ePartfield2,
ePartfield3,
ePartfield4,
ePartfield5,
ePartfield6,
ePartfield7,
ePartfield8,
eIgnore);
TObjectAttribute
TObjectAttribute = (eObjectAttribute_ObjectId,
eObjectAttribute_DocumentName,
eObjectAttribute_Color,
eObjectAttribute_TextColor,
eObjectAttribute_AreaColor,
eObjectAttribute_LocationX,
eObjectAttribute_LocationY,
eObjectAttribute_CornerLocationX,
eObjectAttribute_CornerLocationY,
eObjectAttribute_OwnerPartId,
eObjectAttribute_OwnerPartDisplayMode,
eObjectAttribute_Width,
eObjectAttribute_Radius,
eObjectAttribute_Solid,
eObjectAttribute_Transparent,
eObjectAttribute_StartAngle,
eObjectAttribute_EndAngle,
eObjectAttribute_SecondaryRadius,
eObjectAttribute_StringText,
eObjectAttribute_LongStringText,
eObjectAttribute_LineStyle,
eObjectAttribute_StartLineShape,
eObjectAttribute_EndLineShape,
eObjectAttribute_LineShapeSize,
eObjectAttribute_IsHidden,
eObjectAttribute_FontId,
eObjectAttribute_Orientation,
eObjectAttribute_HorizontalJustification,
eObjectAttribute_VerticalJustification,
eObjectAttribute_TextHorizontalAnchor,
eObjectAttribute_TextVerticalAnchor,
eObjectAttribute_Alignment,
eObjectAttribute_BorderWidth,
eObjectAttribute_LineWidth,
eObjectAttribute_JunctionSize,
eObjectAttribute_Locked,
eObjectAttribute_Accessible,
eObjectAttribute_Name,
eObjectAttribute_OwnerName,
eObjectAttribute_Description,
eObjectAttribute_ShowName,
eObjectAttribute_IsMirrored,
eObjectAttribute_DesignatorLocked,
eObjectAttribute_PartIdLocked,
eObjectAttribute_PinsMoveable,
eObjectAttribute_FileName,
eObjectAttribute_TargetFileName,
eObjectAttribute_ImageKeepAspect,
eObjectAttribute_ImageEmbed,
eObjectAttribute_ParametersList,
eObjectAttribute_ParameterValue,
eObjectAttribute_ParameterName,
eObjectAttribute_ParameterType,
eObjectAttribute_ParameterReadOnlyState,
eObjectAttribute_ParameterAllowLibrarySynchronize,
eObjectAttribute_ParameterAllowDatabaseSynchronize,
eObjectAttribute_TextAutoposition,
eObjectAttribute_PinWidth,
eObjectAttribute_PinFormalType,
eObjectAttribute_PinDefaultValue,
eObjectAttribute_PinDesignator,
eObjectAttribute_PinHiddenNetName,
eObjectAttribute_PinShowDesignator,
eObjectAttribute_PinElectrical,
eObjectAttribute_PinLength,
eObjectAttribute_PinIeeeSymbolInner,
eObjectAttribute_PinIeeeSymbolOuter,
eObjectAttribute_PinIeeeSymbolInnerEdge,
eObjectAttribute_PinIeeeSymbolOuterEdge,
eObjectAttribute_PinSwapId_Pin,
eObjectAttribute_PinSwapId_Part,
eObjectAttribute_PinSwapId_PartPin,
eObjectAttribute_PortArrowStyle,
eObjectAttribute_PortIOType,
eObjectAttribute_PowerObjectStyle,
eObjectAttribute_PowerObjectShowNetName,
eObjectAttribute_CrossSheetConnectorStyle,
eObjectAttribute_RoundRectangleCornerRadiusX,
eObjectAttribute_RoundRectangleCornerRadiusY,
eObjectAttribute_SchComponentLibraryName,
eObjectAttribute_SchComponentLibReference,
eObjectAttribute_SchComponentDesignator,
eObjectAttribute_SchComponentDisplayMode,
eObjectAttribute_SchComponentPartId,
eObjectAttribute_SchComponentComment,
eObjectAttribute_SchComponentFootprint,
eObjectAttribute_SchComponentKind,
eObjectAttribute_ShowHiddenFields,
eObjectAttribute_ShowHiddenPins,
eObjectAttribute_ShowDesignator,
eObjectAttribute_SheetFileName,
eObjectAttribute_SheetName,
eObjectAttribute_SheetEntrySide,
eObjectAttribute_SheetEntryDistanceFromTop,
eObjectAttribute_IeeeSymbol,
eObjectAttribute_SymbolScaleFactor,
eObjectAttribute_TaskHolderProcess,
eObjectAttribute_TaskHolderInstanceName,
eObjectAttribute_TaskHolderConfiguration,
eObjectAttribute_TextFrameWordWrap,
eObjectAttribute_TextFrameShowBorder,
eObjectAttribute_TextFrameClipToRect,
eObjectAttribute_Author,
eObjectAttribute_Collapsed,
eObjectAttribute_ErrorKind,
eObjectAttribute_SelectedVertex_X,
eObjectAttribute_SelectedVertex_Y,
eObjectAttribute_SelectedVertex2_X,
eObjectAttribute_SelectedVertex2_Y,
eObjectAttribute_UnionIndex,
eObjectAttribute_DatabaseTableName,
eObjectAttribute_SchComponentUseLibraryName,
eObjectAttribute_SchComponentUseDBTableName,
eObjectAttribute_DesignItemID,
eObjectAttribute_OpenBusComponentKind,
eobjectAttribute_PrimaryConnectionPosition,
eObjectAttribute_HarnessConnectorSide,
eObjectAttribute_HarnessType,
eObjectAttribute_HideHarnessConnectorType,
eObjectAttribute_BusTextStyle,
eObjectAttribute_ArrowKind,
eObjectAttribute_OpenBusPortType,
eObjectAttribute_OpenBusPortLink,
eObjectAttribute_OpenBusLinkMasterPort,
eObjectAttribute_OpenBusLinkSlavePort
);
TObjectCreationMode
TObjectCreationMode = (eCreate_Default, eCreate_GlobalCopy);
TObjectId
TObjectId = (eFirstObjectID,
eClipBoardContainer,
eNote,
eProbe,
eRectangle,
eLine,
eConnectionLine,
eBusEntry,
eArc,
eEllipticalArc,
eRoundRectangle,
eImage,
ePie,
eTextFrame,
eEllipse,
eJunction,
ePolygon,
ePolyline,
eWire,
eBus,
eBezier,
eLabel,
eNetLabel,
eDesignator,
eSchComponent,
eParameter,
eParameterSet,
eParameterList,
eSheetName,
eSheetFileName,
eSheet,
eSchLib,
eSymbol,
eNoERC,
eErrorMarker,
ePin,
ePort,
ePowerObject,
eSheetEntry,
eSheetSymbol,
eTemplate,
eTaskHolder,
eMapDefiner,
eImplementationMap,
eImplementation,
eImplementationsList,
eCrossSheetConnector,
eCompileMask,
eOpenBusComponent,
eOpenBusLink,
eOpenBusDesignator,
eHarnessConnector,
eHarnessEntry,
eHarnessConnectorType,
eSignalHarness,
eOpenBusPort,
eLastObjectId
);
TObjectSet
TObjectSet = Set Of TObjectID;
TOpenBusPortType
TOpenBusPortType = (obptUnspecified, obptMaster, obptSlave);
TOpenBusComponentKind
TOpenBusComponentKind = (obckProcessor, obckArbiter, obckInterconnect, obckPeripheral, obckMemory, obckConnector, obckTerminator);
TOpenBusPortKind
TOpenBusPortKind = (obpkPeripheralMaster, obpkPeripheralSlave,
obpkArbiterMaster , obpkArbiterSlave,
obpkInterconMaster , obpkInterconSlave,
obpkConnectorMaster , obpkConnectorSlave)
TOpenBusInternalPinType
TOpenBusInternalPinType = (iptInterrupt, iptReset, iptClock);
TParameter_ReadOnlyState
TParameter_ReadOnlyState = (
eReadOnly_None,
eReadOnly_Name,
eReadOnly_Value,
eReadOnly_NameAndValue
);
TParameterType
TParameterType = (eParameterType_String,
eParameterType_Boolean,
eParameterType_Integer,
eParameterType_Float);
TPinElectrical
TPinElectrical = (
eElectricInput,
eElectricIO,
eElectricOutput,
eElectricOpenCollector,
eElectricPassive,
eElectricHiZ,
eElectricOpenEmitter,
eElectricPower);
TPlacementMode
TPlacementMode = (ePlacementMode_Single, ePlacementMode_Multiple);
TPolylineCutterMode
TPolylineCutterMode = (eCutterSnapToSegment, eCutterGridSize, eCutterFixedLength);
TPortArrowStyle
TPortArrowStyle = (
ePortNone,
ePortLeft,
ePortRight,
ePortLeftRight,
ePortNoneVertical,
ePortTop,
ePortBottom,
ePortTopBottom
);
TPortConnectedEnd
TPortConnectedEnd = (
ePortConnectedEnd_None,
ePortConnectedEnd_Origin, //connected at port Location
ePortConnectedEnd_Extremity, //connected at the other end
ePortConnectedEnd_Both //connected at both ends
);
TPortIO
TPortIO = (
ePortUnspecified,
ePortOutput,
ePortInput,
ePortBidirectional
);
TPowerObjectStyle
TPowerObjectStyle = (
ePowerCircle,
ePowerArrow,
ePowerBar,
ePowerWave,
ePowerGndPower,
ePowerGndSignal,
ePowerGndEarth
);
TProbeMethod
TProbeMethod = (
eProbeMethodAllNets,
eProbeMethodProbedNetsOnly
);
TRotationBy90
TRotationBy90 =
eRotate0,
eRotate90,
eRotate180,
eRotate270
);
TPrintKind
TPrintKind = (ePrintKind_FullColor,ePrintKind_GrayScale,ePrintKind_Monochrome);
TPlacementResult
TPlacementResult = (eSingleObjectPlacementProcessAborted,eWholeObjectPlacementAborted, eObjectPlacementSuccessfull);
TReal
TReal = Double;
TRectangleStyle
TRectangleStyle = (
eRectangleHollow,
eRectangleSolid
);
TSchDropAction
TSchDropAction = (eDropAction_None,
eDropAction_AskOpenOrInsertText,
eDropAction_WarnBinaryAsText,
eDropAction_OpenInEditor,
eDropAction_OpenAsText,
eDropAction_Insert);
TSelectionState
TSelectionState = (eSelectionState_None,
eSelectionState_FirstSelected,
eSelectionState_MultiSelected,
eSelectionState_VerticesSelected);
TSelectionMatch
TypeTSelectionMatch = (
eMatchSelected,
eMatchedNotSelected,
eMatchAnySelection
);
TSheetDocumentBorderStyle
TSheetDocumentBorderStyle = (
eSheetStandard,
eSheetAnsi
);
TSheetOrientation
TSheetOrientation = (eLandscape, ePortrait);
TSheetStyle
TSheetStyle = (
eSheetA4,
eSheetA3,
eSheetA2,
eSheetA1,
eSheetA0,
eSheetA,
eSheetB,
eSheetC,
eSheetD,
eSheetE,
eSheetLetter,
eSheetLegal,
eSheetTabloid,
eSheetOrcadA,
eSheetOrcadB,
eSheetOrcadC,
eSheetOrcadD,
eSheetOrcadE
);
TShowCutterMarkersMode
TShowCutterMarkersMode = (eMarkersNever, eMarkersAlways, eMarkersOnPolyline);
TShowCutterBoxMode
TShowCutterBoxMode = (eBoxNever, eBoxAlways, eBoxOnPolyline);
TSide
TSide = (
eLeft,
eBottom,
eRight,
eTop
);
TSize
TSize = (
eZeroSize,
eSmall,
eMedium,
eLarge
);
TSignalLayer
TSignalLayer = (
eNoSignalLayer,
eTopSignalLayer,
eMidSignalLayer1,
eMidSignalLayer2,
eMidSignalLayer3,
eMidSignalLayer4,
eMidSignalLayer5,
eMidSignalLayer6,
eMidSignalLayer7,
eMidSignalLayer8,
eMidSignalLayer9,
eMidSignalLayer10,
eMidSignalLayer11,
eMidSignalLayer12,
eMidSignalLayer13,
eMidSignalLayer14,
eBottomSignalLayer,
eMultiSignalLayer,
ePowerLayer1,
ePowerLayer2,
ePowerLayer3,
ePowerLayer4
);
TStdLogicState
TStdLogicState = (eStdLogic_Unitialized,
eStdLogic_ForcingUnknown,
eStdLogic_Forcing0,
eStdLogic_Forcing1,
eStdLogic_HiZ,
eStdLogic_WeakUnknown,
eStdLogic_Weak0,
eStdLogic_Weak1,
eStdLogic_DontCare);
TStringIncrementStyle
TStringIncrementStyle = (eSIS_None, eSIS_HorizontalFirst, eSIS_VerticalFirst);
TTextHorzAnchor
TTextHorzAnchor = (
eTextHorzAnchor_None,
eTextHorzAnchor_Both,
eTextHorzAnchor_Left,
eTextHorzAnchor_Right
);
TTextJustification
TTextJustification = (
eJustify_BottomLeft,
eJustify_BottomCenter,
eJustify_BottomRight,
eJustify_CenterLeft,
eJustify_Center,
eJustify_CenterRight,
eJustify_TopLeft,
eJustify_TopCenter,
eJustify_TopRight
);
TTextVertAnchor
TTextVertAnchor = (
eTextVertAnchor_None,
eTextVertAnchor_Both,
eTextVertAnchor_Top,
eTextVertAnchor_Bottom
);
TUpperLowerCase
TUpperLowerCase = (eUpperCase, eLowerCase, eAnyCase);
TUnit
TUnit = (eMil, eMM, eIN, eCM, eDXP, eM, eAutoImperial, eAutoMetric);
TUnitSet
TUnitSet = Set Of TUnit;
TUnitSystem
TUnitSystem = (eImperial, eMetric);
TVerticalAlign
TVerticalAlign = (
eVerticalCentreAlign,
eTopAlign,
eBottomAlign
);
TVisibleGrid
TVisibleGrid = (
eDotGrid,
eLineGrid
);
TVHOrientation
THVOrientation = (
eHorizontal,
eVertical
);
TWidthArray
TWidthArray = Array [TSize] of Integer;