WSM API Types and Constants

Old Content - visit altium.com/documentation

Parent page: Technical Reference - Workspace Manager API

Workspace Manager API: Types and Constants Reference

The Workspace Manager API Types and Constants reference includes the following sections and content:

WorkSpace Enumerated Types
TChannelRoomNamingStyle
TCompilationStage
TCompilationStageSet
TCompileMode
TComponentKind
TDisplayMode
TECO_Mode
TErrorGroup
TErrorKind
TErrorKindSet
TErrorLevel
TErrorLevelSet
TFlattenMode
TFileOwnerShipWarningLevel
TFilterKind
TFlowState
THighlightMethod
THighlightMethod
TModificationKind
TNetScope (WSM)
TParameterKind
TPathMode
TPinElectrical (WSM)
TSearchMode
TSignalDirection
TSystemParameterKind
TSystemParameterKindSet
TVariationKind
TViolationTypeDescription
TWorkspaceObjectId
TWorkspaceObjectIdSet
Workspace Manager Constants Image Index Table WorkSpace Manager Functions
General Constants
Parameter Simulation Names
Document Kind Constants
File Ownership Constants
  Main Interfaces
Project and Document Interfaces
Object functions
Violation and Error Functions

 

WorkSpace Enumerated Types

The enumerated types are used for many of the WorkSpace Manager interfaces methods which are covered in this section. For example the IPart interface has a Function DM_ComponentKind : TComponentKind; method. You can use this Enumerated Types section to check what the range is for the TComponentKind type.

See also
Work Space Manager API Reference
TCompilationStage type
TCompileMode type
TECO_Mode type
TErrorGroup type
TErrorKind type
TErrorLevel type
TFlattenMode type
TFlowState type
TModificationKind type
TChannelRoomNamingStyle type
TNetScope type
TParameterKind type
TPinElectrical type
TSystemParmeterKind type
TVariationKind type
TSignalDirection type

TChannelRoomNamingStyle

TChannelRoomNamingStyle = (eChannelRoomNamingStyle_FlatNumericWithNames,
                           eChannelRoomNamingStyle_FlatAlphaWithNames,
                           eChannelRoomNamingStyle_NumericNamePath,
                           eChannelRoomNamingStyle_AlphaNamePath,
                           eChannelRoomNamingStyle_MixedNamePath);

TCompilationStage

TCompilationStage = (eCompilationStage_Compiling,eCompilationStage_Flattening);

TCompilationStageSet

TCompilationStageSet = Set of TCompilationStage;

TCompileMode

TCompileMode = (eCompile_None,eCompile_Document,eCompile_All,eCompile_Smart);

TComponentKind

TComponentKind = (eComponentKind_Standard,
                  eComponentKind_Mechanical,
                  eComponentKind_Graphical,
                  eComponentKind_NetTie_BOM,
                  eComponentKind_NetTie_NoBOM,
                  eComponentKind_Standard_NoBOM);

TDisplayMode

TDisplayMode = Byte; // one of 255 display modes

TECO_Mode

TECO_Mode = (eECO_PerformAction,
             eECO_ValidateAction,
             eECO_CheckSupportForAction);

TErrorGroup

TErrorGroup = (eErrorGroupDocument,
               eErrorGroupComponent,
               eErrorGroupParameters,
               eErrorGroupBus,
               eErrorGroupNet,
               eErrorGroupMisc);

TErrorKind

