IImporterController interface
No description yet.
public interface IImporterController
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Derived: IImporterController_OrcadCIS
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| Description | string | get | |
| Name | string | get | |
| SupportedDocKindCount | int | get | |
| SupportedDocKindDesc | string | get | |
| SupportedDocKindName | string | get |
Description
No description yet.
string Get_Description();
Type: string · Access: read-only
Name
No description yet.
string Get_Name();
Type: string · Access: read-only
SupportedDocKindCount
No description yet.
int Get_SupportedDocKindCount();
Type: int · Access: read-only
SupportedDocKindDesc
No description yet.
string Get_SupportedDocKindDesc(int argIndex);
Type: string · Access: read-only · Index: argIndex (int)
SupportedDocKindName
No description yet.
string Get_SupportedDocKindName(int argIndex);
Type: string · Access: read-only · Index: argIndex (int)
Methods
| Method | Returns | Description |
|---|---|---|
| CanImportFile | bool | |
| CreateImporterFile | IImporterFile | |
| DestroyObject | void | |
| DisplayDialog | void | |
| GetDocKindForDocument | string | |
| GetMinimumSizeForDialog | void | |
| ImportFile | void | |
| IsEnabled | bool |
CanImportFile
No description yet.
bool CanImportFile(string argFilePath);
| Parameter | Type | Passing |
|---|---|---|
argFilePath | string | value |
Returns: bool
CreateImporterFile
No description yet.
IImporterFile CreateImporterFile(string argFilePath);
| Parameter | Type | Passing |
|---|---|---|
argFilePath | string | value |
Returns: IImporterFile
Extension method of IImporterControllerHelper (using PCB;).
DestroyObject
No description yet.
void DestroyObject(ref IImporterObject argObject);
void DestroyObject(ref object argObject);
| Parameter | Type | Passing |
|---|---|---|
argObject | IImporterObject | ref |
Returns: nothing (void)
The first overload is an extension method of IImporterControllerHelper (using PCB;) with typed parameters; the second is declared by the interface.
DisplayDialog
No description yet.
void DisplayDialog(bool argShowIntro, int argX, int argY, int argWidth, int argHeight);
| Parameter | Type | Passing |
|---|---|---|
argShowIntro | bool | value |
argX | int | value |
argY | int | value |
argWidth | int | value |
argHeight | int | value |
Returns: nothing (void)
GetDocKindForDocument
No description yet.
string GetDocKindForDocument(string argFilePath);
| Parameter | Type | Passing |
|---|---|---|
argFilePath | string | value |
Returns: string
GetMinimumSizeForDialog
No description yet.
void GetMinimumSizeForDialog(out int argWidth, out int argHeight);
| Parameter | Type | Passing |
|---|---|---|
argWidth | int | out |
argHeight | int | out |
Returns: nothing (void)
ImportFile
No description yet.
void ImportFile(string argFilePath);
| Parameter | Type | Passing |
|---|---|---|
argFilePath | string | value |
Returns: nothing (void)
IsEnabled
No description yet.
bool IsEnabled();
Returns: bool
Returned by
IImporterManager_ServerInterface.Controller, IImporterManager_ServerInterface.GetControllerByDocKind, IImporterManager_ServerInterface.GetControllerByName, IImporterManager_ServerInterface.GetControllerForDoc