Skip to main content

System

Namespace: DXP

The client application, servers and server modules, documents and views, commands, notifications, data management and version control.

Related namespaces:

  • Data management types (DXP.EDMS): Constants and value types used by the data management services, such as content and folder type identifiers.
  • Image service (Altium.Dxp.Interfaces): The image service interface and its enumerations.

522 interfaces, 66 enumerations, 108 structures and classes, 5 delegates.

Client and servers​

TypeDescription
IAnalyticsMonitor
IAnalyticsReporter
IClientA plug-in module loaded in Altium Designer has hooks to the single executable subsystem, so you have access to the specific documents and launch commands on th…
IClient2
IClientAPI_Interface
IClientAPI_OutsideChangesDetection
IClientAPI_OutsideChangesDetection2
ICommandGetState
ICommandLauncherThe ICommandLauncher interface encapsulates the functionality of launching a command (which is a pre packaged process) in Altium Designer.
IDXPExtensionManager
IDXPExtensionManagerSettings
IDXPProductBranding
IDXPSplash
IFeatureChecker
IIdleHandler
IIdleHandlerRegistrator
IInternalOptions
ILicenseExpirationInfo
ILicenseManager
ILogCallback
ILogger
ILogManager
IMacroEventListener
IMacroManager
IMacroManager2
IMacroProcessor
IPluginsPlatformVersions
IPluginsRegistry
IPluginsRegistryItem
IProcessControlThe IProcessControl interface controls the process depth for each design document in Altium Designer.
IProcessLauncherThis IProcessLauncher interface is a mechanism that launches a server process in Altium Designer.
IProcessLauncher2
IProcessLauncherInfo
IProductInfo
IScriptDirective
ISecurityManager
ISecurityServerManager
IServerInternalOptions
IServerInternalOptionsManager
IServerLicense
IServerModuleA server deals with its own server documents.
IServerModuleActionsSupport
IServerModuleNativeImport
IServerOptions
IServerPanelInfoThe IServerPanelInfo interface encapsulates the details of a panel in Altium Designer and the details can be Name, Bitmap, whether the panel can be docked hori…
IServerProcessThe IServerProcess interface returns information for commands (server processes) in a server installation file;
IServerRecordThis interface extracts the servers installation files information from the \System folder which has a list of server installation files.
IServerSecurity
IServerWindowKindThis IServerWindowKind interface reports the type of a design document in Altium Designer and it is a composite object used in IServerRecord and IClient interf…
ISupportService
IThreadSynchronize
ITimerHandlerEach timer object is represented by the ITimerHandler interface and all timer objects are managed by the ITimerManager interface.
ITimerManagerThe ITimerManager interface manages the timing mechanisms efficiently in Altium Designer which registers timer objects and calls them when used.
ITranslationManagerThe ITranslationManager interface deals with the installed locale languages for Altium Designer.

Documents and workspace​

TypeDescription
IClipboardDocument
ICommentedDocument
IDocumentBackups
IDocumentOptionsSet
IDocumentOptionsView
IDocumentPreviewHint
IDocumentPreviewManager
IDXPBomReader
IDXPDocument
IDXPFileBOM
IDXPProject
IDXPWorkSpace
IDXPWorkspaceHelper
IDXPWorkspacePreferences
IEmbeddableDocument
IFreeBinaryDocument
IFreeBinaryItem
ILocalHistoryManager
INavigationDocumentThe INavigationDocument interface represents a specific navigation view.
IPreviewableDocument
IReadonlySupportDocument
IReleasedItemDocument
ISaveLoadLayout
IServerDocumentThe IServerDocument interface represents the document container.
IServerDocument2
IServerDocumentEx
IServerDocumentViewThe IServerDocumentView represents either the document view or one of the associated panel views in Altium Designer.
ITextDocument
IToDoDocument
IUndoRedoSupport
IVaultPropertiesSupportDocument

Notifications and messages​

