Skip to main content

Schematic

Namespace: SCH

Schematic and schematic library documents, design objects, the schematic server and its services.

534 interfaces, 136 enumerations, 17 structures and classes.

Server and preferences​

TypeDescription
IDocumentOptions
IGridArea
IGridLines
IGridSettingThe IGridSetting interface represents the grid settings for the Schematic documents part of a project.
ISch_CompileMaskA compile mask is used to effectively hide the area of the design within the PCB project it contains from the Compiler, allowing you to manually prevent error…
ISch_FontManagerThe ISch_FontManager interface represents the internal font manager in Schematic Editor that manages fonts for text based objects on schematic documents.
ISch_FontManager2The ISch_FontManager2 interface represents the internal font manager in Schematic Editor that manages fonts for text based objects on schematic documents.
ISch_JunctionConvertSettings
ISch_LibraryRuleCheckerThe ISch_LibraryRuleChecker interface represents the internal library rule checker facility that checks the validity of symbols in schematic libraries.
ISch_MapDefinerThe ISch_MapDefiner interface represents the object that is used to define a mapping between schematic pins of a schematic component and its model for example…
ISch_PreferencesThe ISch_Preferences interface represents the global preferences for the Schematic Editor and the settings are the same for any PCB project that has schematics…
ISch_RobotManagerThe ISch_RobotManager interface represents an object that can send Schematic messages into the Schematic Editor server from your extension to update the sub-sy…
ISch_ServerInterfaceThis interface is an entry interface to the schematic server loaded in Altium Designer.

Documents and iteration​

TypeDescription
IConnectionThe IConnection interface represents whether the wire or bus connection has a manual junction on it or not, with location, wire or bus objects count and the th…
IConnectionsArrayThe IConnectionsArray represents the bus and wire connections in a schematic document.
IPCBProjectLink
IProjectLink
ISch_ConnectivityStorage
ISch_DocumentThis interface is the immediate ancestor interface for ISch_Sheet and ISch_Lib interfaces.
ISch_DrawableDocument
ISch_HitTestThis ISch_HitTest interface returns you the number of objects and object type at a particular point on the schematic document.
ISch_IteratorAn iterator object interface represents an existing iterator object which iterates through a design database to fetch specified objects within a specified regi…
ISch_LibThis interface represents an existing library document open in Altium Designer.
ISch_RichTextDocument
ISch_SheetThe ISch_Sheet interface represents an existing schematic document open in Altium Designer.
ISch_TemplateThe schematic templates represent the sheet border, title block and graphics for a schematic document.
ISchComponentLink

Harness design​

TypeDescription
IHarnessTypeHolder
ISch_HarnessAssociatedPartsOwner
ISch_HarnessBundle
ISch_HarnessBundleContent
ISch_HarnessBundleSubLineContent
ISch_HarnessBundleSubLineData
ISch_HarnessCable
ISch_HarnessCableData
ISch_HarnessCavityPartsOwner
ISch_HarnessComponent
ISch_HarnessConnectorThe ISch_HarnessConnector interface is used to represent a harness connector design obejct which is a member of the harness system.
ISch_HarnessConnectorTypeThe ISchHarnessConnectorType interface represents the text object of the harness connector and defines the harness connector type.
ISch_HarnessDocument
ISCH_HarnessDocumentInterface
ISch_HarnessEntryThe ISch_HarnessEntry interface is used to represent a harness entry which is a member of the harness system.
ISch_HarnessLayoutConnectionPoint
ISch_HarnessLayoutConnectionPointConnector
ISch_HarnessLayoutDrawing
ISch_HarnessLayoutLabel
ISch_HarnessNoConnect
ISch_HarnessNoConnectData
ISch_HarnessPin
ISch_HarnessShield
ISch_HarnessShieldData
ISch_HarnessSplice
ISch_HarnessSpliceData
ISch_HarnessTwist
ISch_HarnessTwistData
ISch_HarnessWire
ISch_HarnessWireBreak
ISch_HarnessWireData
ISch_HarnessWiringDiagram
THarnessCavityPartType
THarnessLayoutConnectionPointStyle
THarnessLengthUnit
THarnessShieldStyle
THarnessSpliceStyle

Design objects​

