Skip to main content
View as Markdown

Projects and design data

Namespace: EDP

The workspace, projects and documents, compiled design data, bills of materials, outputs and comparisons.

367 interfaces, 84 enumerations, 41 structures and classes.

Workspace and projects​

TypeDescription
IAbstractVHDLProjectThe IAbstractVHDLProject interface represents a project that hosts VHDL documents.
IBaseConfiguration
IBoardProjectThe IBoardProject interface represents a project compromising of Schematic and corresponding PCB documents along with other document kinds.
IChangeManagerThe IChangeManager interface represents the change manager where you can execute an ECO of pins to be swapped for the target component of the target document.
IComponentVariationThe IComponentVariation interface represents the component variant on a PCB document.
IConfigurationThe IConfiguration interface represents the configuration container that contains a group of constraints which targets a specific FPGA device.
ICoreProjectThe ICoreProject interface represents the project that hosts core designs.
IDeviceSheet
IDeviceSheetFolder
IDMObjectThe IDMObject interface is the base object interface for all object interfaces used in the Work Space Manager system extension server for Altium Designer.
IECOThe IECO interface represents an Engineering Change Order interface in the Work Space Manager.
IEmbeddedConfiguration
IEmbeddedProjectThe IEmbeddedProject interface represents the project that hosts embedded designs that can be targetted to the hard device on the Nanoboard.
IFPGAProjectThe IFPGAProject interface represents the project that hosts FPGA designs.
IFreeDocumentsProject
IIntegratedLibraryProjectThe IIntegratedLibraryProject interface represents the project that deals with integrated libraries.
INavigationHistory
IParameterVariationThe IParameterVariation interface represents the component that contains parameter variations.
IPCBConfiguration
IProjectThe IProject interface deals with an open project in Altium Designer.
IProjectProperties
IProjectVariantThe IProjectVariation interface represents the project that contains component variations.
ISearchPathThe ISearchPath interface represents the paths of a project.
ISignalHarnessProject
IToDoManager
IUserProfile
IUserProfileList
IVariantOption
IViolationThe IViolation interface represents a violation object on a design document in the Workspace Manager of Altium Designer.
IWorkspaceThe IWorkspace interface represents the Work-Space manager in the Altium Designer which deals with project and documents and their related attributes and optio…
IWorkspacePreferencesThe IWorkspacePreferences interface represents the Preferences object in Altium Designer This interface details with file ownership - that is the rights of acc…

Documents​