TypeDescription
BaseNotification
DataForDocumentNotification
DataForDragDropNotification
DataForEDMNotification
DocumentNotification
DragDropNotification
EDMNotification
GuiManagerNotification
IDataForAltiumPortalNotification
IDataForDocumentNotification
IDataForDocumentRequest
IDataForDragDropNotification
IDataForEDM_BatchReleaseNotification
IDataForEDM_InitiatePublishNotification
IDataForEDM_Notification
IDataForEDM_ReviewPackageReleaseNotification
IDataForEDM_UserLoggedInNotification
IDataForEDM_ValidateReviewReleaseNotification
IDataForModuleNotification
IDataForNexusNotificationWithInterface
IDataForProjectReleaseNotification
IDataForSoftDesignNotification
IDataForVCSNotification
IDataForWaveSimNotification
IDXPMessageItem
IDXPMessageItemDetails
IDXPMessagesManager
IDXPMessageSubItem
IDXPServer_Notification
IEDMS_NotificationService
IEDMS_NotificationServiceEvents
IEventNavigated
IGUIManagerNotification
IMessage
INotificationThe INotification interface is used by the IClient, IServerView, IServerDocument, IServerModule, INotificationHandler interfaces.
INotificationCodeList
INotificationHandlerThe INotificationHandler interface handles notifications broadcasted in the Altium Designer system.
INotificationTransmiter
IValidateStateTransitionNotification
IValidateStateTransitionNotificationEx
IVaultExplorerNotification
IVaultFileLessDocumentNotification
IVaultFileLessReleaseNotification
IViewWithNotificationFilter
IWebBrowserNotification
MessagesNotification
NotificationCode
NotificationCode.DocumentFormNotificationCode
NotificationCode.DocumentNotificationCode
NotificationCode.DocumentRequestCode
NotificationCode.DragDropNotificationCode
NotificationCode.DXPAltiumPortalCode
NotificationCode.EDMNotificationCode
NotificationCode.EDMPCBReleaseNotificationCode
NotificationCode.EventNavigatedCode
NotificationCode.GuiManagerNotificationCode
NotificationCode.MessagesNotificationCode
NotificationCode.ModuleNotificationCode
NotificationCode.NexusNotificationsCode
NotificationCode.SoftDesignNotificationCode
NotificationCode.SystemNotificationCode
NotificationCode.VCSNotificationCode
NotificationCode.ViewNotificationCode
NotificationHandler
NotificationHandlerCallback
NotificationType
SystemNotification
TVaultActionNotification
ViewNotification

Version control​

TypeDescription
ICloudVCSVcsProject
ICloudVCSVcsProvider
IGitVcsProject
ISVNConnectionString
ISVNVcsProvider
IVCSAddFilesSettings
IVcsBackgroundThread
IVcsBasedProjectCommands
IVcsConflictData
IVcsConflictDataList
IVcsDesignVault
IVcsDesignVault2
IVcsDesignVault3
IVcsFileNames
IVcsFileNamesFactory
IVcsManager
IVcsProject
IVcsProject2
IVcsProject3
IVcsProject4
IVcsProject5
IVcsProject6
IVcsProvider
IVcsProvider2
IVcsProvider3
IVCSRepository
IVCSResolveConflictCallback
IVcsRevisionInfo
IVcsRevisions
IVcsShareProject

Vaults, items and data management​

