Skip to main content
View as Markdown

IPCB_SystemOptions interface

The global settings of the PCB Editor, returned by IPCB_ServerInterface.SystemOptions.

public interface IPCB_SystemOptions : IPCB_AbstractOptions

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Inherits: IPCB_AbstractOptions

Remarks​

The interface extends IPCB_AbstractOptions. Export_ToParameters_Version3 and Import_FromParameters_Version3 handle only part of the settings, with the per-layer settings in the version 3 layer numbering.

Example​

Switch the board cursor to the next cursor shape.

using PCB;

IPCB_SystemOptions pcbSystemOptions = PCB.GlobalVars.PCBServer?.GetState_SystemOptions();
if (pcbSystemOptions == null)
return;
if (pcbSystemOptions.GetState_BoardCursorType() == TGraphicsCursor.eCurShapeCross90)
pcbSystemOptions.SetState_BoardCursorType(TGraphicsCursor.eCurShapeBigCross);
else if (pcbSystemOptions.GetState_BoardCursorType() == TGraphicsCursor.eCurShapeBigCross)
pcbSystemOptions.SetState_BoardCursorType(TGraphicsCursor.eCurShapeCross45);
else
pcbSystemOptions.SetState_BoardCursorType(TGraphicsCursor.eCurShapeCross90);

Properties​

PropertyTypeAccessDescription
AmbiguityMenuboolget; set
AmbiguityThresholdintget; set
AutoPanboolget; set
AutoPanLargeStepintget; set
AutoPanModeTAutoPanModeget; set
AutoPanSmallStepintget; set
AutoPanSpeedintget; set
AutoPanUnitTAutoPanUnitget; set
AutoViaboolget; set
BoardAreaColoruintget; set
BoardCursorTypeTGraphicsCursorget; set
BoardLineColoruintget; set
CheckCommentsboolget; set
CheckPatternsboolget; set
CleanRedrawboolget; set
ClickClearsSelectionboolget; set
Com1ParametersSerialParametersget; set
Com2ParametersSerialParametersget; set
Com3ParametersSerialParametersget; set
Com4ParametersSerialParametersget; set
ComponentMoveKindTComponentMoveKindget; set
ComponentRefPointColoruintget; set
ConfirmSelectionMemoryClearboolget; set
DefaultPrimsPermanentboolget; set
DefaultTTFontstringget; set
DeleteDeadEndsboolget; set
DeleteUnconnectedCompsboolget; set
DeleteUnconnectedPrimsboolget; set
DisplaySpecialStringsboolget; set
DoOnlineDRCboolget; setWhether online design rule checking is on.
DoubleClickRunsInspectorboolget; set
DraftTrackThresholdintget; setThe width at or below which tracks and arcs drawn in outline form are drawn as a single thin line instead, in internal units (10,000 per mil).
DragModeTPcbDragModeget; set
DrawModeTDrawModeget; setThe draw mode of one kind of object in the PCB document of the active view.
DuplicateDesignatorsAllowedboolget; set
FractionalDigitsintget; set
FromTosDisplayModeTFromToDisplayModeget; set
GlobalEditIncludeArcsWithTracksboolget; set
HighlightFullboolget; set
HoldShiftToSelectObjectIdboolget; set
InteractiveRouteModeTInteractiveRouteModeget; set
LayerColorsuintget; set
LayerColors_V7uintget; set
LayerDrawingOrderV7_LayerBaseget; set
LayerDrawingOrderCountintget; set
LayerNameDisplayModeTLayerNameDisplayModeget; set
LockPreRoutesboolget; set
LoopRemovalboolget; set
MinPadViaObjectSizeInPixelsintget; set
ModelOptionsIPCB_ModelOptionsget
MustHoldShiftToSelectboolget; set
NearestComponentboolget; set
NetlistReportDialogboolget; set
NetlistReportFileboolget; set
OnlySelectVisibleboolget; set
OriginMarkerColoruintget; set
PadstackUpdateFromGlobalsOnLoadTSameNamePadstackReplacementModeget; set
PadTypesDisplayModeTFromToDisplayModeget; set
PadViaFontBkColoruintget; set
PadViaFontColoruintget; set
PadViaFontNamestringget; set
PadViaFontStyleTFontStyleSetget; set
PadViaMinFontSizeintget; setThe size of the pad and via font, the font named by PadViaFontName.
Paste_HasSameDesignatorboolget; set
Paste_InSameClassboolget; set
Paste_InSameNetboolget; set
Paste_OnSameLayerboolget; set
PlaceShoveDepthintget; set
PlaneDrawModeTPlaneDrawModeget; set
PlowThroughPolygonsboolget; set
PolygonRepourTPolygonRepourModeget; set
PolygonThresholdintget; set
ProtectLockedPrimitivesboolget; set
QuestionDeleteboolget; set
QuestionDragboolget; set
QuestionGlobalChangeboolget; set
RedrawLayerOnToggleboolget; set
RemoveDuplicatesOnOutputboolget; set
RepeatCircularboolget; set
RepeatCountDefaultintget; set
RepeatDegreesdoubleget; set
RepeatIncstringget; set
RepeatRotateItemboolget; set
RepeatXdoubleget; set
RepeatXUnitTUnitget; set
RepeatYdoubleget; set
RepeatYUnitTUnitget; set
ReportsCSVboolget; set
RotationStepdoubleget; setThe angle, in degrees, by which the object being moved or placed is rotated when Space is pressed (Shift+Space rotates it the other way).
SameNamePadstackReplacementModeTSameNamePadstackReplacementModeget; set
SaveDefsboolget; set
ShadowsInPCBboolget; set
SheetAreaColoruintget; set
SheetLineColoruintget; set
ShowAllPrimitivesInHighlightedNetsboolget; set
ShowComponentRefPointboolget; set
ShowInvisibleObjectsboolget; set
ShowPadNetsboolget; set
ShowPadNumbersboolget; set
ShowStatusInfoboolget; set
ShowStatusIntervalintget; set
ShowTestPointsboolget; set
ShowViaNetsboolget; set
SingleLayerModeboolget; setWhether single layer mode is on.
SnapToCentreboolget; set
TextToRectSizeintget; set
UndoRedoStackSizeintget; setThe size of the undo stack of the PCB Editor.
UseDitheredboolget; set
UseNetColorForHighlightboolget; set
UseSmartTrackEndsboolget; set
UseTransparentboolget; set
ValidateOnLoadboolget; set
WorkspaceColor1uintget; set
WorkspaceColor2uintget; set