TypeDescription
ISch_ArcAn arc object is a circular curve used to place on the schematic sheet.
ISch_BasicContainerThe ISch_BasicContainer interface represents as a parent object or a child object for a schematic object in Altium Designer.
ISch_BasicPolyline
ISch_BezierA bezier curve is used to create curved line shapes (For example a section of a sine wave or a pulse).
ISch_Blanket
ISch_BusBuses are special graphical elements that represent a common pathway for multiple signals on a schematic document.
ISch_BusEntryA bus entry is a special wire at an angle of 45 degrees which is used to connect a wire to the bus line.
ISch_CircleA circle is a closed arc object.
ISch_CollapsiblePolygon
ISch_CollapsibleRectangle
ISch_ComplexTextAn immediate ancestor interface for ISch_SheetFilename and ISch_SheetName interfaces.
ISch_ComponentThe ISch_Component references the logical symbol as a component that can contain links to different model implementations such as PCB, Signal Integrity and Sim…
ISch_ConnectionLineA connection line represents a line that has corner properties as well as width and style properties between two nodes on a schematic document.
ISch_CrossSheetConnectorCross sheet connector objects can be used to link a net from a sheet to other sheets within a project.
ISch_CustomConnector
ISch_DesignatorThe ISch_Designator interface represents a designator object which is part of the component object that identifies it as part of a net.
ISch_DirectiveAn ISch_Directive interface represents an object that stores a text string.
ISch_EllipseAn ellipse is a drawing object which is filled or unfilled graphic elements on a schematic sheet.
ISch_EllipticalArcElliptical arc objects are drawing objects which represent open circular or elliptical curves on a schematic sheet.
ISch_ErrorMarkerError Markers are placed on a schematic sheet at the site of each ERC violation by the Schematic Editor.
ISch_GraphicalObjectThe ISch_GraphicalObject interface represents the ancestor interface for an object that has graphical properties on a schematic document.
ISch_HighLevelCodeEntry
ISch_HighLevelCodeMemory
ISch_HighLevelCodeRoutine
ISch_HighLevelCodeSymbol
ISch_Hyperlink
ISch_ImageThe ISch_Image interfaces are used to represent graphical images on a schematic document.
ISch_ImageParameter
ISch_ImplementationEach schematic component can have models from one or more domains.
ISch_JunctionJunctions are small circular objects used to logically join intersecting wires on the schematic sheet.
ISch_LabelThe ISch_Label interface represents an existing label object on a schematic document.
ISch_LineLines are graphical drawing objects with any number of joined segments.
ISch_ModelDatafileLinkA model represents all the information needed for a component in a given domain, while a datafile entity (or link) is the only information which is in an exter…
ISch_NetLabelA net describes a connection from one component pin, to a second pin, and then to a third pin and so on.
ISch_NoERCThe NoERC directive is a special symbol that identifies a pin as one that you want the Electrical Rules Checker to ignore.
ISch_NoteThe ISch_Note interface represents the note object on the schematic sheet.
ISch_OpenBusGroup
ISch_ParameterThere are two types of parameters - system parameters which are owned by a schematic document and parameters owned by certain schematic design objects.
ISch_ParameterSetThe ISch_ParameterSet interface is a group of parameters as a design parameter set directive for a wire or a net on the schematic document that can be transfer…
ISch_ParametrizedGroupThe ISch_ParametrizedGroup is an immediate ancestor interface for ParameterSet, Port, Pin, Component and SheetSymbol interfaces.
ISch_PiePie objects are unfilled or filled graphic elements.
ISch_PinPins are special objects that have electrical characteristics and are used to direct signals in and out of components.
ISch_PolygonPolygons are multi-sided graphical elements.
ISch_PolylineLines are graphical drawing objects with any number of joined segments.
ISch_PortA port is used to connect a net on one sheet to Ports with the same name on other sheets.
ISch_PowerObjectPower ports are special symbols that represent a power supply and are always identified by their net names.
ISch_ProbeA probe is a special marker which is placed on a schematic document to identify nodes for digital simulation.
ISch_RectangleRectangles are drawing objects which are unfilled or filled graphic elements.
ISch_RectangularGroupThe ISch_RectangularGroup interface represents a group rectangular object with the size of the object with XSize and YSize dimensions.
ISch_RoundRectangleRounded rectangles are drawing objects which are unfilled or filled graphic elements.
ISch_RTFLink
ISch_SheetEntryA sheet entry within a Sheet Symbol object creates a connection between the net touching on the parent sheet, to a Port with the same name on the child sheet.
ISch_SheetFileNameA sheet filename object is part of a complex text object interface and is attached to the sheet symbol object.
ISch_SheetNameA sheetname is part of a complex text object interface and is associated with a sheet symbol object.
ISch_SheetSymbolSheet symbols represent other schematic sheets (often referred to as a child sheet).
ISch_SymbolThe symbol objects are special markers used for components in the Schematic Library.
ISch_TextFrameText frames hold multiple lines of free text.
ISch_WireWires are straight line segments which are placed on a schematic document to create the electrical connections.