TypeDescription
IAspectPlugin
IAspectPluginEnumerator
IAspectView
IBatchItemNameGenerator
IBatchRelease
IBatchReleaseListener
IDMS_ConfigurationManager
IDragDropRevision
IDragDropVaultComponent
IDragDropVaultObject
IDXPAltiumPortal
IEDesignData_EventHandler
IEDesignData_GUIActions
IEDesignData_HWPart
IEDesignData_HWPartDocument
IEDesignData_Item
IEDesignData_PartChoiceList
IEDesignData_PartChoiceListDocument
IEDesignData_PreviewFrame
IEDesignData_ReleaseManager
IEDesignData_SupplyChainFrame
IEDesignData_SupplyChainFrame2
IEDesignData_VaultAspectItemsPopup
IEDesignData_VcsBasedProjectActions
IEDesignDataCommands
IEDesignDataInterface
IEDesignDataPanelView
IEDM_AsyncBasicResult
IEDM_AsyncCallback
IEDM_AsyncContext
IEDM_AsyncFileResult
IEDM_AsyncParametersMetadataResult
IEDM_AsyncRawSearchParametersResult
IEDM_AsyncRawSearchResult
IEDM_AsyncRawSearchValuesForParametersResult
IEDM_AsyncRawSearchValuesForTypedParametersResult
IEDM_AsyncResult
IEDM_AsyncResultList
IEDM_AsyncScriptResult
IEDM_AsyncSearchResult
IEDM_AsyncSimpleResult
IEDM_AsyncSuggestionsResult
IEDM_FileResult
IEDM_GroupsResult
IEDM_ItemsCountResult
IEDM_Object
IEDM_Parameter
IEDM_ParameterizedRecord
IEDM_ParameterMetadata
IEDM_ParametersMetadataResult
IEDM_RawSearchBaseOptions
IEDM_RawSearchOptions
IEDM_RawSearchParametersResult
IEDM_RawSearchResult
IEDM_RawSearchValuesForParametersResult
IEDM_RawSearchValuesForTypedParametersResult
IEDM_Record
IEDM_RecordResult
IEDM_RecordResultList
IEDM_ReleaseEntityData
IEDM_ReleaseLibrarySilentResult
IEDM_Result
IEDM_Script
IEDM_ScriptAtomicGroupResult
IEDM_ScriptCommandResult
IEDM_ScriptResult
IEDM_SearchCondition
IEDM_SearchConditionBooleanQuery
IEDM_SearchConditionBooleanQueryItem
IEDM_SearchConditionRangeQuery
IEDM_SearchConditionStrictQuery
IEDM_SearchConditionTerm
IEDM_SearchConditionWildcardQuery
IEDM_SearchFilter
IEDM_SearchFilterField
IEDM_SearchItem
IEDM_SearchOptions
IEDM_SearchResult
IEDM_ShareableRecord
IEDM_ShareManager
IEDM_SuggestionsResult
IEDM_User
IEDM_UsersResult
IEDMS_AFSManager
IEDMS_Comment
IEDMS_CommentsService
IEDMS_CommentsServicePreferences
IEDMS_CommentThread
IEDMS_CommentThreadHolder
IEDMS_Configuration
IEDMS_ConfigurationItem
IEDMS_DictionariesManagerWrapper
IEDMS_DictionaryListWrapper
IEDMS_DictionaryWideString
IEDMS_DictionaryWrapper
IEDMS_DiscoveryServiceManager
IEDMS_DXPServerManager
IEDMS_DXPServerUserInfo
IEDMS_EDS
IEDMS_EDSMessage
IEDMS_GetDXPServerManager
IEDMS_GridDataExporter
IEDMS_GridDataProvider
IEDMS_InterfaceContainer
IEDMS_LibraryItem
IEDMS_LibraryItems
IEDMS_LibraryService
IEDMS_LicensesInfo
IEDMS_LockedItem
IEDMS_ManagedProject
IEDMS_ManagedProjectItem
IEDMS_ManagedProjectParameter
IEDMS_ManagedProjectSharing
IEDMS_ManagedProjectsService
IEDMS_ManagedProjectsServicePreferences
IEDMS_ManagedUserItem
IEDMS_NamedInterfaceList
IEDMS_PairNamedInterface
IEDMS_PairWideString
IEDMS_PermissionSetWrapper
IEDMS_PermissionSetWrapper2
IEDMS_PlmSyncService
IEDMS_SearchTemplate
IEDMS_SearchTemplateHead
IEDMS_SearchTemplateSharing
IEDMS_SearchTemplatesService
IEDMS_SettingsService
IEDMS_SimpleLockService
IEDMS_SimpleParameter
IEDMS_SimpleParameters
IEDMS_Tag
IEDMS_Tags
IEDMS_TaskAllowedAssigns
IEDMS_TaskAssignmentRule
IEDMS_TaskAssignmentRuleGroup
IEDMS_TaskAssignmentRuleGroupData
IEDMS_TaskAssignmentRuleGroupDataList
IEDMS_TaskAssignmentRuleGroupList
IEDMS_TaskAssignmentRuleList
IEDMS_TaskAttachment
IEDMS_TaskAttribute
IEDMS_TaskAttributeList
IEDMS_TaskBase
IEDMS_TaskBaseExt
IEDMS_TaskExt
IEDMS_TaskLifeCycleRequest
IEDMS_TaskLifeCycleRequestExt
IEDMS_TaskPossibleActions
IEDMS_TaskSearchParams
IEDMS_TaskService
IEDMS_TaskState
IEDMS_TaskStateList
IEDMS_TaskStreamItem
IEDMS_TaskStreamItemChange
IEDMS_TaskStreamItemChangeList
IEDMS_TaskStreamList
IEDMS_TaskUserAction
IEDMS_TaskUserActionList
IEDMS_UserWorkspaceInfo
IEDMS_Vault
IEDMS_VaultFileCache
IEDMS_VaultManager
IEDMS_VCSManager
IEDMS_WideStringsList
IEDMSItemEditorCommands
IEMDS_Attribute
IEMDS_AttributeList
IExternalFolderAspectView
IExternalFolderDetailsFrame
IExternalRevisionDetailsFrame
IFolderAspectManager
IFolderAspectPlugin
IFolderAspectPluginEnumerator
IFolderAspectView
IFolderDetailsFrame
IFolderModalAction
IFolderSelectionHandler
IGeneratorRegistry
IHRIDGenerator
IItemRevisionPair
ILastRevisionsCache
ILastRevisionsCacheCallback
ILastRevisionsInfo
ILinkToVaultFrame
IPartChoicesManager
IPublishingDestination
IPublishingManager
IReleasable
IReleasableFolder
IReleasableGroup
IReleasedItemForm
IReleasedItemForm_ModalAction_FactoriesAccessible
IReleasedItemFormFactory
IReleaseVaultPanelView
IReservationResult
IRevisionAppectRegistry
IRevisionAspectManager
IRevisionDetailsFrame
IRevisionsView
ITransportSet
IULB_ACLEntriesResult
IULB_ACLEntry
IULB_AcquisitionPointer
IULB_Component
IULB_ComponentsResult
IULB_ContentType
IULB_ContentTypeLink
IULB_ContentTypesResult
IULB_DataFile
IULB_DataFolder
IULB_DataFoldersList
IULB_DataFoldersResult
IULB_Folder
IULB_FolderParameter
IULB_FoldersResult
IULB_FolderType
IULB_FolderTypesResult
IULB_GUIDsResult
IULB_Item
IULB_ItemLink
IULB_ItemLinksResult
IULB_ItemParameter
IULB_ItemRevision
IULB_ItemRevisionLink
IULB_ItemRevisionLinksResult
IULB_ItemRevisionLinkType
IULB_ItemRevisionLinkTypesResult
IULB_ItemRevisionNode
IULB_ItemRevisionNodesResult
IULB_ItemRevisionParameter
IULB_ItemRevisionsResult
IULB_ItemsResult
IULB_ItemTag
IULB_ItemTagsResult
IULB_Language
IULB_LanguagesResult
IULB_LifeCycleDefinition
IULB_LifeCycleDefinitionsResult
IULB_LifeCycleStage
IULB_LifeCycleState
IULB_LifeCycleStateChange
IULB_LifeCycleStateChangesResult
IULB_LifeCycleStatesResult
IULB_LifeCycleStateTransition
IULB_MoveRecord
IULB_Operation
IULB_OperationParameter
IULB_OperationsResult
IULB_ParametersResult
IULB_RevisionNameLevel
IULB_RevisionNamingScheme
IULB_RevisionNamingSchemesResult
IULB_Tag
IULB_TagFamiliesResult
IULB_TagFamily
IULB_TagsResult
IULB_URLResult
IULB_WhereUsedRelation
IULB_WhereUsedResult
IVaultAcquiredNode
IVaultAcquisitionResult
IVaultAcquisitionServer
IVaultExplorerForm
IVaultExplorerServer
IVEN_AddFolderListToForceRefresh
IVEN_AddNavigationWayPoint
IVEN_Broadcaster
IVEN_Folder_EmptyView
IVEN_Folder_ItemRevisionPlace
IVEN_Folder_ItemsDblClick
IVEN_Folder_ItemsLoaded
IVEN_Folder_ItemsSelectionChanged
IVEN_Folder_Refresh
IVEN_Manager
IVEN_Manager_RefreshView
IVEN_Manager_SaveState
IVEN_Revision_RefreshFolder
IVEN_Revision_VaultAction