TypeDescription
ICustomClipboardFormat
IDataBaseLibCommands
IDatabaseLibDocumentThe IDatabaseLibDocument interface represents a database library document.
IDocumentThe IDocument interface represents the existing document in Altium Designer.
IDocumentOutputValues
IDocumentStructure
IExportDocument
IHighlightedDocumentThis IHighlightedDocument interface represents a mechanism that deals with highlighting of objects on a design document (especially Schematic and PCB documents…
IImportDocument
ILogicalDocument
IReleasesDocument
IReleaseViewDocument
IRevisionSchemeDocument
ISVNDatabaseLibDocument
ITextCommands
ITextFrameThe ITextFrame interface is a text frame object for an existing text frame on a schematic document.
ITextPrint
IWSM_OutputJobDocumentThe IWSM_OutputJobDocument interface represents the output jobs document in Altium Designer.

Bill of materials​

TypeDescription
IActiveBomCatalog
IActiveBomCatalogItem
IActiveBomFavoriteSuppliersOption
IActiveBomManager
IActiveBomManagerOptions
IBomComponent
IBomComponentEnumerator
IBomComponentList
IBomGroup
IBomManager
IBomManagerFactory
IBomManagerOptions
IBomParameter
IBomParameterDefinition
IBomParameterDefinitionEnumerator
IBomParameterDefinitionList
IBomParameterDictionary
IBomParameterEnumerator
IBomParameterList
IBomParameterListEnumerableItem
IBomParameterListEnumerator
IBomPartChoice
IBomPartChoiceEnumerator
IBomPartChoiceList
IBomSchema
ISourceRelationship
ISupplyInformationView

Outputs and publishing​

TypeDescription
IGeneratedPage
IGeneratedPageGdiPlusMetafile
IGeneratedPageMetafile
IGeneratedPageMetafile2
IGeneratedPageMetafileCanvas
IInputValues
IOutputerThe IOutputer interface represents the one of the outputs of an output job within a design project.
IOutputGenerator
IOutputGeneratorPrepare
IOutputGeneratorUtils
IOutputJob
IOutputMedium
IOutputSettings
IPageOptionsRecord
IParallelPort
IParallelPortManager
IPredefinedOutput
IPrinterOptionsRecord
IPrintParams
IPublisher
ISymbolGeneratorThe ISymbolGenerator interface represents the symbol with parameters added if necessary generated by the ICoreProject interface.
ITOCGenerator
ITOCNode
IWebDAVPublisher

Comparison​

TypeDescription
ICMP_AirLayer
ICMP_Arc
ICMP_ArcGeometry
ICMP_Board
ICMP_ChangesApplierCallback
ICMP_ChangesSerializer
ICMP_CircleGeometry
ICMP_CollectionPropertyDifference
ICMP_CollectionPropertyDifferenceList
ICMP_ComparerBase
ICMP_ComparisonServer
ICMP_Component
ICMP_ConductiveLayer
ICMP_ConflictingChange
ICMP_ConflictingChangeList
ICMP_ContourGeometry
ICMP_CoreLayer
ICMP_CoverLayer
ICMP_CurvedContourGeometry
ICMP_CurvedPolygonGeometry
ICMP_DielectricLayer
ICMP_Difference
ICMP_Document
ICMP_DocumentChanges
ICMP_DocumentComparer
ICMP_Fill
ICMP_Geometry
ICMP_Group
ICMP_InnerDielectricLayer
ICMP_InterfaceList
ICMP_Layer
ICMP_LayerStack
ICMP_MechanicalLayer
ICMP_NeedExpandObjectDiffCallback
ICMP_Net
ICMP_NetList
ICMP_Object
ICMP_ObjectDifference
ICMP_ObjectDifferenceList
ICMP_ObjectList
ICMP_ObjectModelComparer
ICMP_ObjectPropertyDifference
ICMP_OutputFileInfo
ICMP_Pad
ICMP_ParameterList
ICMP_PasteMaskLayer
ICMP_PCBChangesApplier
ICMP_PCBChangesGrouper
ICMP_PCBComparer
ICMP_PCBDocument
ICMP_PCBGeometryConverter
ICMP_PCBObject
ICMP_PCBObjectFinder
ICMP_PCBObjectModelImporter
ICMP_PCBObjectsSerializer
ICMP_PCBThreeWayComparer
ICMP_PhysicalLayer
ICMP_Point
ICMP_PointList
ICMP_PolygonGeometry
ICMP_PolygonPour
ICMP_PrepregLayer
ICMP_Primitive
ICMP_PrimitiveList
ICMP_ProjectChanges
ICMP_PropertyDifference
ICMP_PropertyValue
ICMP_Rect
ICMP_RectGeometry
ICMP_Region
ICMP_RoundedRectGeometry
ICMP_SegmentGeometry
ICMP_SegmentGeometryList
ICMP_SilkScreenLayer
ICMP_SimplePropertyDifference
ICMP_SolderMaskLayer
ICMP_StackGeometry
ICMP_StackPrimitive
ICMP_StringList
ICMP_SubStack
ICMP_Text
ICMP_Track
ICMP_Via

Draftsman​

TypeDescription
IDraftsman_ArcItem
IDraftsman_AssemblyView
IDraftsman_BillOfMaterialsTable
IDraftsman_BoardDetailView
IDraftsman_CalloutItem
IDraftsman_CenterMarkItem
IDraftsman_CircleItem
IDraftsman_CommentsThreadItem
IDraftsman_ComponentView
IDraftsman_ConnectionTable
IDraftsman_CounterHoleView
IDraftsman_DatumFeatureItem
IDraftsman_DocumentData
IDraftsman_DocumentItem
IDraftsman_DocumentPage
IDraftsman_DocumentView
IDraftsman_DrillTable
IDraftsman_DrillView
IDraftsman_FabricationView
IDraftsman_FeatureControlFrameItem
IDraftsman_IsometricView
IDraftsman_LayerStackLegend
IDraftsman_LayoutDrawingView
IDraftsman_LineItem
IDraftsman_NoteItem
IDraftsman_PictureItem
IDraftsman_RealisticView
IDraftsman_RectangleItem
IDraftsman_RegionItem
IDraftsman_RegionView
IDraftsman_SectionView
IDraftsman_ServerInterface
IDraftsman_SurfaceFinishItem
IDraftsman_TableItem
IDraftsman_TextItem
IDraftsman_WiringDiagramView

Multi-board assembly and MCAD​

TypeDescription
IMBA_ArrayList
IMBA_CoreObjectDataModel
IMBA_DataModelFactory
IMBA_DocumentController
IMBA_DocumentDataModel
IMBA_Iterator
IMBA_Parameter
IMBA_ParameterList
IMBA_PartDataModel
IMBA_SceneObjectDataModel
IMBA_SceneObjectIterator
IMBA_SDK_CoreObjectDataModel
IMBA_SDK_DocumentController
IMBA_SDK_DocumentDataModel
IMBA_SDK_ECOProperties
IMBA_SDK_FileActionsController
IMBA_SDK_Mat4
IMBA_SDK_PartDataModel
IMBA_SDK_PartItemDataModel
IMBA_SDK_SceneController
IMBA_SDK_SceneObjectDataModel
IMBA_SDK_ServerDocument
IMBA_SDK_ServerModule
IMBA_SDK_Vec3
IMBA_SDK_ViewPort
IMBA_ServerDocument
IMBA_ServerModule
IMBA2_SDK_ArrayList
IMBA2_SDK_Component
IMBA2_SDK_CoreObject
IMBA2_SDK_DataModel
IMBA2_SDK_Document
IMBA2_SDK_DocumentView
IMBA2_SDK_Face
IMBA2_SDK_MatingItem
IMBA2_SDK_MatingPair
IMBA2_SDK_Part
IMBAMat4
IMBAMateSettings
IMBAMateSettingsWithOrientation
IMBAVec3
ISpaceBall
ISpaceBallListener
ISpaceBallVector

Comments​

TypeDescription
IComment
ICommentCarrier
ICommentCarrierCommandExecutor
ICommentDrawingItemCarrier
ICommentList
ICommentServerModule
ICommentService
ICommentThread
ICommentThreadGraphical
ICommentThreadList

Libraries, items and release​

TypeDescription
IAltiumLibrary
IAltiumLibraryManager
IAutomaticReleaseItem
IAutomaticReleaseProgressCallback
IAutomaticReleaser
IAutomaticReleaseResult
IConfigurationReleaseManager
IDItemModel
IDItemRevision
IDM_FSMState
IDM_FSMTransition
ILibraryInterface
IReleaseManager
IUnifiedDataModel
IUpdateParameterOptions
IVaultAspectSummary
IVaultConfiguration
IVaultConfigurationReleaseManager
IVaultItemDeleteNotificationHandler
IXLibCategory
IXLibEntity
IXLibEntityProvider
IXLibEntityReference
IXLibEnumTypeMetadata
IXLibEnumValueId
IXLibEnumValueMetadata
IXLibLString
IXLibObject
IXLibPropertyId
IXLibPropertyMetadata
IXLibReadOnlyDictionaryByString
IXLibReadOnlyList
IXLibTypeMetadata
IXLibTypeMetadataProvider
IXLibValue

Waveforms​

TypeDescription
IWaveDocumentPrint
IWavePreferences
IWavePrinterOptions
IWaveRow
IWaveRowGroup
IWaveSignal
IWaveSignalGroup
IWaveSimDocument
IWaveTransition
IWaveType
IWaveValue

Compiled design​

TypeDescription
IBlanket
IBusThe IBus interface represents a bus object on the schematic sheet.
IChannelClassThe IChannelClass interface is a PCB Channel class object interface for an existing Channel Class on a PCB document.
IComponentThe IChannelClass interface is a PCB Channel class object interface for an existing Channel Class on a PCB document.
IComponentClassThe IComponentClass interface is a PCB Component class object interface for an existing Component Class on a PCB document.
IComponentImplementationThe IComponentImplementation interface is associated with an IPart/IComponent interface in terms of model linking.
IComponentLibraryLink
IComponentMappingsThe IComponentMappings interface represents the mapping of source components and target components in schematic and PCB documents.
IComponentSearch
IConstraintThe IConstraint interface represents the data entry in a constraint file represented by the IConstraintGroup interface.
IConstraintGroupThe IConstraintGroup interface represents a constraint file made up of constraints (as IConstraint interface).
ICrossSheetThe ICrossSheet interface is a cross sheet connector object interface.
IDifferentialPairThe IDifferentialPair interface represents a differential pair object.
IDrawingItem
IEntityPortInherited from ISignalNode interface
IExternalParameterThe IExternalParameter interface defines the external parameter object
IHarnessDefinition
IHarnessDefinitionList
IHyperlink
IInstalledConstraintFilesThe IInstalledConstraintFiles interface represents the constraint files that are installed in Altium Designer, ie available to a FPGA project.
IInstance
IInstancePortInherited from ISignalNode interface
IItemParameter
ILineThe ILine interface is a line object interface for an existing line object on a Schematic document.
ILocatedHyperlink
ILocatedHyperlinkList
IModelIdentifier
INetThe INet interface is associated with an existing net object of a design document.
INetClassThe INetClass interface is a PCB Net Class object interface for an existing NetClass on a PCB document.
INetItemThe INetItem interface represents the ancestor or parent interface for the following interfaces - IBus, ICrossSheetConnector, IPin, IPort, INetlabel, ISheetEnt…
INetProperties
IObjectClassThe IObjectClass interface is the ancestor object class interface for Channel Class, Component Class and Net Class interfaces.
IObjectClassCluster
IParameterThe IParameter interface is a parameter object interface to an existing parameter object on a schematic sheet.
IParameterProperties
IPartThe IPart interface is the interface of an existing schematic part on a Schematic sheet.
IPartProperties
IPolylineDrawingItem
IRoomThe IRoom interface is a PCB room object.
IRuleThe IRule interface represents the one of the rules attached to a parameter within the PCB Layout directive (as a Parameter Set object with a small flag symbol…
ISheetSymbolThe ISheetSymbol interface is a sheet symbol interface to an existing sheet symbol object on the schematic.
ISignal
ISignalLink
ISignalManager
ISignalNode
ISubNet
IVHDLEntityThe IVhdlEntity interface represents the existing VHDL entity object on a VHDL document.

Enumerations​

TypeDescription
TActiveBomViewMode
TAddRemoveParameterOption
TAutomaticReleaseMode
TBoardViewSide
TBomDataSource
TBomExportEncoding
TBomIncludeNotFitted
TBomParameterSource
TBomParameterType
TBOMType
TBomViewMode
TBusKind
TChannelRoomNamingStyle
TCMP_ChangesKind
TCMP_LayerKind
TCMP_LayerOrientation
TCMP_OutputFileFormat
TCMP_PropertyDifferenceKind
TCommentThreadKind
TCompilationStage
TComponentKind
TConnectionCode
TControlFrameSymbol
TCrossSelectZoomOption
TDatabaseType
TDesignatorGroupingType
TDialogResult
TDifferenceCheckLevel
TDifferenceKind
TDocumentOpenMode
TDrawingDocumentItemType
TDrawingItemType
TDrawingLineSize
TECO_Mode
TErrorGroup
TErrorKind
TFieldType
TFilterKind
TFlattenMode
TFSMCodingStyle_DropDownList
TFSMEncodingStyle_DropDownList
THighlightMethod
TLibIdentifierKind
TLogicalState
TMBA_SDK_ControllerResult
TMBAMateOrientation
TMBAMateType
TMBAMeasurementSystem
TMBAObjectKind
TMBAPartType
TMBAUnit
TModificationKind
TNavigationAction
TNetScope
TOrthogonalRotation
TOutputCategory
TOutputJobVariantScope
TParameterKind
TPCBClassMemberKind
TPinElectrical
TPopupHorizontalAlignment
TPrintJobKind
TPrintKind
TPrintRange
TPrintScaleMode
TPrintWhat
TPublisherPageFlag
TReleaseDistributionPart
TSchematicNetlister
TSignalDirection
TSignalRange
TSignalStrength
TTemplateSource
TTimeRange
TTimeScale
TTOCObjectKind
TU3DFlag
TVariantGraphics
TVariationKind
TWaveFormat
TWaveRadix
TWaveTypeKind
TWorkspaceObjectId
TXPSplittingKind

Structures and classes​

TypeDescription
CMP_OutputFileInfo
CMP_Point
CMP_Rect
DocumentOutputValues
EDPConstant
InputValues
MBA_SDK_Mat4
MBA_SDK_Vec3
MBAMat4
MBAMateSettings
MBAMateSettingsWithOrientation
MBAVec3
ModelIdentifier
PageOptionsRecord
PrinterOptionsRecord
PrintParams
SCMP_OutputFileInfo
SCMP_Point
SCMP_Rect
SDocumentOutputValues
SInputValues
SMBA_SDK_Mat4
SMBA_SDK_Vec3
SMBAMat4
SMBAMateSettings
SMBAMateSettingsWithOrientation
SMBAVec3
SModelIdentifier
SpaceBallVector
SPageOptionsRecord
SPrinterOptionsRecord
SPrintParams
SSpaceBallVector
TBOMTypeSet
THighlightMethodSet
TNavigationActionSet
TPublisherPageFlagSet
TReleaseDistributionPartSet
TU3DFlagSet
TWorkspaceObjectIdSet
Utils

Other interfaces​

TypeDescription
IWrapper