IPCB_AbstractOptions interface
The base interface of the PCB options interfaces: it identifies the kind of options object and writes its settings to and reads them from a parameter string.
public interface IPCB_AbstractOptions
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Derived: IPCB_AdvancedPlacerOptions, IPCB_DesignRuleCheckerOptions, IPCB_ECOOptions, IPCB_GerberOptions, IPCB_InteractiveRoutingOptions, IPCB_OutputOptions, IPCB_PrinterOptions, IPCB_SpecctraRouterOptions, IPCB_SystemOptions
Remarks
IPCB_ServerInterface.SystemOptions and IPCB_ServerInterface.InteractiveRoutingOptions return global options objects created by the PCB Server. IPCB_Board.OutputOptions, IPCB_Board.ECOOptions, IPCB_Board.GerberOptions, IPCB_Board.PrinterOptions and IPCB_Board.PlacerOptions return the options of a PCB document.
Which settings the export and import methods handle depends on the options interface; see the derived interfaces. Export_ToParameters_Version4 and Import_FromParameters_Version4 handle the same parameters as Export_ToParameters and Import_FromParameters.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| ObjectID | TOptionsObjectId | get; set | The kind of options object, set by each options object when it is created: for example TOptionsObjectId.eSystemOptions for the system options and TOptionsObjectId.ePrinterOptions for printer opti… |
ObjectID
The kind of options object, set by each options object when it is created: for example TOptionsObjectId.eSystemOptions for the system options and TOptionsObjectId.ePrinterOptions for printer options.
TOptionsObjectId GetState_ObjectID();
void SetState_ObjectID(TOptionsObjectId argOId);
Type: TOptionsObjectId · Access: read/write
The accessors are extension methods of IPCB_AbstractOptionsHelper (using PCB;).
Methods
| Method | Returns | Description |
|---|---|---|
| Export_ToParameters | void | Writes the settings of the options object to a parameter string. |
| Export_ToParameters_Version3 | void | Writes the settings of the options object to a parameter string in the version 3 layout. |
| Export_ToParameters_Version4 | void | Writes the settings of the options object to a parameter string, as Export_ToParameters does. |
| Import_FromParameters | void | Reads the settings of the options object from a parameter string. |
| Import_FromParameters_Version3 | void | Reads the settings of the options object from a parameter string in the version 3 layout. |
| Import_FromParameters_Version4 | void | Reads the settings of the options object from a parameter string, as Import_FromParameters does. |
Export_ToParameters
Writes the settings of the options object to a parameter string.
void Export_ToParameters(ref string argParameters);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argParameters | string | ref | The parameter string that receives the settings. |
Returns: nothing (void)
The previous content of the string is discarded.
Export_ToParameters_Version3
Writes the settings of the options object to a parameter string in the version 3 layout.
void Export_ToParameters_Version3(ref string argParameters);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argParameters | string | ref | The parameter string that receives the settings. |
Returns: nothing (void)
The previous content of the string is discarded.
Export_ToParameters_Version4
Writes the settings of the options object to a parameter string, as Export_ToParameters does.
void Export_ToParameters_Version4(ref string argParameters);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argParameters | string | ref | The parameter string that receives the settings. |
Returns: nothing (void)
The previous content of the string is discarded.
Import_FromParameters
Reads the settings of the options object from a parameter string.
void Import_FromParameters(TUnit argDisplayUnit, string argParameters);
void Import_FromParameters(int argDisplayUnit, string argParameters);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argDisplayUnit | TUnit | value | The unit of coordinate values in the string that have no mm or mil suffix: millimetres for TUnit.eMetric, mils for TUnit.eImperial. |
argParameters | string | value | The parameter string to read. |
Returns: nothing (void)
The first overload is an extension method of IPCB_AbstractOptionsHelper (using PCB;) with typed parameters; the second is declared by the interface.
Import_FromParameters_Version3
Reads the settings of the options object from a parameter string in the version 3 layout.
void Import_FromParameters_Version3(TUnit argDisplayUnit, string argParameters);
void Import_FromParameters_Version3(int argDisplayUnit, string argParameters);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argDisplayUnit | TUnit | value | The unit of coordinate values in the string that have no mm or mil suffix: millimetres for TUnit.eMetric, mils for TUnit.eImperial. |
argParameters | string | value | The parameter string to read. |
Returns: nothing (void)
The first overload is an extension method of IPCB_AbstractOptionsHelper (using PCB;) with typed parameters; the second is declared by the interface.
Import_FromParameters_Version4
Reads the settings of the options object from a parameter string, as Import_FromParameters does.
void Import_FromParameters_Version4(TUnit argDisplayUnit, string argParameters);
void Import_FromParameters_Version4(int argDisplayUnit, string argParameters);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argDisplayUnit | TUnit | value | The unit of coordinate values in the string that have no mm or mil suffix: millimetres for TUnit.eMetric, mils for TUnit.eImperial. |
argParameters | string | value | The parameter string to read. |
Returns: nothing (void)
The first overload is an extension method of IPCB_AbstractOptionsHelper (using PCB;) with typed parameters; the second is declared by the interface.