AmbiguityMenu​

No description yet.

bool GetState_AmbiguityMenu();
void SetState_AmbiguityMenu(bool argValue);

Type: bool · Access: read/write

AmbiguityThreshold​

No description yet.

int GetState_AmbiguityThreshold();
void SetState_AmbiguityThreshold(int argValue);

Type: int · Access: read/write

Reading always returns 0; setting the property does nothing.

AutoPan​

No description yet.

bool GetState_AutoPan();
void SetState_AutoPan(bool argValue);

Type: bool · Access: read/write

AutoPanLargeStep​

No description yet.

int GetState_AutoPanLargeStep();
void SetState_AutoPanLargeStep(int argValue);

Type: int · Access: read/write

AutoPanMode​

No description yet.

TAutoPanMode GetState_AutoPanMode();
void SetState_AutoPanMode(TAutoPanMode argValue);

Type: TAutoPanMode · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

AutoPanSmallStep​

No description yet.

int GetState_AutoPanSmallStep();
void SetState_AutoPanSmallStep(int argValue);

Type: int · Access: read/write

AutoPanSpeed​

No description yet.

int GetState_AutoPanSpeed();
void SetState_AutoPanSpeed(int argValue);

Type: int · Access: read/write

AutoPanUnit​

No description yet.

TAutoPanUnit GetState_AutoPanUnit();
void SetState_AutoPanUnit(TAutoPanUnit argValue);

Type: TAutoPanUnit · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

AutoVia​

No description yet.

bool GetState_AutoVia();
void SetState_AutoVia(bool argValue);

Type: bool · Access: read/write

BoardAreaColor​

No description yet.

uint GetState_BoardAreaColor();
void SetState_BoardAreaColor(uint argValue);

Type: uint · Access: read/write

BoardCursorType​

No description yet.

TGraphicsCursor GetState_BoardCursorType();
void SetState_BoardCursorType(TGraphicsCursor argValue);

Type: TGraphicsCursor · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

BoardLineColor​