TErrorKind = (eError_OffGridObject,
              eError_OffDocumentObject,
              eError_MissingChildDocument,
              eError_MissingChildProject,
              eError_PortNotLinkedToSheetSymbol,
              eError_SheetEntryNotLinkedToPort,
              eError_DuplicateDocumentNumbers,
              eError_UnconnectedWire,
              eError_UnconnectedNetItem,
              eError_NetWithNoDrivingSource,
              eError_FloatingInputPinsOnNet,
              eError_DifferentConnectionCodesOnNet,
              eError_MultipleSameConnectionCodeOnNet,
              eError_MultipleNamesForNet,
              eError_AddingItemsFromHiddenNetToNet,
              eError_AddingHiddenNet,
              eError_PowerObjectScopeChange,
              eError_NetParameterInvalidName,
              eError_NetParameterInvalidValue,
              eError_MismatchedBusSectionOrdering,
              eError_MismatchedFirstGenericIndex,
              eError_MismatchedSecondGenericIndex,
              eError_MismatchedIOTypeOnBus,
              eError_BusIndexOutOfRange,
              eError_RangeSyntaxError,
              eError_IllegalBusDefinition,
              eError_IllegalBusRangeValue,
              eError_MismatchedBusWidths,
              eError_MismatchedBusLabelOrdering,
              eError_MixedGenericAndNumericBusLabels,
              eError_UnDesignatedPart,
              eError_DuplicateComponentDesignator,
              eError_DuplicateSheetSymbolDesignator,
              eError_DuplicateNets,
              eError_DuplicatePinsInComponent,
              eError_DuplicateSheetEntrysInSheetSymbol,
              eError_DuplicatePortsInDocument,
              eError_DuplicateSubParts,
              eError_MismatchedHiddenPinConnections,
              eError_MismatchedPinVisibility,
              eError_SameParameterWithDifferentValues,
              eError_SameParameterWithDifferentTypes,
              eError_MissingModel,
              eError_ModelInDifferentLocation,
              eError_MissingModelInFile,
              eError_DuplicateModelsFound,
              eError_MissingModelParameter,
              eError_ErrorInModelParameter,
              eError_DuplicatePinsInPortMap,
              eError_MissingPinInPortMap,
              eError_MissingPinsPortMapSequence,
              eError_DuplicateImplementation,
              eError_UnusedPartInComponent,
              eError_ExtraPinInComponentDisplayMode,
              eError_MissingPinInComponentDisplayMode,
              eError_MismatchedBusAndWire,
              eError_FloatingNetLabel,
              eError_FloatingPowerObject,
              eError_SinglePinNet,
              eError_SignalWithNoLoad,
              eError_SignalWithNoDriver,
              eError_SignalWithMultipleDrivers,
              eError_AutoAssignedPin,
              eError_NoError,
              eError_MultipleTopLevelDocuments,
              eError_MultipleConfigurationTargets,
              eError_ConflictingConstraints,
              eError_MissingConfigurationTarget,
              eError_DuplicateUniqueIDs,
              eError_DifferentialPairMissingPositiveNet,
              eError_DifferentialPairMissingNegativeNet,
              eError_DifferentialPairSameNetInMultiplePairs,
              eError_DifferentialPairMisConnected,
              eError_DifferentialPairInversedPolarity,
              eError_DifferentialPairUnconnectedNet);

TErrorKindSet

TErrorKindSet = Set of TErrorKind;

TErrorLevel

TErrorLevel = (eErrorLevelNoReport,eErrorLevelWarning,eErrorLevelError,eErrorLevelFatal);

TErrorLevelSet

TErrorLevelSet = set of TErrorLevel;

TFlattenMode

TFlattenMode = (eFlatten_Smart,eFlatten_Flat,eFlatten_Hierarchical,eFlatten_Global);

TFileOwnerShipWarningLevel

TFileOwnershipWarningLevel = (eFileOwnershipWarningLevel_None, eFileOwnershipWarningLevel_Message, eFileOwnershipWarningLevel_Dialog);

TFilterKind

TFilterKind = (eFilter_All,
               eFilter_Documents,
               eFilter_Projects,
               eFilter_Workspaces,
               eFilter_ProjectSource_PCB,
               eFilter_ProjectSource_FPGA,
               eFilter_ProjectSource_Core,
               eFilter_ProjectSource_EMB,
               eFilter_ProjectSource_ILB,
               eFilter_ECOFiles,
               eFilter_ProjectSource_SCR);

TFlowState

TFlowState = (eState_UpToDate,eState_OutOfDate,eState_Failed,eState_Missing,eState_Running,eState_None);

THighlightMethod

THighlightMethod = (eHighlight_Filter,eHighlight_Zoom,eHighlight_Select,eHighlight_Graph,eHighlight_Dim,eHighlight_Thicken, eHighlight_ZoomCursor);

THighlightMethod

THighlightMethodSet = Set Of THighlightMethodSet;

TModificationKind

