IAutomation Methods

Methods

AddToErrorLog Add an entry to the error log, this can be a warning too.
CheckAddInLicence(String) Check out license for plugin.
CheckAddInLicence(String, Boolean) Check out license for plugin.
CheckOutAddInLicence Check out license for plugin. This also shows message if no license available and gives local users a way to insert license key.
CheckPCBILicenceAPI Check PCBI allows using API interface. It is possible to get an API license without option to show PCB-Investigator and maybe you can show PCB-Investigator but have no license to add your own API methods.
ClosePCBIWindow Close one instance of IPCBIWindow, only relevant if HideOnClosing=true.
CompareLayers(IPCBIWindow, ILayer, IPCBIWindow, ILayer, IPCBIWindow, Boolean, RectangleF, Boolean) Compare to layers grahicly, internal it will be create two images of the layers and compare on 5 µm.
CompareLayers(IPCBIWindow, ILayer, IPCBIWindow, ILayer, IPCBIWindow, Boolean, RectangleF, Boolean, Boolean) Compare to layers grahicly, internal it will be create two images of the layers and compare on 5 µm.
ConvertLinkListToFileList 
ConvertLinkToFile Returns null or a IFileData for different file links like: - "C:\\file.txt" - "https://server/file.txt" - "PCBI365://group/folder/file.txt:146"
CreateNewPCBILibrary Create a new IPCBIWindow without UI (only for use in pure library mode). Init the IAutomation before using this methode or copy the PCB-Investigator.exe beside your EXE-File.
CreateNewPCBIWindow Create a new IPCBIWindow. Init the IAutomation before using this methode or copy the PCB-Investigator.exe beside your EXE-File.
GetAddInVisible Get the value of visibility.
GetAllOpenPCBIWindows Get all open IPCBIWindows.
GetEndDateOfLicence End date of your PCB-Investigator license. It is important to init the options before, this will be done e.g. by create a IPCBIWindow.
GetErrorLog The ErrorLog provides information in case of an read file error.
GetExternalOption Do not use this Ini option in plugins!
GetExternalProgramPath Helper programs like comparer or Panel Optimizer save there path here.
GetLanguagePackage Return the language name e.g. english. Value can only be used after creating an IPCBIWindow instance.
GetLCDongleSerialNumber Gets the serial number of the plugged LC Dongle (red), or an empty string
GetLicenceMaxVersion Returns the maximum PCBI major version, for which the licence is valid (e.g. "13" for "PCB-Investigator V13.x")
GetPCBIWorkingDirectory OBSOLETE: Get the internal working directory for temp-data or unzip jobs etc. (Default is user temp path: Path.GetTempPath()+PCBI) Value can only be used after creating an IPCBIWindow instance.
GetPCBIWorkingDirectory(IPCBIWindow) Get the internal working directory (+suffix if set in IPCBIWindow) for temp-data or unzip jobs etc. (Default is user temp path: Path.GetTempPath()+PCBI) Value can only be used after creating an IPCBIWindow instance.
GetPCBIWorkingDirectoryBase Get the internal working directory for temp-data or unzip jobs etc. (Default is user temp path: Path.GetTempPath()+PCBI) Value can only be used after creating an IPCBIWindow instance.
GetSODIdentityProvider Returns the last used identity provider for SOD2 license
GetSODUserName Returns the SOD User name, if SOD is the active licence system
GetUniquePCNumber You can use the unique PC number for generating your licence keys.
IAutomationInit Initialise PCB-Investigator and the IAutomation Interface, neccessary for calculations. Works only if PCB-Investigator.exe is in the same directory as startup application.
IAutomationInit(Boolean) Initialise PCB-Investigator and the IAutomation Interface, neccessary for calculations. Works only if PCB-Investigator.exe is in the same directory as startup application.
IAutomationInit(String) Initialise PCB-Investigator and the IAutomation Interface, neccessary for calculations. Call this init at the begin of your application!
IAutomationInit(Boolean, String) Initialise PCB-Investigator and the IAutomation Interface, neccessary for calculations. Call this init at the begin of your application!
IAutomationInit(Boolean, String, Boolean, Boolean) Initialise PCB-Investigator and the IAutomation Interface, neccessary for calculations. Call this init at the begin of your application! And call this init only one time at the beginning, later use CreateNewPCBIWindow to get new IPCBIWindows.
InitAssemblyResolve Add Eventhandler to System.AppDomain.CurrentDomain.AssemblyResolve, to resolve PCBI dlls in resources/Plugin/DevPlugin (sub)directories
IsODBAllowed Ask PCB-Investigator for checking ODB++ license.
MakeStringCADConform Supersedes all not allowed characters with _.
OpenEmbeddedDesign Open a PCB-Investigator-Embedded-Design, this will only take the ODB++ data from the embedded design with the same licence the referenced PCB-Investigator version has. Attention: If you want to use the embedded PCB-Investigator to work without licence you have to call IAutomationInit with ExecutabelPathPCBI on the located embedded-design!
RegisterCodePages Register addional codepages for Encoding.GetEncoding (e.g. Windows-1252)
ResetErrorLog Clears the error log.
SaveOptionToIni Do not use the Ini option in plugins!
SetAddInVisible Change the PlugIn visibility. Value can only be used after creating an IPCBIWindow instance.
SetDongleLicence Set Dongle License. Dongle must be connected via USB!
SetExternalProgramPath Set The path for a helper program e.g. Panel Optimizer.
SetFloatingLicence Set Floating Server IP with Port.
SetLanguagePackage Set the language for PCB-Investigator e.g. English. Value can only be used after creating an IPCBIWindow instance.
SetLibraryMode Special Library Mode use extra license.
SetPCBIWorkingDirectory OBSOLETE: Set the internal working directory for temp-data or unzip jobs etc. (Default is user temp path: Path.GetTempPath()) Value can only be used after creating an IPCBIWindow instance.
SetPCBIWorkingDirectoryBase Set the internal working directory for temp-data or unzip jobs etc. (Default is user temp path: Path.GetTempPath()) Value can only be used after creating an IPCBIWindow instance.
SetSODLicence Set User Name for SOD License System.
SetSODTokenAsync Switches license system to new SOD with a new refresh_token
UpdateDongleLicence Updates the dongle licence from an existing XML file
UseSODToken Switches License System to new SOD if encrypted refresh_token exists.
XMLDeserializeFromFileT(IFileData, T) Deserialize a xml file with PCBI standard settings.
XMLDeserializeFromFileT(IFileData, T, Boolean) Deserialize a xml file with PCBI standard settings.
XMLSerializeToFile(IFileData, Object) Serialize a file with PCBI standard settings.
XMLSerializeToFile(IFileData, Object, Boolean) Serialize a file with PCBI standard settings.

See Also