Views, panels and user interface​

TypeDescription
IAssociatedWithBitmap
IBackForwardNavigator
ICategorizedServerView
IContextServerView
ICookieSetter
ICustomForm
IDocDataItemDragDropInfo
IDragDropDeviceSheet
IDragDropLibraryComponent
IDragDropObject
IDragDropServerModel
IDragDropTarget
IDynamicHelpManagerThis interface represents the Knowledge Center panel in Altium Designer.
IExternalActionItem
IExternalActionItemList
IExternalFormThis IExternalForm interface object has low level methods such as resizing and displaying the form.
IExternalFormHolderThe IExternalFormHolder interface represents the TExternalFormComponent object and holds the IExternalForm interface.
IExternalPaint
IFloatingWindow
IGUIManagerThe IGUIManager interface represents the Graphical User interface portions of the Altium Designer application such as resizing panels, checking for certain hot…
IHTMLViewExternalFormThe I HTMLViewExternalForm interface represents a HTML document.
IHTMLViewJavascriptMessageReceivedEvent
IHTMLViewLoadingStateChangedEvent
IHTMLViewLocationChangeEvent
IHTMLViewSetOnResourceResponseEvent
IHTMLViewWithEvents
IKeywordHighlight
IMenuItemAdapter
IMenuItemInvoke
IMenuItemWrapper
IMenuWrapper
IModalAction
IModalActionBrowseEditFolder
IModalActionFactory
IModalActionMoveFolder
IModalActionMoveItem
INavigateAttributes
INavigationProvider
INavigationSystemThe navigation system is the workhouse for the Navigation panel which is the center-piece for net connectivity for the design project.
INavigator
INavigatorView
IOptionsFormDataManager
IOptionsFormDataManagerExt
IOptionsManagerThe IOptionsManager interface deals with the options of a system wide Preferences dialog or project centric Project Options dialog.
IOptionsPageThe IOptionsPage interface represents the page of controls in the system wide Preferences dialog.
IOptionsReaderThe IOptionsReader interface reads values for options on a page in the system wide Preferences dialog or Project options dialog from the registry storage.
IOptionsStorage
IOptionsWriterThe IOptionsWriter interface writes values for options on a page in the system wide Preferences or Project options dialog to a registry storage.
IParametricView
IParametricViewRaw
IPreviewImage
IProjectDialogsFactory
IScene
ISceneManager
ISceneViewThe ISceneView interface represents a specific view.
ISearchManager
ISearchProvider
ISearchResults
IServerConnectionDialog
IServerViewThe IServerView interface is the ancestor interface for a document or panel view object interface.
ISizedControl
IStatusBarManager
ISupportExternalPaint
IToolChainOptionsStorage
IUIDialogManager
IUITheme
IUIThemeManager
IUIThemeSupport
IWebAppHostModule
IWebBrowser
IWebCookieManager
IWebSessionManager