TModificationKind =
   ( eModification_Unknown,
     eModification_RemoveNode,
     eModification_RemoveComponentClassMember,
     eModification_RemoveNetClassMember,
     eModification_RemoveChannelClassMember,
     eModification_RemoveRule,
     eModification_RemoveNet,
     eModification_RemoveComponent,
     eModification_ChangeComponentFootPrint,
     eModification_ChangeComponentComment,
     eModification_ChangeComponentDesignator,
     eModification_ChangeComponentKind,
     eModification_AnnotateComponent,
     eModification_AddComponent,
     eModification_ChangeNetName,
     eModification_AddNet,
     eModification_AddNode,
     eModification_RemoveComponentClass,
     eModification_RemoveNetClass,
     eModification_RemoveDifferentialPair,
     eModification_RemoveChannelClass,
     eModification_ChangeComponentClassName,
     eModification_ChangeNetClassName,
     eModification_ChangeDifferentialPairPositiveNetName,
     eModification_ChangeDifferentialPairNegativeNetName,
     eModification_ChangeChannelClassName,
     eModification_AddComponentClass,
     eModification_AddNetClass,
     eModification_AddDifferentialPair,
     eModification_AddChannelClass,
     eModification_AddComponentClassMember,
     eModification_AddNetClassMember,
     eModification_AddChannelClassMember,
     eModification_RemoveRoom,
     eModification_ChangeRoom,
     eModification_AddRoom,
     eModification_AddParameter,
     eModification_RemoveParameter,
     eModification_ChangeParameterName,
     eModification_ChangeParameterValue,
     eModification_ChangeParameterType,
     eModification_AddRule,
     eModification_ChangeRule,
     eModification_FullPartUpdate,
     eModification_UpdatePartSymbol,
     eModification_UpdateImplementationValues,
     eModification_AddImplementation,
     eModification_RemoveImplementation,
     eModification_UpdateCurrentImplementation,
     eModification_ChangePinName,
     eModification_ChangePinElectrical,
     eModification_ChangePortElectrical,
     eModification_SwapPin,
     eModification_ChangePinSwapId_Pin,
     eModification_AddConstraintGroup,
     eModification_RemoveConstraintGroup,
     eModification_AddPort,
     eModification_RemovePort,
     eModification_ChangePortName,
     eModification_ChangeComponentLibRef,
     eModification_ChangePin,
     eModification_ChangePhysicalFootPrint,
     eModification_ChangeSubPartID,
     eModification_ChangeLibraryReference);

TNetScope (WSM)

TNetScope = (eScopeLocal,eScopeInterface,eScopeGlobal);

TParameterKind

TParameterKind = (eParameterKind_String,
                  eParameterKind_Boolean,
                  eParameterKind_Integer,
                  eParameterKind_Float);

TPathMode

TPathMode = (ePathAbsolute,ePathRelative);

TPinElectrical (WSM)

TPinElectrical    = (eElectricInput,
                     eElectricIO,
                     eElectricOutput,
                     eElectricOpenCollector,
                     eElectricPassive,
                     eElectricHiZ,
                     eElectricOpenEmitter,
                     eElectricPower);

TSearchMode

TSearchMode = (eSearchModeCurrentDatabase,
               eSearchModeSpecifiedDatabase,
               eSearchModeMultipleDatabases,
               eSearchmodeWitnodwsFileSystem);

TSignalDirection

TSignalDirection = (eSignalUndefined,eSignalInput,eSignalOutput,eSignalInOut);

TSystemParameterKind

TSystemParameterKind = (eSystemParameter_UserDefined,
                        eSystemParameter_CurrentTime,
                        eSystemParameter_CurrentDate,
                        eSystemParameter_Time       ,
                        eSystemParameter_Date       ,
                        eSystemParameter_DocFullPath,
                        eSystemParameter_DocName    ,
                        eSystemParameter_ModifiedDate,
                        eSystemParameter_ApprovedBy  ,
                        eSystemParameter_CheckedBy   ,
                        eSystemParameter_Author      ,
                        eSystemParameter_CompanyName ,
                        eSystemParameter_DrawnBy     ,
                        eSystemParameter_Engineer    ,
                        eSystemParameter_Organization,
                        eSystemParameter_Address1    ,
                        eSystemParameter_Address2    ,
                        eSystemParameter_Address3    ,
                        eSystemParameter_Address4    ,
                        eSystemParameter_Title       ,
                        eSystemParameter_DocNum      ,
                        eSystemParameter_Revision    ,
                        eSystemParameter_SheetNum    ,
                        eSystemParameter_SheetCount  ,
                        eSystemParameter_Rule        ,
                        eSystemParameter_ImagePath   ,
                        eSystemParameter_ConfigurableComponent,
                        eSystemParameter_Configuratorname);

TSystemParameterKindSet

TSystemParameterKindSet = Set of TSystemParameterKind;

TVariationKind