No description yet.

uint GetState_BoardLineColor();
void SetState_BoardLineColor(uint argValue);

Type: uint · Access: read/write

CheckComments​

No description yet.

bool GetState_CheckComments();
void SetState_CheckComments(bool argValue);

Type: bool · Access: read/write

CheckPatterns​

No description yet.

bool GetState_CheckPatterns();
void SetState_CheckPatterns(bool argValue);

Type: bool · Access: read/write

CleanRedraw​

No description yet.

bool GetState_CleanRedraw();
void SetState_CleanRedraw(bool argValue);

Type: bool · Access: read/write

ClickClearsSelection​

No description yet.

bool GetState_ClickClearsSelection();
void SetState_ClickClearsSelection(bool argValue);

Type: bool · Access: read/write

Com1Parameters​

No description yet.

SerialParameters GetState_Com1Parameters();
void SetState_Com1Parameters(SerialParameters argValue);

Type: SerialParameters · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

Com2Parameters​

No description yet.

SerialParameters GetState_Com2Parameters();
void SetState_Com2Parameters(SerialParameters argValue);

Type: SerialParameters · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

Com3Parameters​

No description yet.

SerialParameters GetState_Com3Parameters();
void SetState_Com3Parameters(SerialParameters argValue);

Type: SerialParameters · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

Com4Parameters​

No description yet.

SerialParameters GetState_Com4Parameters();
void SetState_Com4Parameters(SerialParameters argValue);

Type: SerialParameters · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

ComponentMoveKind​

No description yet.

TComponentMoveKind GetState_ComponentMoveKind();
void SetState_ComponentMoveKind(TComponentMoveKind argValue);

Type: TComponentMoveKind · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

ComponentRefPointColor​

No description yet.

uint GetState_ComponentRefPointColor();
void SetState_ComponentRefPointColor(uint argValue);

Type: uint · Access: read/write

ConfirmSelectionMemoryClear​

No description yet.

bool GetState_ConfirmSelectionMemoryClear();
void SetState_ConfirmSelectionMemoryClear(bool argValue);

Type: bool · Access: read/write

DefaultPrimsPermanent​

No description yet.

bool GetState_DefaultPrimsPermanent();
void SetState_DefaultPrimsPermanent(bool argValue);

Type: bool · Access: read/write

DefaultTTFont​

No description yet.

string GetState_DefaultTTFont();
void SetState_DefaultTTFont(string argValue);

Type: string · Access: read/write

DeleteDeadEnds​

No description yet.

bool GetState_DeleteDeadEnds();
void SetState_DeleteDeadEnds(bool argValue);

Type: bool · Access: read/write

DeleteUnconnectedComps​

No description yet.

bool GetState_DeleteUnconnectedComps();
void SetState_DeleteUnconnectedComps(bool argValue);

Type: bool · Access: read/write

DeleteUnconnectedPrims​

No description yet.

bool GetState_DeleteUnconnectedPrims();
void SetState_DeleteUnconnectedPrims(bool argValue);

Type: bool · Access: read/write

DisplaySpecialStrings​

No description yet.

bool GetState_DisplaySpecialStrings();
void SetState_DisplaySpecialStrings(bool argValue);

Type: bool · Access: read/write

DoOnlineDRC​

Whether online design rule checking is on.

bool GetState_DoOnlineDRC();
void SetState_DoOnlineDRC(bool argValue);

Type: bool · Access: read/write

When false, objects are not checked against the online design rules as they change.

DoubleClickRunsInspector​

No description yet.

bool GetState_DoubleClickRunsInspector();
void SetState_DoubleClickRunsInspector(bool argValue);

Type: bool · Access: read/write

DraftTrackThreshold​

The width at or below which tracks and arcs drawn in outline form are drawn as a single thin line instead, in internal units (10,000 per mil).

int GetState_DraftTrackThreshold();
void SetState_DraftTrackThreshold(int argValue);

Type: int · Access: read/write

DragMode​

No description yet.

TPcbDragMode GetState_DragMode();
void SetState_DragMode(TPcbDragMode argValue);

Type: TPcbDragMode · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

DrawMode​

The draw mode of one kind of object in the PCB document of the active view.

TDrawMode GetState_DrawMode(TObjectId argOId);
void SetState_DrawMode(TObjectId argOId, TDrawMode argValue);