Collections and values​

TypeDescription
IGUID
IIntegers
IInterfaceList
IInterfaces
IParameterValueConvertorFactory
IPercentState
IPoint
IRect
IRectangleD
IReportOutputOptions
IReportOutputTransformation
IStringsThe IStrings interface represents the strings container - more like a list of strings.
ItagLOGFONTW
ItagMSG
ItagSIZE
IWideStrings

Enumerations​

TypeDescription
CursorIndex
TAlignment
TaskDialogIcon
TaskDialogResult
TBrowseItemsOption
TBrowserOptions
TConfigItemType
TConfirmationOption
TCreateKind
TDialogResult
TDocumentsBarGrouping
TEDM_ACLUserScopeMode
TEDM_ObjectClass
TEDM_SearchConditionFieldType
TEDM_SearchConditionOccur
TEDMS_GetOption
TEDMS_VaultFlag
TEDMS_VaultMode
TErrorLevel
TFileModificationKind
TFileOwnershipWarningLevel
TFolderModalActionType
TFolderRefreshState
TFontQueryMode
TFontStyle
TFreeBinaryItemType
TGroupDataType
TJavascriptAction
TLocalComparisonDocumentType
TLocalComparisonRevisionType
TLoginOption
TLogLevel
TMacroManagerState
TManagedProjectParameterSource
TMatchFileNameKind
TModalActionResult
TOptionsRecImportMode
TPenStyle
TPluginAutoRunAction
TPluginsStatus
TProjectReleaseMode
TProviderType
TReleasedItemFormType
TRepositoryType
TReservationStatus
TRevisionLevel
TScriptAction
TShiftState
TSnippetCreationMode
TStateOfFeature
TSyncMode
TTaskConditionType
TTaskSortDirection
TTaskStateType
TTaskType
TTaskUserActionType
TULB_LifeCycleManagement
TULB_ReleasedFileType
TUpdateCheckFrequency
TVaultAcquiredNodeKind
TVaultExplorerPanels
TVcsAddFlag
TVcsCommand
TVcsResolutionResult
TVCSStatus