TVariationKind = (eVariation_None,eVariation_NotFitted,eVariation_Alternate);

TViolationTypeDescription

TViolationTypeDescription = Record
    DefaultLevel : TErrorevel;
    Group        : TErrorGroup;
    Description  : TDynamicString;
End;

TWorkspaceObjectId

TWorkspaceObjectId =
  (
{Abstract Objects}
    eIdAbstractObject,
    eIdConnective,
    eIdConnectiveList,
 
{Workspaces}
    eIdWorkspace,
 
{Projects}
    eIdProjectBoardLevel,
    eIdProjectFPGA,
    eIdProjectCore,
    eIdProjectEmbedded,
    eIdProjectLibrary,
    eIdProjectScript,
    eIdProjectFreeDocuments,
 
{Documents}
    eIdSourceDocument,
    eIdDocumentGeneric,
    eIdDocumentSCH,
    eIdDocumentSCHLIB,
    eIdDocumentPCBLIB,
    eIdDocumentFlattened,
    eIdDocumentEDIF,
    eIdDocumentVHDL,
    eIdDocumentVERILOG,
    eIdDocumentProtelNetlist,
    eIdDocumentPCADNetlist,
    eIdDocumentPCB,
    eIdDocumentCUPL,
    eIdDocumentAdvSimModel,
    eIdDocumentAdvSimSubCircuit,
    eIdDocumentIntegratedLib,
    eIdDocumentConstraints,
    eIdDocumentPCadPcb,
    eIdDocumentPCadLib,
    eIdDocumentWave,
    eIdDocumentLogicAnalyser,
 
{Electrical Objects}
    eIdNet,
    eIdBus,
    eIdConstraint,
    eIdConstraintGroup,
    eIdPart,
    eIdFullComponent,
    eIdFullComponentInstance,
    eIdImplementation,
    eIdParameter,
    eIdSheetSymbol,
    eIdTextFrame,
    eIdComponentClass,
    eIdNetClass,
    eIdDifferentialPair,
    eIdChannelClass,
    eIdRule,
    eIdRoom,
    eIdPin,
    eIdSheetEntry,
    eIdNetLabel,
    eIdPowerObject,
    eIdCrossSheet,
    eIdPort,
 
{InternalObjects}
    eIdDifference,
    eIdDifferenceManager,
    eIdModification,
    eIdChangeManager,
    eIdViolation,
    eIdViolationManager,
    eIdComponentMapManager,
    eIdVariantManager,
    eIdVHDLEntity,
    eIdConfiguration,
 
{Spatial Analysis Objects}
    eIdDirective,
    eIdSpatialLine,
    eIdSpatialAnalyser,
    eIdSpatialCompileMask,
 
{Document Readers}
    eIdReaderSCH,
    eIdReaderSCHLIB,
    eIdReaderPCBLIB,
    eIdReaderEDIF,
    eIdReaderCUPL,
    eIdReaderScript,
    eIdReaderVHDL,
    eIdReaderVerific,
    eIdReaderProtelNetlist,
    eIdReaderPCADNetlist,
    eIdReaderPCB,
    eIdReaderAdvSimLib,
 
{Cam Objects}
    eIdCamOutputDoc,
    eIdCamView,
    eIdCamJob,
{Printer Objects}
    eIdGeneratedPage,
    eIdPrintView,
    eIdPrinterJob,
    eIdPrinter,
 
    eIdSignalManager,
    eIdSignal,
    eIdSignalNode,
    eIdSignalLink,
    eIdSubNet,
    eIdEntityPort,
    eIdInstancePort,
    eIdInstance,
    eIdExternalObject);

TWorkspaceObjectIdSet

TWorkspaceObjectIdSet = Set Of TWorkspaceObjectId;

 

Workspace Manager Constants

General Constants

cStimulusParameterName = 'Stimulus';
cProbeParameterName    = 'Probe';
cAnyCompilationStage : TCompilationStageSet = [Low(TCompilationStage).. High(TCompilationStage)];
cAnyErrorLevel       : TErrorLevelSet       = [Low(TErrorLevel)      .. High(TErrorLevel)];
cAnyErrorKind        : TErrorKindSet        = [Low(TErrorKind)       .. High(TErrorKind)];
 
cCompilationStageStrings : Array[TCompilationStage] Of TString = ('Compilation','Flattening');
cErrorLevelStrings       : Array[TErrorLevel]       Of TString = ('No Report','Warning','Error','Fatal Error');
 