Type: TDrawMode · Access: read/write · Index: argOId (TObjectId): The kind of object.

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

When the active view does not show a PCB document, reading returns TDrawMode.eDrawFull and setting the property does nothing.

DuplicateDesignatorsAllowed​

No description yet.

bool GetState_DuplicateDesignatorsAllowed();
void SetState_DuplicateDesignatorsAllowed(bool argValue);

Type: bool · Access: read/write

FractionalDigits​

No description yet.

int GetState_FractionalDigits(TUnit argUnit);
void SetState_FractionalDigits(TUnit argUnit, int argDigits);

Type: int · Access: read/write · Index: argUnit (TUnit)

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

FromTosDisplayMode​

No description yet.

TFromToDisplayMode GetState_FromTosDisplayMode();
void SetState_FromTosDisplayMode(TFromToDisplayMode argValue);

Type: TFromToDisplayMode · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

Reading always returns TFromToDisplayMode.eFromToDisplayMode_Automatic; setting the property does nothing.

GlobalEditIncludeArcsWithTracks​

No description yet.

bool GetState_GlobalEditIncludeArcsWithTracks();
void SetState_GlobalEditIncludeArcsWithTracks(bool argValue);

Type: bool · Access: read/write

HighlightFull​

No description yet.

bool GetState_HighlightFull();
void SetState_HighlightFull(bool argValue);

Type: bool · Access: read/write

HoldShiftToSelectObjectId​

No description yet.

bool GetState_HoldShiftToSelectObjectId(TObjectId argOId);
void SetState_HoldShiftToSelectObjectId(TObjectId argOId, bool argValue);

Type: bool · Access: read/write · Index: argOId (TObjectId)

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

InteractiveRouteMode​

No description yet.

TInteractiveRouteMode GetState_InteractiveRouteMode();
void SetState_InteractiveRouteMode(TInteractiveRouteMode argValue);

Type: TInteractiveRouteMode · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

LayerColors​

No description yet.

uint GetState_LayerColors(TV6_Layer argL);
void SetState_LayerColors(TV6_Layer argL, uint argValue);

Type: uint · Access: read/write · Index: argL (TV6_Layer)

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

Reads and writes the same colour as LayerColors_V7 for the same layer.

LayerColors_V7​

No description yet.

uint GetState_LayerColors_V7(V7_LayerBase argL);
void SetState_LayerColors_V7(V7_LayerBase argL, uint argValue);

Type: uint · Access: read/write · Index: argL (V7_LayerBase)

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

LayerDrawingOrder​

No description yet.

V7_LayerBase GetState_LayerDrawingOrder(int argI);
void SetState_LayerDrawingOrder(int argI, V7_LayerBase argValue);

Type: V7_LayerBase · Access: read/write · Index: argI (int)

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

LayerDrawingOrderCount​

No description yet.

int GetState_LayerDrawingOrderCount();
void SetState_LayerDrawingOrderCount(int argI);

Type: int · Access: read/write

LayerNameDisplayMode​

No description yet.

TLayerNameDisplayMode GetState_LayerNameDisplayMode();
void SetState_LayerNameDisplayMode(TLayerNameDisplayMode argValue);

Type: TLayerNameDisplayMode · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

LockPreRoutes​

No description yet.

bool GetState_LockPreRoutes();
void SetState_LockPreRoutes(bool argValue);

Type: bool · Access: read/write

LoopRemoval​

No description yet.

bool GetState_LoopRemoval();
void SetState_LoopRemoval(bool argValue);

Type: bool · Access: read/write

MinPadViaObjectSizeInPixels​

No description yet.

int GetState_MinPadViaObjectSizeInPixels();
void SetState_MinPadViaObjectSizeInPixels(int argValue);

Type: int · Access: read/write

ModelOptions​

No description yet.

IPCB_ModelOptions GetState_ModelOptions();

Type: IPCB_ModelOptions · Access: read-only

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

MustHoldShiftToSelect​

No description yet.

bool GetState_MustHoldShiftToSelect();
void SetState_MustHoldShiftToSelect(bool argValue);

Type: bool · Access: read/write

NearestComponent​

No description yet.

bool GetState_NearestComponent();
void SetState_NearestComponent(bool argValue);