Libraries, components and models​

TypeDescription
IComponentConfigurator
IComponentFullInfo
IComponentInfoThe IComponentInfo interface is an item within the ILibCompInfoReader interface.
IComponentPinSelectionListenerThis is for internal use.
IConfiguratorManager
IFootprintConfigurator
IGenerateReport
IGetLibraryReportInfo
IHighlightedModelEditor
IImplementationFile
IIntegratedLibraryManagerThe IIntegratedLibraryManager interface represents the integrated library manager that manages schematic components and its models from installed libraries in…
ILibCompFullInfoReader
ILibCompInfoReaderThe ILibCompInfoReader interface represents the object which has the list of library components (symbols) of a loaded schematic library.
ILibObjectIterator
ILibObjectReportInfo
ILibObjectReportPaint
ILibraryComponent
ILibraryComponentData
ILibraryData
ILibraryDataReader
ILibraryModelData
ILibraryParameterData
ILibraryPartData
ILibraryReportExternalSettings
ILibraryReportInfo
ILibraryServer
IModel
IModelDatafileThe IModelDatafile interface represents the data file (external file) that is associated with a model.
IModelDatafileTypeThe IModelDatafileType interface represents the data file type for the specified model.
IModelEditorThe IModelEditor interface represents the Model Editor hosted by a server which normally has a dialog that displays data about the model properties in Altium D…
IModelEditor2
IModelEditor3
IModelEditor4
IModelEditorSelectionListener
IModelEditorSelectionManager
IModelEditorSelectionManagerController
IModelSelectorChoice
IModelSelectorChoiceList
IModelTypeThe IModelType interface represents the type used by a model linked in the Component.
IModelTypeManagerThe IModelTypeManager interface represents a repository of available model types in Altium Designer.
IPinMapping
IReportParameters
IReportTableInfo
IServerModelThe IServerModel interface represents the model set up by the server to be used by the integrated library server.
IServerModel2
ISubLibraryData
ISubLibraryDataList

Supply chain and parts​

TypeDescription
IAggregatorSupplier
IAggregatorSupplierList
IAggregatorSupplierListResult
ICanChangeComponentPartChoicesData
ICanChangeComponentPartChoicesList
ICanChangeComponentPartChoicesListResult
ICanChangePartChoicesResult
IComponentDynamicData
IComponentDynamicDataList
IComponentDynamicDataListAsyncResult
IDragDropDataSheets
IDragDropParameters
IDragDropSupplierParts
IDragDropSupplierSourceRelationships
IManufacturerPart
IManufacturerPartsCollection
IPartCatalog2
IPartCatalog2AsyncCallback
IPartCatalog2AsyncResult
IPartCatalog2Ext
IPartCatalog2Ext2
IPartCatalog2Result
IPartChoice2
IPartChoice2ExtListResult
IPartChoice2List
IPartChoice2ListAsyncResult
IPartChoice2ListResult
IPartChoice3
IPartChoice4
IPartChoice5
IPartChoiceComponentID
IPartChoiceComponentIDList
IPartChoicesClient
IPartChoicesClientResult
IPartIdentifier
IPartIdentifierList
IPartParameter
IPartParameterList
IPartProvider
IPartProviderInfo
IPartSearch
IPartSearchManager
IPartSearchServer
IPartSourceData
IPartSourceList
IPartSourceListResult
IPriceItem
IPriceItemList
IProviderSupplierOptions
IProviderSupplierOptionsList
IProviderSupplierOptionsListResult
ISearchComponentResult
ISearchComponentResultList
IStock
IStockItem
IStockItemList
ISupplier
ISupplier2
ISupplierAggregator
ISupplierAliases
ISupplierAliasesList
ISupplierCart
ISupplierCategory
ISupplierCategoryParameters
ISupplierComponent
ISupplierComponent2
ISupplierComponent3
ISupplierComponentList
ISupplierImportParameterPref
ISupplierItemPainter
ISupplierLinkDocument
ISupplierLinksFrame
ISupplierLinksListener
ISupplierManager
ISupplierParameterKind
ISupplierParameterValue
ISupplierParametricFilter
ISupplierParametricFilters
ISupplierPart
ISupplierPartsCollection
ISupplierSearch
ISupplierSearchError
ISupplierSearchFrame
ISupplierSearchResults
ISupplierSearchStatistics
ISupplierSourceRelationship
ISupplierSourceRelationship2
ISupplierSourceRelationship3
ISupplierSourceRelationshipError
ISupplierSourceRelationshipList
ISupplyChainManager
ISupplyChainServer
ISupplyChainSupplierLinkDocument