cImageIndex_ErrorLevels  : Array[TErrorLevel]       Of Integer = (cImageIndexMarker_NoError, cImageIndexMarker_Warning,
 cImageIndexMarker_Error,   cImageIndexMarker_Fatal);
 
cNetScopeString          : Array[TNetScope] Of TString = ('Local To Document','Sheet Interface','Global');
cVendorACTEL  : TDynamicString              = 'Actel';
 
cMiscellaneous           = 'Miscellaneous';
cCanFastCrossSelect_Emit = 'CanFastCrossSelect_Emit';
 
cDatabase_KeyFieldDelimiter  = '[[/\]]';
 
cSystemParameterNames : Array[TSystemParameterKind] Of TString  = (
    'User defined',
    'CurrentTime',
    'CurrentDate',
    'Time',
    'Date',
    'DocumentFullPathAndName',
    'DocumentName',
    'ModifiedDate',
    'ApprovedBy',
    'CheckedBy',
    'Author',
    'CompanyName',
    'DrawnBy',
    'Engineer',
    'Organization',
    'Address1',
    'Address2',
    'Address3',
    'Address4',
    'Title',
    'DocumentNumber',
    'Revision',
    'SheetNumber',
    'SheetTotal',
    'Rule',
    'ImagePath',
    'ConfigurationParameters',
    'ConfiguratorName');
 
cDocumentSystemParameters : Set Of TSystemParameterKind = [
    eSystemParameter_UserDefined ,
    eSystemParameter_CurrentTime ,
    eSystemParameter_CurrentDate ,
    eSystemParameter_Time        ,
    eSystemParameter_Date        ,
    eSystemParameter_DocFullPath ,
    eSystemParameter_DocName     ,
    eSystemParameter_ModifiedDate,
    eSystemParameter_ApprovedBy  ,
    eSystemParameter_CheckedBy   ,
    eSystemParameter_Author      ,
    eSystemParameter_CompanyName ,
    eSystemParameter_DrawnBy     ,
    eSystemParameter_Engineer    ,
    eSystemParameter_Organization,
    eSystemParameter_Address1    ,
    eSystemParameter_Address2    ,
    eSystemParameter_Address3    ,
    eSystemParameter_Address4    ,
    eSystemParameter_Title       ,
    eSystemParameter_DocNum      ,
    eSystemParameter_Revision    ,
    eSystemParameter_SheetNum    ,
    eSystemParameter_SheetCount  ,
    eSystemParameter_Rule        ,
    eSystemParameter_ImagePath
];
    cMiscellaneous           = 'Miscellaneous';
    cCanFastCrossSelect_Emit = 'CanFastCrossSelect_Emit';

Parameter Simulation Names

cParameterName_SimulationFile           = 'Simulation File';
cParameterName_SimulationKind           = 'Simulation Kind';
cParameterName_SimulationSubKind        = 'Simulation SubKind';
cParameterName_SimulationSpicePrefix    = 'Simulation SpicePrefix';
cParameterName_SimulationExcludedParts  = 'Simulation ExcludedParts';
cParameterName_SimulationNetList        = 'Simulation Netlist';
cParameterName_SimulationDescription    = 'Simulation Description';
cParameterName_SimulationModelName      = 'Simulation ModelName';
cParameterName_SimulationPortMap        = 'Simulation PortMap';
cParameterName_SimulationParameters     = 'Simulation Parameters';

Document Kind Constants