Type: bool · Access: read/write

NetlistReportDialog​

No description yet.

bool GetState_NetlistReportDialog();
void SetState_NetlistReportDialog(bool argValue);

Type: bool · Access: read/write

NetlistReportFile​

No description yet.

bool GetState_NetlistReportFile();
void SetState_NetlistReportFile(bool argValue);

Type: bool · Access: read/write

OnlySelectVisible​

No description yet.

bool GetState_OnlySelectVisible();
void SetState_OnlySelectVisible(bool argValue);

Type: bool · Access: read/write

OriginMarkerColor​

No description yet.

uint GetState_OriginMarkerColor();
void SetState_OriginMarkerColor(uint argValue);

Type: uint · Access: read/write

PadstackUpdateFromGlobalsOnLoad​

No description yet.

TSameNamePadstackReplacementMode GetState_PadstackUpdateFromGlobalsOnLoad();
void SetState_PadstackUpdateFromGlobalsOnLoad(TSameNamePadstackReplacementMode argValue);

Type: TSameNamePadstackReplacementMode · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

PadTypesDisplayMode​

No description yet.

TFromToDisplayMode GetState_PadTypesDisplayMode();
void SetState_PadTypesDisplayMode(TFromToDisplayMode argValue);

Type: TFromToDisplayMode · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

Reading always returns TFromToDisplayMode.eFromToDisplayMode_Automatic; setting the property does nothing.

PadViaFontBkColor​

No description yet.

uint GetState_PadViaFontBkColor();
void SetState_PadViaFontBkColor(uint argValue);

Type: uint · Access: read/write

PadViaFontColor​

No description yet.

uint GetState_PadViaFontColor();
void SetState_PadViaFontColor(uint argValue);

Type: uint · Access: read/write

PadViaFontName​

No description yet.

string GetState_PadViaFontName();
void SetState_PadViaFontName(string argValue);

Type: string · Access: read/write

PadViaFontStyle​

No description yet.

TFontStyleSet GetState_PadViaFontStyle();
void SetState_PadViaFontStyle(TFontStyleSet argValue);

Type: TFontStyleSet · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

PadViaMinFontSize​

The size of the pad and via font, the font named by PadViaFontName.

int GetState_PadViaMinFontSize();
void SetState_PadViaMinFontSize(int argValue);

Type: int · Access: read/write

Paste_HasSameDesignator​

No description yet.

bool GetState_Paste_HasSameDesignator();
void SetState_Paste_HasSameDesignator(bool argValue);

Type: bool · Access: read/write

Paste_InSameClass​

No description yet.

bool GetState_Paste_InSameClass();
void SetState_Paste_InSameClass(bool argValue);

Type: bool · Access: read/write

Paste_InSameNet​

No description yet.

bool GetState_Paste_InSameNet();
void SetState_Paste_InSameNet(bool argValue);

Type: bool · Access: read/write

Paste_OnSameLayer​

No description yet.

bool GetState_Paste_OnSameLayer();
void SetState_Paste_OnSameLayer(bool argValue);

Type: bool · Access: read/write

PlaceShoveDepth​

No description yet.

int GetState_PlaceShoveDepth();
void SetState_PlaceShoveDepth(int argValue);

Type: int · Access: read/write

PlaneDrawMode​

No description yet.

TPlaneDrawMode GetState_PlaneDrawMode();
void SetState_PlaneDrawMode(TPlaneDrawMode argValue);

Type: TPlaneDrawMode · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

PlowThroughPolygons​

No description yet.

bool GetState_PlowThroughPolygons();
void SetState_PlowThroughPolygons(bool argValue);

Type: bool · Access: read/write

PolygonRepour​

No description yet.

TPolygonRepourMode GetState_PolygonRepour();
void SetState_PolygonRepour(TPolygonRepourMode argValue);

Type: TPolygonRepourMode · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

Setting TPolygonRepourMode.eAlwaysRepour stores that value; any other value is stored as TPolygonRepourMode.eNeverRepour.

PolygonThreshold​

No description yet.

int GetState_PolygonThreshold();
void SetState_PolygonThreshold(int argValue);

Type: int · Access: read/write

ProtectLockedPrimitives​

No description yet.

