Search In: Doc:Documentation: Altium Designer
Altium DesignerAltium 365Altium MCAD CoDesignerAltium On-Prem Enterprise ServerAltium CircuitMakerAltium CircuitStudioCompany DashboardAltium Infrastructure Server
Ver: Version: 22
222120.220.1
Close
Search Search on Documentation

IntLib API Manager Interfaces

Created: February 16, 2023 | Updated: February 16, 2023 | Applies to version: 22
Note

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 - Integrated Library API

Please note that this documentation was last updated for an older version of Altium Designer. While many of the principles and approaches will remain the same, be aware that interfaces, objects, methods, properties, and the like will have changed since then, and will not reflect the entirety of those found in later versions of the software.

Integrated Library API: Manager Interfaces Copy Link Copied

The Integrated Library API Manager Interfaces Reference includes the following sections and content:

IIntegratedLibraryManager Interface IModelTypeManager Interface IDeviceSheetManager Interface
Integrated Library Manager Methods IModelTypeManager Methods
IModelTypeManager Properties		 IDeviceSheetManager Methods

 

IIntegratedLibraryManager Interface Copy Link Copied

Overview
The IIntegratedLibraryManager interface represents the integrated library manager that manages schematic components and its models from installed libraries in Altium Designer.

Invoke the IntegratedLibraryManager function to fetch the IIntegratedLibraryManager interface.

Integrated Library Manager Methods and Properties Table

IIntegratedLibraryManager methods
AddRemoveLibraries
AvailableLibraryCount
AvailableLibraryPath
AvailableLibraryType
BrowseComponent
BrowseDatafileEntity
BrowseDatafileEntityInDatafile
BrowseForComponent
BrowseForComponentAndPart
BrowseForComponentAndPartCheckDBLibs
BrowseForComponentCheckDBLibs
BrowseForDatafile
BrowseModel
BrowseSymbol
ComponentHasModelOfType
CreateIntegratedLibrary
ExtractSources
ExtractSourcesToDatabaseLib
ExtractSourcesToPath
FindDatafileInStandardLibs
FindComponentLibraryPath
FindComponentDisplayPath
FindComponentSymbol
FindDatafileEntityDatafilePath
FindDatafileEntitySourceDatafilePath
FindDatafileEntitySourceLibraryPath
FindDatafileEntityLibraryPath
FindLibraryInformation
FindModelLibraryPath
GetAllParametersFromSourceLib
GetAvailableDBLibDocAtPath
GetComponentCount
GetComponentDatafileLocation
GetComponentLocation
GetComponentLocationFromDatabase
GetComponentName
GetDatabaseDatafileLocation
GetDatafileEntityCount
GetDatafilePath
GetModelCount
GetModelName
GetModelType
GetParametersForDBComponent
GetSchLibPathForDBComponent
GetSchLibRefForDBComponent
GetParameterCount
GetParameterName
GetParameterValue
GetComponentPlacementParameters
InstalledLibraryCount
InstalledLibraryPath
InstallLibrary
IsParameterDatabaseKey
MakeCurrentProject
ModelCount
ModelName
ParseDatabaseKeys
PlaceLibraryComponent
UninstallLibrary		 IIntegratedLibraryManager properties

See also
Examples\Scripts\DXP_Scripts\ folder of Altium Designer installation

Integrated Library Manager Methods

AddRemoveLibraries method

(IIntegratedLibraryManager interface)
Syntax
Procedure AddRemoveLibraries;
Description
This method invokes the Available Libraries dialog with a list of installed libraries if any and their activated, path and type values.
Example

view sourceprint?
1IntMan := IntegratedLibraryManager;
2If IntMan = Nil Then Exit;
3IntMan.AddRemoveLibraries;

See also
IIntegratedLibraryManager interface

AvailableLibraryType method

(IIntegratedLibraryManager interface)
Syntax
Function AvailableLibraryType (LibraryIndex : Integer) : TLibraryType;
Description
The AvailableLibraryType function determines what type the indexed library is. Note, the first installed library in the Available Libraries dialog is indexed zero (0).
Notes
An available library is one of the libraries on the Installed, Project and Search path tabs within the Available Libraries dialog.
An installed library appears in the Installed tab of the Available Libraries dialog.
TLibraryType = (eLibIntegrated, eLibSource, eLibDatafile, eLibDatabase, eLibNone, eLibQuery, eLibDesignItems);
Example

view sourceprint?
01    IntMan := IntegratedLibraryManager;
02    If IntMan = Nil Then Exit;
03  
04    LibType := IntMan.AvailableLibraryType(0);
05    Case LibType Of
06        eLibIntegrated  : ShowMessage('Integrated');
07        eLibSource      : ShowMessage('Lib Source');
08        eLibDatafile    : ShowMessage('Lib data File');
09        eLibDatabase    : ShowMessage('Database');
10        eLibNone        : ShowMessage('None');
11        eLibQuery       : ShowMessage('Query');
12        eLibDesignItems : ShowMessage('Design Items');
13    End;

See also
IIntegratedLibraryManager interface
TLibraryType type

AvailableLibraryPath method

(IIntegratedLibraryManager interface)
Syntax
Function AvailableLibraryPath (LibraryIndex : Integer) : WideString;
Description
The AvailableLibraryPath function retrieves the file path of the indexed library in the Available Libraries dialog. Note, the first installed library in the Available Libraries dialog is indexed zero (0).
Notes
An available library is one of the libraries on the Installed, Project and Search path tabs within the Available Libraries dialog.
An installed library appears in the Installed tab of the Available Libraries dialog.
Example

view sourceprint?
1IntMan := IntegratedLibraryManager;
2If IntMan = Nil Then Exit;
3ShowMessage(IntMan.AvailableLibraryPath(0));

See also
IIntegratedLibraryManager interface

AvailableLibraryCount method

(IIntegratedLibraryManager interface)
Syntax
Function AvailableLibraryCount : Integer;
Description
The AvailableLibraryCount function determines the number of available libraries. Note, the first installed library in the Available Libraries dialog is indexed zero (0).
Notes
An available library is one of the libraries on the Installed, Project and Search path tabs within the Available Libraries dialog.
An installed library appears in the Installed tab of the Available Libraries dialog.
Example

view sourceprint?
1IntMan := IntegratedLibraryManager;
2If IntMan = Nil Then Exit;
3ShowMessage(IntToStr(IntMan.AvailableLibraryCount));

See also
IIntegratedLibraryManager interface
AvailableLibraryPath method
AvailableLibraryType method

BrowseForDatafile method

(IIntegratedLibraryManager interface)
Syntax
Procedure BrowseForDatafile (AModelName : PChar;AModelPath : PChar; LibPath : PChar; ModelType : PChar; ForComponentInstance : LongBool);
Description
This BrowseForDataFile procedure invokes the Browse Libraries dialog.
Example

view sourceprint?
1LibraryPath := 'C:\Program Files\Altium Designer Summer 08\Library\Xilinx\Xilinx Spartan-3E.IntLib';
2ComponentName  := 'XC3S100E-4TQ144I';
3ModelType      := 'PCBLIB';
4AFootprintName := 'TQ144_N';
5IntMan.BrowseForDatafile(AFootprintName, LibraryPath, Librarypath,ModelType, True);