cDocKind_Asm                     =  'ASM';
cDocKind_C                       =  'C';
cDocKind_Camtastic               =  'CAMTASTIC';
cDocKind_Ckt                     =  'CKT';
cDocKind_Constraint              =  'CONSTRAINT';
cDocKind_CoreProject             =  'COREPROJECT';
cDocKind_Cupl                    =  'CUPL';
cDocKind_DatabaseLink            =  'DATABASELINK';
cDocKind_DatabaseLib             =  'DATABASELIB';
cDocKind_Disassembly             =  'DISASSEMBLY';
cDocKind_Edif                    =  'EDIF';
cDocKind_EditScript              =  'EDITSCRIPT';
cDocKind_EditScriptDSUnit        =  'EDITSCRIPTDSUNIT';
cDocKind_EditScriptDSForm        =  'EDITSCRIPTDSFORM';
cDocKind_EditScriptBasUnit       =  'EDITSCRIPTBAS';
cDocKind_EditScriptTclUnit       =  'EDITSCRIPTTCL';
cDocKind_EditScriptVBSUnit       =  'EDITSCRIPTVBSUnit';
cDocKind_EditScriptVBSForm       =  'EDITSCRIPTVBSForm';
cDocKind_EditScriptJSUnit        =  'EDITSCRIPTJSUNIT';
cDocKind_EditScriptJSForm        =  'EDITSCRIPTJSForm';
cDocKind_EmbeddedProject         =  'EMBEDDEDPROJECT';
cDocKind_FavLink                 =  'FAVLINK';
cDocKind_Fpgaflow                =  'FPGAFLOW';
cDocKind_FpgaProject             =  'FPGAPROJECT';
cDocKind_FpgaWorkspace           =  'FPGAWORKSPACE';
cDocKind_FreeDocsProject         =  'FREEDOCSPROJECT';
cDocKind_Html                    =  'HTML';
cDocKind_Xml                     =  'XML';
cDocKind_HtmlHelp                =  'HTMLHELP';
cDocKind_IntegratedLibrary       =  'INTEGRATEDLIBRARY';
cDocKind_IntLibrary              =  'INTLIBRARY';
cDocKind_LogicAnalyser           =  'LogicAnalyser';
cDocKind_LogicAnalyserAnalog     =  'LogicAnalyserAnalog';
cDocKind_Mdl                     =  'MDL';
cDocKind_Nsx                     =  'NSX';
cDocKind_OutputJob               =  'OUTPUTJOB';
cDocKind_PCADPCB                 =  'PCADPCB';
cDocKind_Pcb                     =  'PCB';
cDocKind_Situs                   =  'SITUS';
cDocKind_Pcb3DLib                =  'PCB3DLIB';
cDocKind_PcbLib                  =  'PCBLIB';
cDocKind_PCADLIB                 =  'PCADLIB';
cDocKind_PcbProject              =  'PCBPROJECT';
cDocKind_PDF                     =  'PDF';
cDocKind_PickATask               =  'PICKATASK';   
cDocKind_Profiler                =  'PROFILER';
cDocKind_ProjectGroup            =  'PROJECTGROUP';
cDocKind_ProtelNetlist           =  'PROTELNETLIST';
cDocKind_Sch                     =  'SCH';
cDocKind_Schlib                  =  'SCHLIB';
cDocKind_ScriptProject           =  'SCRIPTPROJECT';
cDocKind_Simdata                 =  'SIMDATA';
cDocKind_SIPinModelLibrary       =  'SIPINMODELLIBRARY';
cDocKind_Targets                 =  'TARGETS';
cDocKind_Text                    =  'TEXT';
cDocKind_Vhdl                    =  'VHDL';
cDocKind_Verilog                 =  'VERILOG';
cDocKind_VhdLib                  =  'VHDLIB';
cDocKind_VhdlSim                 =  'VHDLSIM';
cDocKind_VhdTst                  =  'VHDTST';
cDocKind_VerTst                  =  'VERTST';
cDocKind_VQM                     =  'VQM';
cDocKind_Wave                    =  'WAVE';
cDocKind_WaveSim                 =  'WAVESIM';
cDocKind_DefaultPcb              =  'DefaultPcb';
cDocKind_DefaultPcbLib           =  'DefaultPcbLib';
cDocKind_SchTemplate             =  'SCHDOT';
cDocKind_DDB                     = 'DDB';
 
cDocKind_ORCAD7_DSN              = 'ORCAD7_DSN';
cDocKind_ORCAD7_OLB              = 'ORCAD7_OLB';
cDocKind_ORCAD7_MAX              = 'ORCAD7_MAX';
cDocKind_ORCAD7_OLB              = 'ORCAD7_OLB';
cDocKind_ORCAD7_LLB              = 'ORCAD7_LLB';
cDocKind_ORCAD7_CIS              = 'ORCAD7_CIS';
 
cDocKind_PCAD16_PCB              = 'PCAD16_PCB';
cDocKind_PCAD16_BIN_PCB          = 'PCAD16_BIN_PCB';
cDocKind_PCAD16_NETLIST          = 'PCAD16_NETLIST';
cDocKind_PCAD16_SCH              = 'PCAD16_SCH';
cDocKind_PCAD16_BIN_SCH          = 'PCAD16_BIN_SCH';
cDocKind_PCAD16_LIA              = 'PCAD16_LIA';
cDocKind_OLD_PCAD_LIB            = 'OLD_PCAD_LIB';
cDocKind_CIRCUITMAKER2000_CKT    = 'CM2000_CKT';
cDocKind_CIRCUITMAKER2000_LIB    = 'CM2000_LIB';
cDocKind_CIRCUITMAKER2000_DEVLIB = 'CM2000_DEVLIB';
cDocKind_PADS_PCB                = 'PADS_PCB';
cDocKind_NGC                     = 'NGC';