Simulation and signal integrity​

TypeDescription
IAxis
IAxisList
IBasicSimModelPainterView
IChart
IChartCollection
IChartList
IChartOptions
IChartTitle
IIbisAddSubModel
IIbisAddSubModelList
IIbisAlgModExecutable
IIbisAlgModExecutableList
IIbisAlgorithmicModel
IIbisAlternatePackageModel
IIbisAlternatePackageModelList
IIbisAmiParseTree
IIbisAtoD
IIbisAtoDList
IIbisCCompCorner
IIbisCircuitCall
IIbisCircuitCallList
IIbisComponent
IIbisComponentEmi
IIbisComponentList
IIbisCorner
IIbisCurve
IIbisDiffPin
IIbisDiffPinList
IIbisDriverScheduleDelay
IIbisDriverScheduleModel
IIbisDriverScheduleModelList
IIbisDtoA
IIbisDtoAList
IIbisEbdModel
IIbisEbdModelList
IIbisExternalCircuit
IIbisExternalCircuitList
IIbisExternalModel
IIbisFile
IIbisHeader
IIbisHeaderList
IIbisMatrix
IIbisMatrixRow
IIbisMatrixRowList
IIbisModel
IIbisModelEmi
IIbisModelImplementation
IIbisModelList
IIbisModelManager
IIbisModelSelector
IIbisModelSelectorList
IIbisModelSelectorModel
IIbisModelSelectorModelList
IIbisModelSpec
IIbisObject
IIbisObjectList
IIbisPackage
IIbisPackageElement
IIbisPackageElementList
IIbisPackageModel
IIbisPackageModelList
IIbisPin
IIbisPinEmi
IIbisPinEmiDomain
IIbisPinEmiDomainList
IIbisPinEmiList
IIbisPinList
IIbisPinMapping
IIbisPinMappingList
IIbisPort
IIbisPortList
IIbisPortMap
IIbisPortMapList
IIbisPortType
IIbisPortTypeList
IIbisRamp
IIbisRampLine
IIbisRange
IIbisRangeP
IIbisRangePList
IIbisReceiverThresholds
IIbisRLCSection
IIbisSeriesMosfet
IIbisSeriesMosfetList
IIbisSeriesPinMapping
IIbisSeriesPinMappingList
IIbisSeriesSwitchGroup
IIbisSeriesSwitchGroupList
IIbisSNode
IIbisSNodeList
IIbisStrings
IIbisSubModel
IIbisSubModelList
IIbisSubModelSpec
IIbisSwitchInfo
IIbisTestData
IIbisTestDataList
IIbisTestLoad
IIbisTestLoadList
IIbisWaveform
IIbisWaveformList
IMeasurementCursor
IMeasurementCursorData
IPlot
IPlotAxis
IPlotList
IPlottedWave
IPlottedWaveList
IPlotTitle
ISignalIntegrityAnalyser
ISignalIntegrityPreferences
ISignalIntegrityReport
ISignalIntegrityResultSet
ISignalIntegrityServerModule
ISiImplementationFile
ISimImplementationFile
ISimModelImplementationDocument
ISimModelMetafilePainter
ISimObject
ISiModelImplementationDocument
ISimProbe
ISimProbeManager
ISimProbeProfileData
ISimProfile
ISimProfileManager
ISimSupportPreferences
ISimSupportServerModule
ISimViewDocument
ISiPinModel
ISiPinModelList
ISourceWave
ISourceWaveList
IWave
IWaveLabel
IWaveLegend
IWaveList
IXAxis