bool GetState_ProtectLockedPrimitives();
void SetState_ProtectLockedPrimitives(bool argValue);

Type: bool · Access: read/write

QuestionDelete​

No description yet.

bool GetState_QuestionDelete();
void SetState_QuestionDelete(bool argValue);

Type: bool · Access: read/write

QuestionDrag​

No description yet.

bool GetState_QuestionDrag();
void SetState_QuestionDrag(bool argValue);

Type: bool · Access: read/write

QuestionGlobalChange​

No description yet.

bool GetState_QuestionGlobalChange();
void SetState_QuestionGlobalChange(bool argValue);

Type: bool · Access: read/write

RedrawLayerOnToggle​

No description yet.

bool GetState_RedrawLayerOnToggle();
void SetState_RedrawLayerOnToggle(bool argValue);

Type: bool · Access: read/write

RemoveDuplicatesOnOutput​

No description yet.

bool GetState_RemoveDuplicatesOnOutput();
void SetState_RemoveDuplicatesOnOutput(bool argValue);

Type: bool · Access: read/write

RepeatCircular​

No description yet.

bool GetState_RepeatCircular();
void SetState_RepeatCircular(bool argValue);

Type: bool · Access: read/write

RepeatCountDefault​

No description yet.

int GetState_RepeatCountDefault();
void SetState_RepeatCountDefault(int argValue);

Type: int · Access: read/write

RepeatDegrees​

No description yet.

double GetState_RepeatDegrees();
void SetState_RepeatDegrees(double argValue);

Type: double · Access: read/write

RepeatInc​

No description yet.

string GetState_RepeatInc();
void SetState_RepeatInc(string argValue);

Type: string · Access: read/write

RepeatRotateItem​

No description yet.

bool GetState_RepeatRotateItem();
void SetState_RepeatRotateItem(bool argValue);

Type: bool · Access: read/write

RepeatX​

No description yet.

double GetState_RepeatX();
void SetState_RepeatX(double argValue);

Type: double · Access: read/write

RepeatXUnit​

No description yet.

TUnit GetState_RepeatXUnit();
void SetState_RepeatXUnit(TUnit argValue);

Type: TUnit · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

RepeatY​

No description yet.

double GetState_RepeatY();
void SetState_RepeatY(double argValue);

Type: double · Access: read/write

RepeatYUnit​

No description yet.

TUnit GetState_RepeatYUnit();
void SetState_RepeatYUnit(TUnit argValue);

Type: TUnit · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

ReportsCSV​

No description yet.

bool GetState_ReportsCSV();
void SetState_ReportsCSV(bool argValue);

Type: bool · Access: read/write

RotationStep​

The angle, in degrees, by which the object being moved or placed is rotated when Space is pressed (Shift+Space rotates it the other way).

double GetState_RotationStep();
void SetState_RotationStep(double argValue);

Type: double · Access: read/write

SameNamePadstackReplacementMode​

No description yet.

TSameNamePadstackReplacementMode GetState_SameNamePadstackReplacementMode();
void SetState_SameNamePadstackReplacementMode(TSameNamePadstackReplacementMode argValue);

Type: TSameNamePadstackReplacementMode · Access: read/write

The accessors are extension methods of IPCB_SystemOptionsHelper (using PCB;).

SaveDefs​

No description yet.

bool GetState_SaveDefs();
void SetState_SaveDefs(bool argValue);

Type: bool · Access: read/write

ShadowsInPCB​

No description yet.

bool GetState_ShadowsInPCB();
void SetState_ShadowsInPCB(bool argValue);

Type: bool · Access: read/write

SheetAreaColor​

No description yet.

uint GetState_SheetAreaColor();
void SetState_SheetAreaColor(uint argValue);

Type: uint · Access: read/write

SheetLineColor​

No description yet.

uint GetState_SheetLineColor();
void SetState_SheetLineColor(uint argValue);

Type: uint · Access: read/write

ShowAllPrimitivesInHighlightedNets​

No description yet.

bool GetState_ShowAllPrimitivesInHighlightedNets();
void SetState_ShowAllPrimitivesInHighlightedNets(bool argValue);

Type: bool · Access: read/write

ShowComponentRefPoint​

No description yet.

bool GetState_ShowComponentRefPoint();
void SetState_ShowComponentRefPoint(bool argValue);