File Ownership Constants

cDefaultFileOwnership_Enabled                = False;
cDefaultFileOwnership_WarningLevelSave       = eFileOwnershipWarningLevel_Dialog;
cDefaultFileOwnership_WarningLevelOpen       = eFileOwnershipWarningLevel_Dialog;
cDefaultFileOwnership_EnabledOutputDirectory = False;
 
cFileOwnershipWarningLevelStrings : Array[TFileOwnershipWarningLevel] of TDynamicString =
(
   'No warning',
   'Warning in Message Panel',
   'Warning in Dialog box'
);

 

Image Index Table

The Message panel has icons which specify messages. The DM_AddMessage and DM_AddMessageParametric methods of the IWorkSpace interface require an icon.

Image Index Table

Index                          = -1; IndexTick =  3; IndexNoERC = 3;
IndexCross                     =  4; IndexConnective =  4; IndexConnectiveList =  6
Folder                         =  6; IndexFreeDocumentsProject = 6 IndexSheetFileName             = 15;
OpenDocument                   = 68; CloseDocument                  = 69; NewFromExistingDocument   = 70;
IndexProjectGroup              = 54; IndexProjectGroup2             = 55; IndexPcbLayer                  = 51;
IndexEmptySection              =  9; IndexCamJob                    = 67; IndexBoardProject              = 56;
IndexFpgaProject               = 57; IndexEmbeddedProject           = 58; IndexIntegratedLibrary = 59;
Search                         = 38; SearchSelected                 = 39; IndexPCB  = 52;
IndexPCBVariant                = 53; IndexParameter                 = 24; IndexDocumentList  = 26;
IndexEdifDocument  = 43; IndexEdifDocumentSelected      = 43;  IndexGenericDocument           = 62;
IndexTextFile                  = 62; IndexCUPLFile                  = 63; IndexAdvSimModel               = 64;
IndexAdvSimNSX                 = 48;  IndexAdvSimSubCircuit          = 47; IndexBasicScript               = 65;
IndexDelphiScript              = 66; IndexCFile                     = 45; IndexVHDLDocument              = 44;
IndexVHDLDocumentSelected = 44; IndexVHDLLibrary               = 44; IndexSheetSymbolList           = 30;
HierarchyNets                  = 30; IndexPartList                  = 32; IndexPinList                   =  5;
IndexTextFrameList             = 28; IndexProtelNetlistFile         = 46; IndexSchematicSheetSelected = 10
IndexSchematicSheet            = 15; IndexSchematicLibrary          = 32; IndexFlattenedHierarchy        = 15;
IndexPCBLibrary                = 40; IndexNet                       =  1;  IndexBus                       = 21;
IndexBusEntry                  = 74; IndexPart                      =  2; IndexComponent                 = 20;
IndexFootprint                 = 36; IndexSubPart                   =  2; IndexImplementation            =  8;
IndexSheetSymbol               = 13; IndexTextFrame                 = 18; IndexPin                       = 19;
IndexPad                       = 41; IndexHiddenName                = 19; IndexNetLabel                  = 22;
IndexPowerObject               = 16;  IndexPort                      = 17; IndexSheetEntry                = 14;
IndexViolation                 =  4; IndexDesignatorMapping         =  2 IndexDesignatorManager         =  8;
IndexModification              =  4; IndexModificationList          =  9; IndexDifference                =  4;
IndexDifferenceList            =  8; IndexNetParameter              = 24; IndexSchematicSheetProcessor = 15
IndexSchematicLibraryProcessor = 15; IndexEdifDocumentProcessor     = 15; IndexVHDLDocumentProcessor = 15;
IndexVHDLLibraryProcessor      = 15; IndexNetlistFileProcessor      = 15; IndexBoardProcessor            = 15;
IndexSpatialAnalyser           = 15; IndexBusSection                = 21; IndexBusElement                = 34;
IndexErrorList                 = 6; IndexSpatialLine               = 1; IndexComponentClass            = 7;
IndexNetClass                  = 7; IndexRule                      = 2; IndexRoom                      = 3;
IndexGraphic                   = 75; IndexJunction                  = 76; IndexAnnotation                = 77;
IndexBrowserNetIdentifiers     = 78; IndexLibRef                    = 79; IndexComponentParameters  = 80;
IndexSheetSymbolParameters     = 81; IndexPortParameters            = 82; IndexPinParameters             = 83;
IndexErrorMarker               = 84; IndexParameterSet              = 85; IndexPinsAndParts              = 86;
IndexRectangle                 = 87; IndexArc                       = 88; IndexEllipticalArc             = 89;
IndexRoundRectangle            = 90; IndexDesignator                = 91; Indexellipse                   = 92;
IndexPie                       = 93; IndexPolygon                   = 94; IndexPolyline                  = 95;
IndexBezier                    = 96; IndexSheetName                 = 97; IndexSymbol                    = 98;
IndexTaskHolder                = 99 IndexFolder_NoError            = 6; IndexFolder_Warning            = 7;
 IndexFolder_Error              = 8; IndexFolder_Fatal              = 9; IndexGeneratedPage             = 33;