Painting and views​

TypeDescription
IComponentMetafilePainterThe IComponentMetaFilePainter interface is an internal interface that provides a mechanism to generate images into library reports within the Schematic Library…
IComponentPainterView
IComponentPainterView2
ICoord
ICoordRect
IDataChunkImageInterface
IDocumentPainterViewThe IDocumentPainterView interface is an internal interface for the Schematic Editor and it represents the Mini Viewer facility.
IGeometryBrushInfo
IGeometryExporter
IGeometryFontInfo
IGeometryOperation
IGeometryOperationArc
IGeometryOperationBeginGroup
IGeometryOperationEllipse
IGeometryOperationImage
IGeometryOperationLines
IGeometryOperationList
IGeometryOperationPolygons
IGeometryOperationPushClip
IGeometryOperationPushTransform
IGeometryOperationRoundedRectangle
IGeometryOperationString
IGeometryPenInfo
IInstrumentView
IPainter
IPrimitive
IPrimitiveList
ISCH_GraphicalViewZoomableInterface
IScrollArrow
ISDFDocument
ISDFGraphicalView
ISDFNavigatorViewInterface
ISelectionButton
IViewManager

Embedded, FPGA and device programming​

TypeDescription
IAbstractSynthesizer
IARMEmbeddedICE
IARMNexusDriver
IBitLevelJTagChannel
IBoundaryCell
IBSDLEntity
IBSDLObject
IBSDLValueHolder
IClockCore
IClockCoreGenerator
IClockCoreTemplate
IClockCoreTemplateGenerator
IClockModifierData
IClockModifierTarget
IClockOutputActual
IConfiguratorTest
ICoreGenerator
ICustomCore
ICustomCoreGenerator
IDevice
IDeviceCachedInformation
IDeviceChannel
IDeviceDebugManager
IDeviceFamily
IDeviceFamilyManager
IDeviceInformation
IDeviceIOStandard
IDeviceLink
IDeviceManager
IDeviceMemoryArchitectureSection
IDeviceMemoryInformation
IDeviceMemoryLogicalSection
IDevicePin
IDeviceProcessorInformation
IDeviceSheetManagerThe IDeviceSheetManager interface represents the Device Sheets Folder dialog in Altium Designer.
IDriverManager
IEmbeddedCode
IFlashMemoryUtilityDialog
IFlashWriter
IFlashWriterCallback
IFlashWriters
IFPGAFlowModule
IFSM_Document
IFSM_State
IFSM_Transition
IGenericDeviceManager
IGPIOChannel
IHardBreakpoint
IHardDeviceLink
IInstructionOpCode
IJlinkDriver
IJlinkPort
IJTagChannel
IJTagDevice
IJtagParallelPort
IJtagParallelPort_ChannelMapping
IJtagPort
IJtagProxyPort
IJtagUsbPort
IMemorySpace
INexusBreakpoint
INexusCore
INexusDevice
INexusDeviceConfigurator
INexusDevicesView
INexusDongle
INexusDriver
INexusFTDIDriver
INexusPort
INexusWorkbench
INexusWorkbenchPreferences
IOpenBus_Component
IOpenBus_Document
IOpenBus_Link
IOpenBus_PinGroup
IOpenBus_Port
IOpenBus_PortCollection
IOpenBusComponentConfigurator
IProcessFlow
IProcessFlow_CustomEventsOnly
IProcessFlow_Internal
IProcessFlowRunner
IProcessorRegister
IRegisterAssociation
IRemoteExecuteBaseDriver
IRemoteExecuteFlashDriverInformation
IScanPin
ISoftBreakpoint
ISoftwareProcessFlow
ISourceConstraint
ISPIChannel
ISPIDevice
ISPROMChannel
ITargetCore
ITargetCoreGenerator
ITestDongles
IVendorConstraint
IVendorConstraintsManager
IVendorTool
IVendorToolManager
IVendorToolManagerEx
IVHDLPreferences
IVHDLSynSettings
IVHDLSynthesizer