Type: bool · Access: read/write

ShowInvisibleObjects​

No description yet.

bool GetState_ShowInvisibleObjects();
void SetState_ShowInvisibleObjects(bool argValue);

Type: bool · Access: read/write

ShowPadNets​

No description yet.

bool GetState_ShowPadNets();
void SetState_ShowPadNets(bool argValue);

Type: bool · Access: read/write

ShowPadNumbers​

No description yet.

bool GetState_ShowPadNumbers();
void SetState_ShowPadNumbers(bool argValue);

Type: bool · Access: read/write

ShowStatusInfo​

No description yet.

bool GetState_ShowStatusInfo();
void SetState_ShowStatusInfo(bool argValue);

Type: bool · Access: read/write

ShowStatusInterval​

No description yet.

int GetState_ShowStatusInterval();
void SetState_ShowStatusInterval(int argValue);

Type: int · Access: read/write

ShowTestPoints​

No description yet.

bool GetState_ShowTestPoints();
void SetState_ShowTestPoints(bool argValue);

Type: bool · Access: read/write

ShowViaNets​

No description yet.

bool GetState_ShowViaNets();
void SetState_ShowViaNets(bool argValue);

Type: bool · Access: read/write

SingleLayerMode​

Whether single layer mode is on.

bool GetState_SingleLayerMode();
void SetState_SingleLayerMode(bool argValue);

Type: bool · Access: read/write

Reading returns the state for PCB library documents when the active view shows a PCB library, and the state for PCB documents otherwise. Setting true turns on single layer mode with the other layers hidden for both PCB and PCB library documents; setting false turns it off for both.

SnapToCentre​

No description yet.

bool GetState_SnapToCentre();
void SetState_SnapToCentre(bool argValue);

Type: bool · Access: read/write

TextToRectSize​

No description yet.

int GetState_TextToRectSize();
void SetState_TextToRectSize(int argValue);

Type: int · Access: read/write

UndoRedoStackSize​

The size of the undo stack of the PCB Editor.

int GetState_UndoRedoStackSize();
void SetState_UndoRedoStackSize(int argValue);

Type: int · Access: read/write

The value is fixed by the product; setting the property does nothing.

UseDithered​

No description yet.

bool GetState_UseDithered();
void SetState_UseDithered(bool argValue);

Type: bool · Access: read/write

UseNetColorForHighlight​

No description yet.

bool GetState_UseNetColorForHighlight();
void SetState_UseNetColorForHighlight(bool argValue);

Type: bool · Access: read/write

Reading always returns false; setting the property does nothing.

UseSmartTrackEnds​

No description yet.

bool GetState_UseSmartTrackEnds();
void SetState_UseSmartTrackEnds(bool argValue);

Type: bool · Access: read/write

UseTransparent​

No description yet.

bool GetState_UseTransparent();
void SetState_UseTransparent(bool argValue);

Type: bool · Access: read/write

ValidateOnLoad​

No description yet.

bool GetState_ValidateOnLoad();
void SetState_ValidateOnLoad(bool argValue);

Type: bool · Access: read/write

WorkspaceColor1​

No description yet.

uint GetState_WorkspaceColor1();
void SetState_WorkspaceColor1(uint argValue);

Type: uint · Access: read/write

WorkspaceColor2​

No description yet.

uint GetState_WorkspaceColor2();
void SetState_WorkspaceColor2(uint argValue);

Type: uint · Access: read/write

Methods​

MethodReturnsDescription
Export_ToIniFilevoidSaves the system options to the stored preferences of the PCB Editor.
Import_FromIniFilevoidLoads the system options from the stored preferences of the PCB Editor.
LayerColorIteratorIPCB_LayerIterator

Export_ToIniFile​

Saves the system options to the stored preferences of the PCB Editor.

void Export_ToIniFile();

Returns: nothing (void)

It replaces the stored system options.

Import_FromIniFile​

Loads the system options from the stored preferences of the PCB Editor.

void Import_FromIniFile();

Returns: nothing (void)

LayerColorIterator​

No description yet.

IPCB_LayerIterator LayerColorIterator();

Returns: IPCB_LayerIterator

Extension method of IPCB_SystemOptionsHelper (using PCB;).

Inherited members​

Returned by​

IPCB_ServerInterface.SystemOptions