See also
IIntegratedLibraryManager interface

BrowseForComponentAndPart method

(IIntegratedLibraryManager interface)
Syntax
Procedure BrowseForComponentAndPart (ALibReference : PChar;ASCHLibraryPath : PChar;SelModelName : PChar;SelModelLib : PChar;LibPath : PChar;ModelType : PChar;Var PartID : Integer);
Description
This BrowseForComponentAndPart procedure invokes the Browse for Parts dialog.
Example
See also
IIntegratedLibraryManager interface

BrowseForComponent method

(IIntegratedLibraryManager interface)
Syntax
Procedure BrowseForComponent (ALibReference : PChar; ASCHLibraryPath : PChar; SelModelName : PChar; SelModelLib : PChar; LibPath : PChar; ModelType : PChar);
Description
This BrowseForDataFile procedure invokes the Browse for Components dialog.
Example
See also
IIntegratedLibraryManager interface

BrowseForComponentAndpartCheckDBLibs method

(IIntegratedLibraryManager interface)
Syntax
Procedure BrowseForComponentAndPartCheckDBLibs (ALibReference : PChar; ASCHLibraryPath : PChar; SelModelName : PChar;  SelModelLib : PChar; LibPath : PChar; ModelType : PChar;  ADatabaseTableName : PChar; ADatabaseKeys : PChar; Var PartID : Integer);
Description
This BrowseForComponentAndPartCheckDBLibs procedure invokes the Browse for Components dialog.
Example
See also
IIntegratedLibraryManager interface

ComponentHasModelOfType method

(IIntegratedLibraryManager interface)
Syntax
Function ComponentHasModelOfType (LibraryPath : WideString; ComponentIndex : Integer; AModelType : WideString) : Boolean;
Description
This function checks if this indexed component from the specified library has this model type. Model Types include:

  • PCBLIB
  • PCB3DLIB
  • SIM
  • SI

Example

view sourceprint?
1ComponentIndex := 0;
2Status := IntMan.ComponentHasModelOfType(LibraryPath, ComponentIndex, 'PCBLIB');
3If Status Then ShowMessage('True') Else ShowMessage('False');

See also
IIntegratedLibraryManager interface

CreateIntegratedLibrary method

(IIntegratedLibraryManager interface)
Syntax
Procedure CreateIntegratedLibrary (AProject : IProject; AnOutputPath : WideString; Install : Boolean);
Description
This CreateIntegratedLibrary procedure creates an integrated library from a project into the specified AnOutputPath path and depending on the Install parameter is installed in the Available Libraries dialog.
Example

view sourceprint?
01IntMan := IntegratedLibraryManager;                            
02If IntMan = Nil Then Exit;                                     
03WSM := GetWorkSpace;                                           
04If WSM = Nil Then Exit;                                        
05                                                                
06Project := WSM.DM_FocusedProject;                              
07If Project = Nil Then Exit;                                    
08LibPath := ChangeFileExt(Project.DM_ProjectFullPath,'.INTLIB');
09IntMan.CreateIntegratedLibrary(Project,LibPath,True);          
10IntMan.MakeCurrentProject(Project);

See also
IIntegratedLibraryManager interface

ExtractSourcesToPath method

(IIntegratedLibraryManager interface)
Syntax
Procedure ExtractSourcesToPath (ALibraryPath : WideString ;ADestinationPath : WideString);
Description
This ExtractSources procedure extracts the source files such as PCBLIB and PCB3DLIb files to the destination path (ADestinationPath parameter) from the Integrated Library specified by its ALibraryPath parameter.
Example
See example for ExtractSources method.
See also
IIntegratedLibraryManager interface

ExtractSources method

(IIntegratedLibraryManager interface)
Syntax
Procedure ExtractSources (ALibraryPath : WideString);
Description
This ExtractSources procedure extracts the source files such as PCBLIB and PCB3DLIb files from the Integrated Library specified by its ALibraryPath parameter.
Example