Structures and classes​

TypeDescription
BaseForm
BaseServerView
CommandHandler
CommandLauncher
ComponentLink
CParameter
CParameterList
DataForDocumentRequest
DocumentRequest
DXPConstant
DxpThemeManager
ExternalForm
ExternalFormComponent
FormWithHelp
GenericSet
GlobalVars
GUID
Hosts
ImageIndexMarkerCode
InterfaceList
MacroEventListener
Message
OptionsForm
OptionsFormDataManager
OptionsPage
Parameter
ParameterList
ParameterListConsts
Point
PrintUtils
ProcessControl
ProcessHelper
Rect
ServerDialog
ServerDocument
ServerDocumentEditorView
ServerDocumentPanelView
ServerDocView
ServerEditorForm
ServerModule
ServerPanelForm
ServerPanelView
ServerViewForm
SetHelper
SGUID
SMessage
SPoint
SRect
StagLOGFONTW
StagMSG
StagSIZE
StatusBarCommands
SupportService
SVCSAddFilesSettings
TagLOGFONTW
TagMSG
TagSIZE
TBrowseItemsOptionSet
TBrowserOptionsSet
TEDM_ObjectClassSet
TEDMS_GetOptionSet
TEDMS_VaultFlagSet
TFileOwnershipDetails
TFontStyleSet
TimerHandler
TLoginOptionSet
TPercentState
TransportSet
TShiftStateSet
TSysCharSet
TTaskStateTypeSet
TTaskUserActionTypeSet
TULB_ReleasedFileTypeSet
TVaultExplorerPanelsSet
TVcsAddFlagSet
TVCSStatusSet
Utils
VCSAddFilesSettings

Delegates​

TypeDescription
CommandProc
DelegateCreateOptionsPage
GetStateProc
HandleTimerEventCallback

Other interfaces​

TypeDescription
IDXPLocalComparisonCallback
IDXPLocalComparisonResult
IDXPNavigator
IDXPSVNDatabaseLibDocument