IndexPrintView                 = 61; IndexPrinterJob                = 67; IndexPrinter                   = 49;
IndexOutput                    = 61; IndexAlias                     = 71; IndexAliases                   = 72;
IndexOffsheetPin               = 73; IndexOffSheetPart              = 100; IndexOffSheetNet               = 101;
IndexOffSheetBus               = 102; IndexOffSheetPort              = 103; IndexOffSheetSheetEntry        = 104;
IndexOffSheetNetLabel          = 105; IndexOffSheetPowerObject       = 106; IndexMarker_NoError            = 107;
IndexMarker_Warning            = 108; IndexMarker_Error              = 109; IndexMarker_Fatal              = 110;
Index_MainHotSpot1             = 0; Index_MainHotSpot2             = 1; Index_MainHotSpot3             = 2;
Index_MainHotSpot4             = 3; Index_MainHotSpot5             = 4; Index_MainHotSpot6             = 5;
Index_MainHotSpot7             = 6;  Index_MainHotSpot8             = 7; Index_MainHotSpot9             = 8;
Index_MainHotSpot10            = 9;    

See also
Work Space Manager API Reference

 

WorkSpace Manager Functions

Main Interfaces

Function WSMServer    : IWSM_ServerInterface;
Function GetWorkspace : IWorkspace;

Project and Document Interfaces

Function GetProjectOfDocument(Const ADocPath : WideString) : IProject;
Function IsFreeDocument(Const FileName : WideString) : LongBool;

Object functions

Function IsBusConnector(ALibReference : TDynamicString) : Boolean;

Violation and Error Functions

Function GetViolationTypeInformation(ErrorKind : TErrorKind) : TViolationTypeDescription;
Function GetViolationTypeDescription(ErrorKind : TErrorKind) : TDynamicString;
Function GetViolationTypeDefaultLevel(ErrorKind : TErrorKind) : TErrorLevel;
Function GetViolationTypeGroup(ErrorKind : TErrorKind) : TErrorGroup;
Function GetErrorLevelColor(ErrorLevel : TErrorLevel) : TColor;
See also
Work Space Manager API Reference
IProject interface
TColor type
TDynamicString type
TErrorLevel type
TErrorGroup type
TViolationTypeDescription type

You are reporting an issue with the following selected text and/or image within the active document:
ALTIUM DESIGNER FREE TRIAL
Altium Designer Free Trial
Let’s get started. First off, are you or your organization already using Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

In that case, why do you need an evaluation license?

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

Got it. You actually don’t need an evaluation license for that.

Click the button below to download the latest Altium Designer installer.


Download Altium Designer Installer

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

Please fill out the form below to get a quote for a new seat of Altium Designer.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

If you are on Altium Subscription, you don’t need an evaluation license.

If you are not an active Altium Subscription member, please fill out the form below to get your free trial.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Why are you looking to evaluate Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

You came to the right place! Please fill out the form below to get your free trial started.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Sounds exciting! Did you know we offer special discounted student licenses? For more information, click here.

In the meantime, feel free to request a free trial by filling out the form below.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

That’s great! Making things is awesome. We have the perfect program for you.

Upverter is a free community-driven platform designed specifically to meet the needs of makers like you.

Click here to give it a try!

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.