view sourceprint?
01Program ExtractSourceLibsFromIntLibs;
02Var
03   SourceFolder : String;
04   FilesList    : TStringList;
05   i            : Integer;
06Begin
07    If IntegratedLibraryManager = Nil then Exit;
08    If (InputQuery('Extract IntLib Files','Enter folder containing IntLib files',SourceFolder)) Then
09    Begin
10        If (SourceFolder <> '') Then
11            If (SourceFolder[Length(SourceFolder)] <> '\') Then
12                SourceFolder := SourceFolder + '\';
13        If (DirectoryExists(SourceFolder)) Then
14        Begin
15           Try
16                  FilesList            := TStringList.Create;
17                  FilesList.Sorted     := True;
18                  FilesList.Duplicates := dupIgnore;
19                  // FindFiles function is a built in function from Scripting...
20                  FindFiles(SourceFolder,'*.IntLib',faAnyFile,False,FilesList);
21                  For i := 0 To FilesList.Count - 1 Do
22                       IntegratedLibraryManager.ExtractSources(FilesList.Strings[i]);
23           Finally
24                      FilesList.Free;
25           End;
26        End;
27    End;
28End.

See also
IIntegratedLibraryManager interface

FindComponentDisplayPath method

(IIntegratedLibraryManager interface)
Syntax
Function FindComponentDisplayPath(ALibIdentifierKind  : TLibIdentifierKind;
                            Const ALibraryIdentifier  : WideString;
                            Const ADesignItemID       : WideString) : WideString;
Description
The function returns the full path of the library that the supplied component is part of.
Example

view sourceprint?
1IntMan := IntegratedLibraryManager;
2If IntMan = Nil Then Exit;
3// Component is a ISch_Component interface from Schematic API
4If Component.LibraryIdentifier <> '' Then
5    ShowMessage(IntMan. FindComponentDisplayPath(Component.LibIdentifierKind, Component.LibraryIdentifier, Component.DesignItemID));

See also
IIntegratedLibraryManager interface

FindComponentLibraryPath method

(IIntegratedLibraryManager interface)
Syntax
Function  FindComponentLibraryPath(ALibIdentifierKind  : TLibIdentifierKind;
                             Const ALibraryIdentifier  : WideString;
                             Const ADesignItemID       : WideString)  : WideString;
Description
The function returns the path of the library the component is part of.
The ALibIdentifierKind parameter denotes which type of library the component is from.
TLibIdentifierKind = (eLibIdentifierKind_Any,
                      eLibIdentifierKind_NameNoType,
                      eLibIdentifierKind_NameWithType,
                      eLibIdentifierKind_FullPath);
The ALIbraryIdentifier parameter is the library identifier string that the component is associated with.
The ADesignItemID parameter is the symbol reference (library reference) of the component from a Schematic or Integrated Library or an unique part number from a record within a table of a Database.
Example

view sourceprint?
01// For each component found on the schematic, you can iterate for its implementations.
02//SchImplementation  : ISch_Implementation;
03If SchImplementation.UseComponentLibrary Then
04Begin
05    ComponentPath  := IntegratedLibraryManager.FindComponentLibraryPath(Component.LibIdentifierKind, Component.LibraryIdentifier, Component.DesignItemID); 
06    ModelPath      := IntegratedLibraryManager.FindModelLibraryPath    (Component.LibIdentifierKind, Component.LibraryIdentifier, Component.DesignItemID, SchImplementation.ModelName, SchImplementation.ModelType);
07  
08    ModelsList.Add(' The Component is in Integrated Library'); 
09    ModelsList.Add('  Component path: ' + ComponentPath); 
10    ModelsList.Add('  Model path: '     + ModelPath); 
11End

See also
IIntegratedLibraryManager interface
TLibIdentifierKind type
SimModelsOfComponents script from \Examples\Scripts\DelphiScript Scripts\Sch folder of the Altium Designer installation

FindComponentSymbol method

(IIntegratedLibraryManager interface)
Syntax
Function FindComponentSymbol(ALibIdentifierKind  : TLibIdentifierKind;
                       Const ALibraryIdentifier  : WideString;
                       Const ADesignItemID       : WideString;
                       Out   ASymbolLibraryPath  : WideString;
                       Out   ASymbolReference    : WideString)  : Boolean;
Description
The function validates whether if the component symbol is available or not dependent on the supplied parameters.
The ALibIdentifierKind parameter denotes which type of library the component is from.
TLibIdentifierKind = (eLibIdentifierKind_Any,
                      eLibIdentifierKind_NameNoType,
                      eLibIdentifierKind_NameWithType,
                      eLibIdentifierKind_FullPath);
The ALibraryIdentifier parameter is the library identifier string that the component is associated with.
The ADesignItemID parameter is the symbol reference (library reference) of the component from a Schematic or Integrated Library or an unique part number from a record within a table of a Database.
The ASymbolLibraryPath is the library.
The ASymbolReference is the name of the component symbol.
Example

view sourceprint?
01If IntegratedLibraryManager.FindComponentSymbol(APart.LibIdentifierKind, APart.LibraryIdentifier, APart.DesignItemID, SymbolLibraryPath, SymbolReference) Then
02Begin
03    NewSymbolLibrarypath := SymbolLibrarypath;
04    NewSymbolReference   := SymbolReference;
05End
06Else
07Begin
08    NewSymbolLibrarypath := '';
09    NewSymbolReference   := '';
10End;

See also
IIntegratedLibraryManager interface

FindDatafileEntityDatafilePath method

(IIntegratedLibraryManager interface)
Syntax
Function  FindDatafileEntityDatafilePath(ALibIdentifierKind  : TLibIdentifierKind;
                                   Const ALibraryIdentifier  : WideString;
                                   Const ADatafileEntityName : WideString;
                                   Const ADatafileType       : WideString;
                                         AUseIntAndDBLibrary : Boolean)     : WideString;
Description
The function returns the path of the library the component is part of.
The ALibIdentifierKind parameter denotes which type of library the component is from.
TLibIdentifierKind = (eLibIdentifierKind_Any,
                      eLibIdentifierKind_NameNoType,
                      eLibIdentifierKind_NameWithType,
                      eLibIdentifierKind_FullPath);
The ALibraryIdentifier parameter is the library identifier string that the component is associated with.
The ADatafileEntityName parameter
The ADatafileType parameter
The AUseIntAndDBLibrary parameter
Example

view sourceprint?
01// For each component found on the schematic, you can iterate for its implementations.
02If SchImplementation.DatafileLinkCount > 0 Then
03Begin
04    // Assumption: use the first data file link for the simulation model since we 
05    // normally only use one sim model per component. 
06    ModelDataFile := SchImplementation.DatafileLink[0]; 
07  
08    SourceLibraryPath := IntegratedLibraryManager.FindDatafileEntitySourceLibraryPath(ModelDataFile.LibIdentifierKind, ModelDataFile.LibraryIdentifier, ModelDataFile.EntityName, ModelDataFile.FileKind);         
09    LibraryPath       := IntegratedLibraryManager.FindDatafileEntityLibraryPath      (ModelDataFile.LibIdentifierKind, ModelDataFile.LibraryIdentifier, ModelDataFile.EntityName, ModelDataFile.FileKind);
10  
11    SourceDatafilePath := IntegratedLibrarymanager.FindDatafileEntitySourceDatafilePath(ModelDataFile.LibIdentifierKind, ModelDataFile.LibraryIdentifier, ModelDataFile.EntityName, ModelDataFile.FileKind, True); 
12    Datafilepath       := IntegratedLibrarymanager.FindDatafileEntityDatafilePath      (ModelDataFile.LibIdentifierKind, ModelDataFile.LibraryIdentifier, ModeldataFile.EntityName, ModelDataFile.FileKind, True); 
13  
14    ModelsList.Add(' Model : DatafilelinkCount > 0'); 
15    ModelsList.Add('  Source Library path: '  + SourceLibraryPath); 
16    ModelsList.Add('  Library path: '         + LibraryPath); 
17    ModelsList.Add('  Source datafile path: ' + SourceDatafilePath); 
18    ModelsList.Add('  Datafile path: '        + DataFilePath); 
19End;

See also
IIntegratedLibraryManager interface
TLibIdentifierKind type
SimModelsOfComponents script from \Examples\Scripts\DelphiScript Scripts\Sch folder of the Altium Designer installation

FindDatafileEntitySourceDatafilePath

(IIntegratedLibraryManager interface)
Syntax
Function FindDatafileEntitySourceDatafilePath(ALibIdentifierKind  : TLibIdentifierKind;
                                        Const ALibraryIdentifier  : WideString;
                                        Const ADatafileEntityName : WideString;
                                        Const ADatafileType       : WideString;
                                              AUseIntAndDBLibrary : Boolean) : WideString;
Description
This function returns the path of the data file in library .
Example

view sourceprint?
01// For each component found on the schematic, you can iterate for its implementations.
02If SchImplementation.DatafileLinkCount > 0 Then
03Begin
04    // Assumption: use the first data file link for the simulation model since we 
05    // normally only use one sim model per component. 
06    ModelDataFile := SchImplementation.DatafileLink[0]; 
07  
08    SourceLibraryPath := IntegratedLibraryManager.FindDatafileEntitySourceLibraryPath(ModelDataFile.LibIdentifierKind, ModelDataFile.LibraryIdentifier, ModelDataFile.EntityName, ModelDataFile.FileKind);         
09    LibraryPath       := IntegratedLibraryManager.FindDatafileEntityLibraryPath      (ModelDataFile.LibIdentifierKind, ModelDataFile.LibraryIdentifier, ModelDataFile.EntityName, ModelDataFile.FileKind);
10  
11    SourceDatafilePath := IntegratedLibrarymanager.FindDatafileEntitySourceDatafilePath(ModelDataFile.LibIdentifierKind, ModelDataFile.LibraryIdentifier, ModelDataFile.EntityName, ModelDataFile.FileKind, True); 
12    Datafilepath       := IntegratedLibrarymanager.FindDatafileEntityDatafilePath      (ModelDataFile.LibIdentifierKind, ModelDataFile.LibraryIdentifier, ModeldataFile.EntityName, ModelDataFile.FileKind, True); 
13  
14    ModelsList.Add(' Model : DatafilelinkCount > 0'); 
15    ModelsList.Add('  Source Library path: '  + SourceLibraryPath); 
16    ModelsList.Add('  Library path: '         + LibraryPath); 
17    ModelsList.Add('  Source datafile path: ' + SourceDatafilePath); 
18    ModelsList.Add('  Datafile path: '        + DataFilePath); 
19End;

See also
IIntegratedLibraryManager interface

FindDatafileEntitySourceLibraryPath

(IIntegratedLibraryManager interface)
Syntax
 
Description
See also
IIntegratedLibraryManager interface

FindDatafileEntityLibraryPath

(IIntegratedLibraryManager interface)
Syntax
 
Description
See also
IIntegratedLibraryManager interface

FindDatafileInStandardLibs method

(IIntegratedLibraryManager interface)
Syntax
Function FindDatafileInStandardLibs (ADatafileEntityName : WideString; ADatafileType : WideString; ADatafileLocation : WideString; ForComponentInstance : Boolean; Var FoundInLibraryPath : WideString) : WideString;
Description
This function returns the path of the data file for the specified model in an integrated library. You need to specify the ADataFileEntityName parameter which is the footprint name, 3D model name, Sim name or SI name.
The ADataFileType parameter denotes the model type represented by the datafiletype (PCB, PCB3DLIB, SIM, SI).
The ADatafileLocation parameter is optional.
The ForComponentInstance is a Boolean and is true if it is in an integrated library, false otherwise.
The FoundInLibraryPath parameter is a returnable value and returns the location of the data file if all the supplied parameters are valid.
Example

view sourceprint?
01Var
02    IntMan        : IntegratedLibraryManager;
03InIntLib      : Boolean;
04FoundLocation : 
05Begin
06    IntMan := IntegratedLibraryManager;
07    If IntMan = Nil Then Exit;
08  
09    IntMan.InstallLibrary('C:\Program Files\Altium Designer\Examples\Reference Designs\4 Port Serial Interface\Libraries\4 Port Serial Interface.PcbLib');
10  
11    InIntLib := False;
12    IntMan.FindDatafileInStandardLibs ('DIP14', 'PCBLIB', '', InIntLib, FoundLocation);
13    ShowMessage(FoundLocation);
14End;

See also
IIntegratedLibraryManager interface

FindDatafileEntitySourceLibraryPath

(IIntegratedLibraryManager interface)
Syntax
 
Description
See also
IIntegratedLibraryManager interface

FindModelLibraryPath

(IIntegratedLibraryManager interface)
Syntax
Function  FindModelLibraryPath(ALibIdentifierKind : TLibIdentifierKind;
                         Const ALibraryIdentifier : WideString;
                         Const ADesignItemID      : WideString;
                         Const AModelName         : WideString;
                         Const AModelType         : WideString)  : WideString;
Description
The function returns the path of the library the model is part of.
The ALibIdentifierKind parameter denotes which type of library the component is from.
TLibIdentifierKind = (eLibIdentifierKind_Any,
                      eLibIdentifierKind_NameNoType,
                      eLibIdentifierKind_NameWithType,
                      eLibIdentifierKind_FullPath);
The ALIbraryIdentifier parameter is the library identifier string that the component is associated with.
The ADesignItemID parameter is the symbol reference (library reference) of the component from a Schematic or Integrated Library or an unique part number from a record within a table of a Database.
The AModelName parameter is the name of the implementation (model) linked to this component.
The AModelType parameter is the model type of the implementation (model) linked to this component.
Example

view sourceprint?
01// For each component found on the schematic, you can iterate for its implementations.
02//SchImplementation  : ISch_Implementation;
03If SchImplementation.UseComponentLibrary Then
04Begin
05    ComponentPath  := IntegratedLibraryManager.FindComponentLibraryPath(Component.LibIdentifierKind, Component.LibraryIdentifier, Component.DesignItemID); 
06    ModelPath      := IntegratedLibraryManager.FindModelLibraryPath    (Component.LibIdentifierKind, Component.LibraryIdentifier, Component.DesignItemID, SchImplementation.ModelName, SchImplementation.ModelType);
07  
08    ModelsList.Add(' The Component is in Integrated Library'); 
09    ModelsList.Add('  Component path: ' + ComponentPath); 
10    ModelsList.Add('  Model path: '     + ModelPath); 
11End

See also
IIntegratedLibraryManager interface
TLibIdentifierKind type
SimModelsOfComponents script from \Examples\Scripts\DelphiScript Scripts\Sch folder of the Altium Designer installation

FindLibraryInformation method

(IIntegratedLibraryManager interface)
Syntax
Function  FindLibraryInformation(ALibIdentifierKind  : TLibIdentifierKind;
                           Const ALibraryIdentifier  : WideString;
                           Const ADesignItemID       : WideString;
                           Out   ALibraryPath        : WideString;
                           Out   ADBTableName        : WideString) : Boolean;
Description
The function validates the existence of the library.
The ALibIdentifierKind parameter denotes which type of library the component is from.
TLibIdentifierKind = (eLibIdentifierKind_Any,
                      eLibIdentifierKind_NameNoType,
                      eLibIdentifierKind_NameWithType,
                      eLibIdentifierKind_FullPath);
The ALIbraryIdentifier parameter is the library identifier string that the component is associated with. Normally a path to a library.
The ADesignItemID parameter is the symbol reference (library reference) of the component from a Schematic or Integrated Library or an unique part number from a record within a table of a Database.
The ALibraryPath parameter is returned for the valid design item of a component.
The ADBTableName is returned if a component is from a database.
Example
If Not IntegratedLibraryManager.FindLibraryInformation(eLibIdentifierKind_NameWithType, ALibraryIdentifier, ADesignItemID, ALibraryPath, Path, DBTableName) Then Path := '';
See also
IIntegratedLibraryManager interface

GetComponentLocation method

(IIntegratedLibraryManager interface)
Syntax
Function GetComponentLocation (ALibraryName : WideString;
AComponentName : WideString;
Var FoundInLibraryPath : WideString) : WideString;
Description
This GetComponentLocation returns the path of the specified component name within the specified library.
Example

view sourceprint?
1IntMan.GetComponentLocation('Xilinx Spartan-3E.IntLib',ComponentName, FoundLocation);
2ShowMessage(FoundLocation + #13 + 'for ' + ComponentName);
3//C:\Program Files\Altium Designer Summer 08\Library\Xilinx\Xilinx Spartan-3E.IntLib

See also
IIntegratedLibraryManager interface

GetComponentDatafileLocation method

(IIntegratedLibraryManager interface)
Syntax
Function GetComponentDatafileLocation(DatafileIndex : Integer; AModelName : WideString; AModelType : WideString; AComponentName : WideString; AComponentLibraryName : WideString; Var FoundInLibraryPath : WideString) : WideString;
Description
This GetComponentDatafileLocation function obtains the location of the datafile for the component with the specified data file index, model name and its model type, component name and the full library. The result is returned in the FoundInLibraryPath parameter or by the function itself.
Example

view sourceprint?
1LibraryPath := 'C:\Program Files\Altium Designer Summer 08\Library\Xilinx\Xilinx Spartan-3E.IntLib';
2ComponentName  := 'XC3S100E-4TQ144I';
3IntMan.GetComponentDatafileLocation(0, 'TQ144_L', 'PCBLIB', ComponentName, LibraryPath, FoundLocation);
4ShowMessage(FoundLocation + ' for Component Datafile location');
5// 'C:\Program Files\Altium Designer Summer 08\Library\Xilinx\Xilinx Spartan-3E.IntLib';

See also
IIntegratedLibraryManager interface

GetModelType method

(IIntegratedLibraryManager interface)
Syntax
Function GetModelType (LibraryPath : WideString; ComponentIndex : Integer; ModelIndex : Integer) : IModelType;
Description
This function retrieves the model type for the indexed component within the specified library. The first indexed component is 0.
Example

view sourceprint?
1IntMan := IntegratedLibraryManager;
2If IntMan = Nil Then Exit;
3  
4LibraryPath := 'C:\Program Files\Altium Designer Summer 08\Library\Xilinx\Xilinx Spartan-3E.IntLib';
5// when ComponentIndex = 0, Component = 'XC3S100E-4TQ144I';
6  
7ModelType := IntMan.GetModelType(LibraryPath, 0, 2); //0 = PCBLIB, 1 = PCB3DLIB 2 = SI
8Showmessage(ModelType.Name);

See also
IIntegratedLibraryManager interface
IModelType interface
GetModelName method
GetModelCount method

GetModelName method

(IIntegratedLibraryManager interface)
Syntax
Function GetModelName (LibraryPath : WideString; ComponentIndex : Integer; ModelIndex : Integer) : WideString;
Description
This function retrieves the model name for the indexed component within the specified library. The first indexed component is 0.
Example

view sourceprint?
1IntMan := IntegratedLibraryManager;
2If IntMan = Nil Then Exit;
3  
4LibraryPath := 'C:\Program Files\Altium Designer Summer 08\Library\Xilinx\Xilinx Spartan-3E.IntLib';
5// when ComponentIndex = 0, Component = 'XC3S100E-4TQ144I';
6Showmessage(IntMan.GetModelName(LibraryPath, 0, 0)); //0 = CP132, 1 = XC3S100E-CP132 2 = XC3S100E_CP132

See also
IIntegratedLibraryManager interface
GetModelCount method
GetModelType method

GetModelCount method

(IIntegratedLibraryManager interface)
Syntax
Function GetModelCount (LibraryPath : WideString; ComponentIndex : Integer) : Integer;
Description
This function retrieves the model count for the indexed component within the specified library. The first indexed component is 0.
Example

view sourceprint?
1IntMan := IntegratedLibraryManager;
2If IntMan = Nil Then Exit;
3LibraryPath := 'C:\Program Files\Altium Designer Summer 08\Library\Xilinx\Xilinx Spartan-3E.IntLib';
4// when ComponentIndex = 0, Component = 'XC3S100E-4TQ144I';
5Showmessage(IntMan.GetModelName(LibraryPath, 0)); //3 models for this component

See also
IIntegratedLibraryManager interface
GetModelName method
GetModelType method

GetDatafilePath method

(IIntegratedLibraryManager interface)
Syntax
Function GetDatafilePath (LibraryPath : WideString; ComponentIndex : Integer; ModelIndex : Integer; DatafileIndex : Integer) : WideString;
Description
This function gets datafile path for the specified component, its indexed model and its indexed datafile in the specified library path. Remember first index is 0.
Example
See also
IIntegratedLibraryManager interface

GetDatafileEntityCount method

(IIntegratedLibraryManager interface)
Syntax
Function GetDatafileEntityCount (LibraryPath : WideString; ComponentIndex : Integer; ModelIndex : Integer) : Integer;
Description
This function gets datafile entity count for the specified component and its indexed model in the specified library path. Remember first index is 0.
Example

view sourceprint?
1DataEntityCount := IntLib.GetDatafileEntityCount(Librarypath,I,0); 
2ShowMessage(IntToStr(DataEntityCount);
3// indexed component is I and 0 is the first model for the component.

See also
IIntegratedLibraryManager interface

GetComponentName method

(IIntegratedLibraryManager interface)
Syntax
Function GetComponentName (LibraryPath : WideString; ComponentIndex : Integer) : WideString;
Description
This function retrieves the name for the indexed component within the specified integrated library. Remember first index is 0.
Example

view sourceprint?
01IntMan := IntegratedLibraryManager;
02If IntMan = Nil Then Exit;
03  
04S :=  '';
05AvailLibPath := IntMan.AvailableLibraryPath(1);
06AComponentIndex := IntMan.GetComponentCount(IntMan.AvailableLibraryPath(1));
07  
08For I := 0 To AComponentIndex Do
09    S := S + ' ' + Intman.GetComponentName (AvailLibpath,I);
10  
11ShowMessage(s);

See also
IIntegratedLibraryManager interface

GetComponentCount method

(IIntegratedLibraryManager interface)
Syntax
Function GetComponentCount (LibraryPath : WideString) : Integer;
Description
This function retrieves the count of components within the integrated library specified by the LibraryPath parameter.
Example

view sourceprint?
1IntMan := IntegratedLibraryManager;
2If IntMan = Nil Then Exit;
3ShowMessage(IntMan.GetComponentCount(IntMan.AvailableLibraryPath(1)));

See also
IIntegratedLibraryManager interface

InstalledLibraryPath method

(IIntegratedLibraryManager interface)
Syntax
Function InstalledLibraryPath (anIndex : Integer) : WideString;
Description
This InstalledLibraryPath function retrieves the path of the indexed installed library in Altium Designer. An installed library appears in the installed libraries list box in the Installed tab of the Available Libraries dialog.
Example

view sourceprint?
01Procedure RemoveOriginalInstalledFiles;
02Var
03    I : Integer;
04Begin
05    IntMan := IntegratedLibraryManager;
06    If IntMan = Nil then Exit;
07  
08    OriginalInstalledList := TStringList.Create;
09    For I := 0 to IntMan.InstalledLibraryCount - 1 Do
10    Begin
11        OriginalInstalledList.Add(IntMan.InstalledLibraryPath(I));
12        IntMan.UnInstallLibrary(IntMan.InstalledLibraryPath(I));
13    End;
14    // do what you want with the OriginalInstalledList
15    OriginalInstalledList.Free;
16End;

See also
IIntegratedLibraryManager interface

InstalledLibraryCount method

(IIntegratedLibraryManager interface)
Syntax
Function InstalledLibraryCount : Integer;
Description
This InstalledLibraryCount function reports the number of installed libraries as in the Installed tab of the Available Libraries dialog in Altium Designer.
Example

view sourceprint?
01Procedure RemoveOriginalInstalledFiles;
02Var
03    I : Integer;
04Begin
05    IntMan := IntegratedLibraryManager;
06    If IntMan = Nil then Exit;
07  
08    OriginalInstalledList := TStringList.Create;
09    For I := 0 to IntMan.InstalledLibraryCount - 1 Do
10    Begin
11        OriginalInstalledList.Add(IntMan.InstalledLibraryPath(I));
12        IntMan.UnInstallLibrary(IntMan.InstalledLibraryPath(I));
13    End;
14End;

See also
IIntegratedLibraryManager interface
InstalledLibraryPath method
AvailableLibraryPath method
AvailableLibraryCount method

InstallLibrary method

(IIntegratedLibraryManager interface)
Syntax
Procedure InstallLibrary (ALibraryPath : WideString);
Description
This procedure installs the library (full path) in the Available Libraries dialog (in the Installed page) in Altium Designer.
Example
IntegratedLibraryManager.InstallLibrary('C:\Program Files\Altium Designer\Library\Xilinx\Xilinx Spartan-3E.IntLib');
See also
IIntegratedLibraryManager interface
UnInstallLibrary method

MakeCurrentProject method

(IIntegratedLibraryManager interface)
Syntax
Procedure MakeCurrentProject (AProject : IProject);
Description
This procedure makes the current library in the Libraries panel  based on the project.
Example

view sourceprint?
01IntMan := IntegratedLibraryManager;                            
02If IntMan = Nil Then Exit;                                     
03WSM := GetWorkSpace;                                           
04If WSM = Nil Then Exit;                                        
05                                                                
06Project := WSM.DM_FocusedProject;                              
07If Project = Nil Then Exit;                                    
08LibPath := ChangeFileExt(Project.DM_ProjectFullPath,'.INTLIB');
09IntMan.CreateIntegratedLibrary(Project,LibPath,True);          
10IntMan.MakeCurrentProject(Project);

See also
IIntegratedLibraryManager interface

ModelName method

(IIntegratedLibraryManager interface)
Syntax
Function ModelName (AComponentName : WideString; AComponentLibraryName : WideString; AModelType : WideString; AnIndex : Integer) : WideString;
Description
This ModelName function returns the name of the model type associated with the component within a specified library.
Example

view sourceprint?
01LibraryPath := 'C:\Program Files\Altium Designer Summer 08\Library\Xilinx\Xilinx Spartan-3E.IntLib';
02ModelCount := IntMan.ModelCount(ComponentName,LibraryPath, 'PCBLIB');
03ShowMessage(ComponentName + '''s ModelCount : ' + IntToStr(ModelCount));
04  
05S := '';
06For I := 0 to ModelCount - 1 Do
07S := S + #13 + IntMan.ModelName (ComponentName, LibraryPath, 'PCBLIB', I);
08  
09ShowMessage(S);
10// TQ144_L, TQ144_M, TQ144_N

See also
IIntegratedLibraryManager interface

ModelCount method

(IIntegratedLibraryManager interface)
Syntax
Function ModelCount (AComponentName : WideString; AComponentLibraryName : WideString; AModelType : WideString) : Integer;
Description
This ModelCount function returns the number of models of the same type associated with the component within the specified library. The AComponentName parameter is the name of the component. The AComponentLibraryName parameter is the full path of the library the component is from, and the AModelType parameter is the model type you wish to find how many.
Example

view sourceprint?
1ModelCount := IntMan.ModelCount(ComponentName,'C:\Program Files\Altium Designer Summer 08\Library\Xilinx\Xilinx Spartan-3E.IntLib', 'PCBLIB');
2ShowMessage(ComponentName + '''s ModelCount : ' + IntToStr(ModelCount));
3// XC3S100E-4TQ144I’s Model count: 3

See also
IIntegratedLibraryManager interface

PlaceLibraryComponent method

(IIntegratedLibraryManager interface)
Syntax
Function PlaceLibraryComponent (ALibReference : PChar; ALibraryPath : PChar; Parameters : PChar) : Boolean;
Description
This method places a component from a specified library with Library Reference and Parameters that describe/define this component.
The ALIbReference parameter defines the component. For example ‘Res2’
The ALibraryPath parameter defines the path to the library that the component is from. For example ‘Miscellaneous Devices.IntLib’
The Parameters parameter defines the parameters needed for the component to be able to be placed on the schematic sheet. For example 'ModelType=SIM|ModelParameterName0=Value|ModelParameterValue0=1K|Orientation=1|Location.X=10000000|Location.Y=20000000'. Normally you will need Location.X and Location.Y parameters at the least to be able to place this component on the schematic sheet.
Example

view sourceprint?
01Procedure PlaceAPartProgrammatically;
02Begin
03    If SchServer = Nil Then Exit;
04    If SchServer.GetCurrentSchDocument = Nil Then Exit;
05    If IntegratedLibraryManager = Nil Then Exit;
06  
07    // Integrated Library object model is used to place a
08    // component from the library onto the schematic sheet.
09    IntegratedLibraryManager.PlaceLibraryComponent(
10        'Res2',
11        'Miscellaneous Devices.IntLib',
12        'ModelType=SIM|ModelParameterName0=Value|' +
13        'ModelParameterValue0=1K|Orientation=1|Location.X=10000000|Location.Y=20000000');
14  
15     // Refresh screen
16    SchServer.GetCurrentSchDocument.GraphicallyInvalidate;
17End;

See also
IIntegratedLibraryManager interface

UninstallLibrary method

(IIntegratedLibraryManager interface)
Syntax
Procedure UninstallLibrary (ALibraryPath : WideString);
Description
This procedure removes the specified library (full path) in the Available Libraries dialog (in the Installed page) in Altium Designer
Example
IntegratedLibraryManager.UnInstallLibrary('C:\Program Files\Altium Designer\Library\Xilinx\Xilinx Spartan-3E.IntLib');
See also
IIntegratedLibraryManager interface
InstallLibrary method

 

IModelTypeManager Interface Copy Link Copied

Overview
The IModelTypeManager interface represents a repository of available model types in Altium Designer. The Implementation files (*.IMP) from the System folder of Altium Designer Installation are collected and processed by this manager.

Each model that can be linked to a schematic component has a model type and model data file(s).

  • PCB Model has one model data file – footprints (*.PCBLIB)
  • PCB 3D Model has one model data file –3D models (*.PCB3DLib)
  • Signal Integrity Model has one model data file – pin model library.
  • Simulation has 3 model data files – Model File(*.MDL), Subcircuit file (*.CKT) and SIMetrix Model Library file (*.LB).

This IModelTypeManager interface uses IModelType and IModelDataType interfaces to store different model types and their model data types.
Invoke the ModelTypeManager function to fetch the IModelTypeManager interface.
IModelTypeManager Methods and Properties Table

IModelTypeManager methods
ModelTypeCount
ModelTypeAt
ModelTypeFromName
ModelTypeFromServerName
ModelDatafileTypeCount
ModelDatafileTypeAt
ModelDatafileTypeFromKind		 IModelTypeManager properties
ModelTypes
ModelDatafileTypes

See also
IModelType interface
IModelDataType interface
Examples\Scripts\DXP_Scripts\ folder of Altium Designer installation

IModelTypeManager Methods

ModelTypeFromServerName method

(IModelTypeManager interface)
Syntax
Function ModelTypeFromServerName (AName : PChar) : IModelType;
Description
This function returns the model type interface based on the server name. The Server names can be:

  • PCB3D
  • PCB
  • Sim
  • SignalIntegrity

Example

view sourceprint?
01Procedure ShowAModelFromModelTypeManager;
02Var
03    ModelTypeMan : IModelTypeManager;
04    I            : Integer;
05    ModelType    : IModelType;
06Begin
07    ModelTypeMan := ModelTypeManager;
08    If ModelTypeMan = Nil Then Exit;
09    ModelType := ModelTypeMan.ModelTypeFromServerName('SIM'); 
10    ShowMessage(ModelType.Description); //Simulation
11End;

See also
IModelTypeManager interface

ModelTypeFromName method

(IModelTypeManager interface)
Syntax
Function ModelTypeFromName (AName : PChar) : IModelType;
Description
This function returns the model type interface based on the model type name. The names can be:

  • PCB3DLIB
  • PCBLIB
  • SI
  • SIM

Example

view sourceprint?
01Procedure DisplayModelTypeFromName;
02Var
03    AModelTypeManager : IModelTypeManager;
04    AModelType        : IModelType;
05Begin
06    AModelTypeManager := ModelTypeManager;
07    If AModelTypeManager = Nil Then Exit;
08  
09    //AModelType := AModelTypeManager.ModelTypeFromName('PCBLIB');
10    //AModelType := AModelTypeManager.ModelTypeFromName('PCB3DLib');
11    //AModelType := AModelTypeManager.ModelTypeFromName('SI');
12    AModelType := AModelTypeManager.ModelTypeFromName('SIM');
13    If AModelType <> Nil Then
14        ShowMessage(AModelType.Description);
15End;

See also
IModelTypeManager interface

ModelTypeCount method

(IModelTypeManager interface)
Syntax
Function ModelTypeCount : Integer;
Description
This function returns the number of models supported by Altium Designer. The available models are PCBLIB, SI, SIM and PCB3DLIB types.
Example

view sourceprint?
01Procedure ShowModelTypesFromModelTypeManager;
02Var
03    ModelTypeMan : IModelTypeManager;
04    I            : Integer;
05Begin
06    ModelTypeMan := ModelTypeManager;
07    If ModelTypeMan = Nil Then Exit;
08  
09    For I := 0 To ModelTypeMan.ModelTypeCount -1 do
10       ShowMessage(ModelTypeMan.ModelTypes[i].Name); // 4 model types supported
11End;

See also
IModelTypeManager interface

ModelTypeAt method

(IModelTypeManager interface)
Syntax
Function ModelTypeAt (AnIndex : Integer) : IModelType;
Description
This function returns the indexed model type. First model type starts at 0. This method is used by the ModelTypes property.
Example

view sourceprint?
1Procedure ShowFirstModelTypeFromModelTypeManager;
2Var
3    ModelTypeMan : IModelTypeManager;
4    I            : Integer;
5Begin
6    ModelTypeMan := ModelTypeManager;
7    If ModelTypeMan = Nil Then Exit;
8    ShowMessage(ModelTypeMan.ModelTypeAt(0).Name);
9End;

See also
IModelTypeManager interface
ModelTypeCount method

ModelDatafileTypeFromKind method

(IModelTypeManager interface)
Syntax
Function ModelDatafileTypeFromKind (AKind : PChar) : IModelDatafileType;
Description
This function returns the IModelDatafileType based on the datafile kind. The datafile kinds for:

Model Type (Kind) DatafileType Description
MDL Sim Model File
CKT Sim Subcircuit File
LB SIMetrix Model Library File
SIPinModelLibrary SI Pin Model Library
PCBLIB Protel Footprint Library
PCB3DLIB PCB3D Model Library

Example

view sourceprint?
1Procedure ShowDataFileTypeFromModelTypeManager;
2Var
3    ModelTypeMan : IModelTypeManager;
4Begin
5    ModelTypeMan := ModelTypeManager;
6    If ModelTypeMan = Nil Then Exit;
7Showmessage(ModelTypeMan.ModelDatafileTypeFromKind('SIPinModelLibrary').Description); 
8//SI Pin Model Library
9End;

See also
IModelTypeManager interface

ModelDatafileTypeCount method

(IModelTypeManager interface)
Syntax
Function ModelDatafileTypeCount : Integer;
Description
This function reports the number of model data file types used by Altium Designer. Since there are four models supported and Simulation model has 3 types while the other 3 models has one type each making 6 in total.
Example

view sourceprint?
1Procedure ShowModelDatafileTypeCount;
2Var
3    ModelTypeMan : IModelTypeManager;
4    I            : Integer;
5Begin
6    ModelTypeMan := ModelTypeManager;
7    If ModelTypeMan = Nil Then Exit;
8    Showmessage(IntToStr(ModelTypeMan.ModelDatafileTypeCount)); //6 data file types
9End;

See also
IModelTypeManager interface

ModelDatafileTypeAt method

(IModelTypeManager interface)
Syntax
Function ModelDatafileTypeAt (AnIndex : Integer) : IModelDatafileType;
Description
This method returns the data file types supported by Altium Designer. First data file type starts at 0. This method is used by the ModelDataFileTypes property.
Example

view sourceprint?
01Procedure ShowModelDatafileTypes;
02Var
03    ModelTypeMan      : IModelTypeManager;
04    ModelDatafileType : ModelDatafileType;
05    I                 : Integer;
06Begin
07    ModelTypeMan := ModelTypeManager;
08    If ModelTypeMan = Nil Then Exit;
09    //6 data file types
10    For I := 0 To ModelTypeMan.ModelDatafileTypeCount - 1 do
11    Begin
12        ModelDatafileType := ModelTypeMan.ModelDatafileTypeAt(I);
13        ShowMessage(ModelDatafileType.FileKind + #13 + ModelDatafileType.Description);
14    End;
15End;

See also
IModelTypeManager interface
ModelDatafileTypes property
ModelDatafileTypeCount method

IModelTypeManager Properties

ModelDatafileTypes property

(IModelTypeManager interface)
Syntax
Property ModelDatafileTypes[AnIndex : Integer] : IModelDatafileType Read ModelDatafileTypeAt;
Description
This property returns the data file types supported by Altium Designer. First data file type starts at 0. This property is supported by the ModelDataFileTypeAt method.
Example

view sourceprint?
01Procedure ShowModelDatafileTypes;
02Var
03    ModelTypeMan      : IModelTypeManager;
04    ModelDatafileType : ModelDatafileType;
05    I                 : Integer;
06Begin
07    ModelTypeMan := ModelTypeManager;
08    If ModelTypeMan = Nil Then Exit;
09    //6 data file types
10    For I := 0 To ModelTypeMan.ModelDatafileTypeCount - 1 do
11    Begin
12        ModelDatafileType := ModelTypeMan.ModelDatafileTypes[I];
13        ShowMessage(ModelDatafileType.FileKind + #13 + ModelDatafileType.Description);
14    End;
15End;

See also
IModelTypeManager interface
IModelDatafileType interface
ModelDatafileTypeCount method

ModelTypes property

(IModelTypeManager interface)
Syntax
Property ModelTypes [AnIndex : Integer] : IModelType Read ModelTypeAt;
Description
This function returns the indexed model type. First model type starts at 0. This property is supported by the ModelTypeAt method.
Example

view sourceprint?
01Procedure ShowModelsFromModelTypeManager;
02Var
03    ModelTypeMan : IModelTypeManager;
04    I            : Integer;
05Begin
06    ModelTypeMan := ModelTypeManager;
07    If ModelTypeMan = Nil Then Exit;
08  
09    For i := 0 To ModelTypeMan.ModelTypeCount -1 do
10       ShowMessage(ModelTypeMan.ModelTypes[i].Name);
11End;

See also
IModelTypeManager interface
IModelType interface
ModelTypeAt method

 

IDeviceSheetManager Interface Copy Link Copied

Overview
The IDeviceSheetManager interface represents the Device Sheets Folder dialog in Altium Designer. Invoke the DeviceSheetManager function to fetch the IDeviceSheetManager object interface.

IDeviceSheetManager Methods and Properties Table

IDeviceSheetManager methods
EditDeviceFolderList
FindDeviceSheetPath
BrowseDeviceSheet
GetFoldersCount
GetFolders_FolderPath
GetFolders_SearchSubFolders
WillSearchDeviceFolder
AddDeviceFolder
ChooseDeviceFolder
ConvertDeviceSheetPathToName		 IDeviceSheetManager properties

See also
DeviceSheetManager function.

IDeviceSheetManager Methods

AddDeviceFolder Method

(IDeviceSheetManagerManager interface)
Syntax
Function  AddDeviceFolder(Const AFolderPath : WideString; ASearchSubfolder : Boolean) : Boolean;
Description
This function adds a new device folder into the existing top level Device Folder and whether sub folders can be searched from that folder.
Example

view sourceprint?
1If Not DeviceSheetManager.WillSearchDeviceFolder(ExtractFilePath(ASheetPath)) Then
2    DeviceSheetManager.AddDeviceFolder(ExtractFilePath(ASheetPath), False);

See also
IDeviceSheetManagerManager interface

BrowseDeviceSheet Method

(IDeviceSheetManagerManager interface)
Syntax
Function BrowseDeviceSheet (Var   AFileName : WideString; Out AFilePath : WideString) : Boolean;
Description
The function BrowseDeviceSheet invokes the Select Device Sheet dialog and when you select a device sheet, the filename (without the file extension) is returned for the device sheet you chose from this dialog. This filename is returned in the AFilename parameter.
Example

view sourceprint?
1DeviceSheetMan := DeviceSheetManager;
2If DeviceSheetMan = Nil Then Exit;
3AFilepath := ''; Afilepath is returned blank.
4DeviceSheetMan.BrowseDeviceSheet(AFileName,AFilepath);
5ShowMessage('Filename ' + AFileName);

See also
IDeviceSheetManagerManager interface

ChooseDeviceFolder Method

(IDeviceSheetManagerManager interface)
Syntax
Function  ChooseDeviceFolder(Var AFolderPath : WideString) : Boolean;
Description
This function invokes the Choose Device Sheet Folder dialog and returns you the valid device folder via the AFolderPath parameter. The function returns a false value if the dialog is cancelled.
Example

view sourceprint?
1FolderPath := ExtractFilePath(DeviceSheetPathText);
2If DeviceSheetManager.ChooseDeviceFolder(FolderPath) Then
3     DeviceSheetPathText := AddSlash(FolderPath) + ExtractFileName(DeviceSheetPathText);

See also
IDeviceSheetManagerManager interface

ConvertDeviceSheetPathToName Method

(IDeviceSheetManagerManager interface)
Syntax
Function ConvertDeviceSheetPathToName (Const AFilePath : WideString) : WideString;
Description
The function converts the full file path (the AFilePath parameter) of the device sheet to the valid device sheet filename (without the file extension). If the AFilePath parameter is invalid, an empty string is returned.
Example

view sourceprint?
1ShowMessage(DeviceSheetMan.ConvertDeviceSheetPathToName('C:\Program Files\Altium Designer Summer 08\Library\Device Sheets\Audio\AUDIO_AMP_LM4849.Harness')); 
2//Returns the filename of the valid device sheet (without the file extension).

See also
IDeviceSheetManagerManager interface

EditDeviceFolderList Method

(IDeviceSheetManagerManager interface)
Syntax
Procedure EditDeviceFolderList;
Description
This procedure invokes the Device Sheet Folders dialog with all Device Sheet Folders if any.
Example

view sourceprint?
1DeviceSheetMan := DeviceSheetManager;
2If DeviceSheetMan = Nil Then Exit;
3DeviceSheetMan.EditDeviceFolderList;

See also
IDeviceSheetManagerManager interface

FindDeviceSheetPath Method

(IDeviceSheetManagerManager interface)
Syntax
Function FindDeviceSheetPath (Const AFileName : WideString) : WideString;
Description
This function finds the Device Sheet path for the valid device sheet (without the file extension). The valid device sheet is defined by the AFilename parameter. If the AFileName is invalid, a blank string is returned.
Example
ShowMessage(DeviceSheetMan.FindDeviceSheetPath('AUDIO_AMP_LM4849'));
See also
IDeviceSheetManagerManager interface

GetFoldersCount Method

(IDeviceSheetManagerManager interface)
Syntax
Function  GetFoldersCount : Integer;
Description
The GetFoldersCount function returns the number of Device Sheet Folders in Altium Designer.
Example

view sourceprint?
1DeviceSheetMan := DeviceSheetManager;
2If DeviceSheetMan = Nil Then Exit;
3Count := DeviceSheetMan.GetFoldersCount;
4ShowMessage(IntToStr(Count));

See also
IDeviceSheetManagerManager interface

GetFolders_FolderPath Method

(IDeviceSheetManagerManager interface)
Syntax
Function  GetFolders_FolderPath(AIndex : Integer) : WideString;
Description
This function returns the indexed path of device sheets (as in the Device Sheet Folders dialog). The first entry starts at zero (0).
Example

view sourceprint?
1DeviceSheetMan := DeviceSheetManager;
2If DeviceSheetMan = Nil Then Exit;
3Count := DeviceSheetMan.GetFoldersCount;
4ShowMessage(DeviceSheetMan.GetFolders_FolderPath(Count-1));

See also
IDeviceSheetManagerManager interface
GetFoldersCount method

GetFolders_SearchSubFolders Method

(IDeviceSheetManagerManager interface)
Syntax
Function GetFolders_SearchSubFolders(AIndex : Integer): Boolean;
Description
This function returns a boolean result for sub folders of the indexed path of device sheets (as in the Device Sheet Folders dialog). The first entry starts at zero (0).
Example

view sourceprint?
1DeviceSheetMan := DeviceSheetManager;
2If DeviceSheetMan = Nil Then Exit;
3Result := DeviceSheetMan.GetFolders_SearchSubFolders(0);
4If Result Then
5    ShowMessage(DeviceSheetMan.GetFolders_FolderPath(0) + ‘has its sub folders’);

See also
IDeviceSheetManagerManager interface
GetFoldersCount method

WillSearchDeviceFolder Method

(IDeviceSheetManagerManager interface)
Syntax
Function WillSearchDeviceFolder(Const AFolderPath : WideString) : Boolean;
Description
This function determines whether the Device Sheet Folder represented by the AFolderPath parameter exists or not.
Example

view sourceprint?
1If Not DeviceSheetManager.WillSearchDeviceFolder(ExtractFilePath(ASheetPath)) Then
2    DeviceSheetManager.AddDeviceFolder(ExtractFilePath(ASheetPath), False);

See also
IDeviceSheetManagerManager interface

English
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Printer-friendly version
Note

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.