Enumerations​

TypeDescription
TActionPartChoice
TARM_Mode
TARM_Register
TAutoPanStyle
TBitValue
TBreakpointMode
TCellFunction
TCellKind
TChartView
TChosenDocumentScope
TClockModifierType
TClockOperationKind
TCrossRefLocationStyle
TCrossRefSheetStyle
TCrossSheetConnectorStyle
TCursorShape
TDataType
TDebuggerMode
TDeltaType
TDeviceState
TDisableResult
TDynamicDataParameter
TEndianness
TFlowRunResult
TFlowState
TGeometryBrushType
TGeometryOperationType
TGridLineType
THighLevelCodeDataType
THighLevelCodeEntryRole
THighLevelCodeEntryType
THighLevelCodeInterfaceMode
THighLevelCodeScope
THitTestMode
THorizontalAlign
TIbisComponentEmiDomain
TIbisMatrixType
TIbisModelEmiDomain
TIbisModelEmiType
TIbisModelEnable
TIbisModelPolarity
TIbisModelType
TIbisModelUsage
TIbisNumStatus
TIbisPackageElementType
TIbisSubModelMode
TIbisSubModelType
TIbisTestLocationType
TIeeeSymbol
TIterationDepth
TJunctionConversionKind
TLeftRightSide
TLibraryScope
TLibraryType
TLineShape
TLineStyle
TManufacturerLifecycleStatusID
TMemoryFlattenType
TMemoryInterfaceType
TMemoryKind
TModelDriveStrength
TModelEditContext
TModuleType
TNexusBreakpointKind
TNexusCoreKind
TNexusDriverStatus
TNoERCSymbol
TObjectCreationMode
TObjectIdNote, the eTraceObject and eSpareViaObject values are for internal use only and are not used directly with PCB documents (these values are used for Signal Inte…
TOpenBusComponentInterfaceType
TOpenBusComponentKind
TOpenBusInternalPinType
TOpenBusPortType
TOrcadFootPrint
TPaintColorMode
TPaintScaleMode
TParameter_ReadOnlyState
TParameterSetStyle
TParameterType
TPartProviderSourceType
TPenDashStyle
TPenLineJoin
TPenMode
TPinItemMode
TPinTextRotationAnchor
TPolylineCutterMode
TPortArrowStyle
TPortConnectedEnd
TPortIO
TPowerObjectStyle
TProcessFlowState
TRotationBy90
TRWBehavior
TScaleMode
TScanClockHaltMode
TScanPinKind
TScrollArrowDirection
TScrollDirection
TSelectMode
TSheetDocumentBorderStyle
TSheetOrientation
TSheetStyle
TSheetSymbolType
TShowCutterBoxMode
TShowCutterMarkersMode
TSimAnalysisType
TSimComplexFunctionType
TSimProbeType
TSimViewChartType
TSimViewGridType
TSimViewPZType
TSize
TSkipOption
TStdLogicState
TSuperscriptMode
TSupplierIncludeOption
TSupplierLifecycleStatusID
TSupplierSearchFilter
TSynthesizerCategory
TTapState
TTerminationType
TTextHorzAnchor
TTextJustification
TTextVertAnchor
TUnit
TUnitSystem
TVendorCategory
TVendorDir
TViewablePrimitiveId
TVisibleGrid
TWaveType

Structures and classes​

TypeDescription
Coord
CoordRect
DeviceCachedInformation
GlobalVars
SCHConstant
SCoord
SCoordRect
SDeviceCachedInformation
SupplierLifecycleStatusHelper
SupplierSearchHandler
TDynamicDataParameterSet
TObjectSet
TSimAnalysisTypeSet
TSkipOptionSet
TSupplierIncludeOptionSet
TSupplierSearchFilterSet
TVendorCategorySet

Other interfaces​

TypeDescription
IPercentCallback
ITextFile