ISch_Preferences interface
The ISch_Preferences interface represents the global preferences for the Schematic Editor and the settings are the same for any PCB project that has schematics in Altium Designer.
public interface ISch_Preferences
Namespace: SCH · Assembly: Altium.SDK.Interfaces
Remarks
The ISch_ServerInterface interface represents the Schematic Editor and this interface has an ISch_Preferences aggregate object interface.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| AddTemplateToClipBoard | bool | get; set | The AddTemplateToClipBoard property determines whether the current sheet template can be added to to the clipboard when you copy or cut from the current schematic sheet. |
| AllowDeviceSheetEditing | bool | get; set | |
| AlwaysDrag | bool | get; set | This property represents the AlwaysDrag option and every time you are dragging a group of objects on a schematic document, the electrical wiring stay connected if it is true. |
| AutoBackupFileCount | int | get; set | |
| AutoBackupTime | int | get; set | |
| AutoPanJumpDistance | int | get; set | This property represents the value to set/get the size of each auto-panning step. |
| AutoPanShiftJumpDistance | int | get; set | This property represents a value to get/set the size of each step when the SHIFT key is held during auto-panning. |
| AutoPanStyle | TAutoPanStyle | get; set | |
| AutoZoom | bool | get; set | This property if set to true the schematic sheet is automatically zoomed when jumping to a component. |
| BufferedPainting | bool | get; set | |
| BusAutoJunctionsColor | int | get; set | |
| BusAutoJunctionsSize | TSize | get; set | |
| BusDragJunctionsColor | int | get; set | |
| ClickClearsSelection | bool | get; set | If this property is set to true, then all design objects are de-selected by clicking any where on the schematic workspace. |
| ComponentsCutWires | bool | get; set | Set the property to true so you can drop a component onto a schematic wire and then the wire is cut into two segments and the segments are terminated onto any two hot pins of this component automatic… |
| ConfirmSelectionMemoryClear | bool | get; set | The selection memories can be used to store the selection state of a set of objects. |
| ConvertSpecialStrings | bool | get; set | This property when set to true, the contents of the special strings on screen are displayed, as they appear on a printout. |
| CrossRefLocationStyle | TCrossRefLocationStyle | get; set | |
| CrossRefSheetStyle | TCrossRefSheetStyle | get; set | |
| CtrlDbleClickGoesDown | bool | get; set | This property when set to true, the sub-sheet of its associated sheet symbol by double clicking on this sheet symbol opens in Altium Designer. |
| CutterFixedLength | int | get; set | |
| CutterGridSizeMultiple | int | get; set | |
| DefaultEarthName | string | get; set | The DefaultEarthName denotes the default signal ground name to be used for objects on the schematic document. |
| DefaultPowerGndName | string | get; set | The DefaultPowerGndName property denotes the default power ground name to be used for objects on the schematic document. |
| DefaultPrimOverridesLibraryComment | bool | get; set | |
| DefaultPrimOverridesLibraryDesignator | bool | get; set | |
| DefaultPrimsPermanent | bool | get; set | |
| DefaultSheetStyle | TSheetStyle | get; set | The DefaultSheetStyle property denotes the sheet style used for the workspace. |
| DefaultSignalGndName | string | get; set | The DefaultSignalGndName denotes the default signal ground name to be used for objects on the schematic document. |
| DefaultTemplateFileName | string | get; set | |
| DefaultUnit | TUnit | get; set | |
| DefaultUnitSystem | TUnitSystem | get | |
| DisplayPrinterFonts | bool | get; set | The DisplayPrinterFonts property denotes whether the printer fonts can be displayed or not. |
| DocMenuID | string | get; set | The DocMenuID property determines which pop up menu to pop up depending on whether it is a schematic or a library document. |
| DocumentScope | TChosenDocumentScope | get; set | The DocumentScope property determines the scope for filtering and selection to be applied to the current document or to any open document in Altium Designer. |
| DoubleClickRunsInspector | bool | get; set | This property represents the option to bring up the Inspector dialog instead of the design object's properties dialog when you double click on a design object. |
| DragJunctionsColor | int | get; set | |
| DragJunctionsSize | TSize | get; set | |
| DragStairSize | TSize | get; set | |
| DragStepSize | TSize | get; set | |
| ExpandComponentDesignators | bool | get; set | |
| ExpandDocumentNumber | bool | get; set | |
| ExpandNetLabelsText | bool | get; set | |
| ExpandPortsName | bool | get; set | |
| ExpandSheetNumber | bool | get; set | |
| FSMMenuID | string | get; set | |
| GraphicsCursorStyle | TCursorShape | get; set | |
| HotSpotGridDistance | int | get; set | |
| IgnoreSelection | bool | get; set | |
| LastModelType | string | get; set | |
| LibMenuID | string | get; set | |
| LibraryScope | TLibraryScope | get; set | This property represents scope for filtering and selection to be applied to the current component on a library sheet or to all components of an open library in Altium Designer. |
| MaintainOrthogonal | bool | get; set | This property if set to true then when you drag components, any wiring that is dragged with the component is kept orthogonal (i.e. |
| ManualJunctionsColor | int | get; set | |
| MarkManualParameters | bool | get; set | The MarkManualParameters property denotes whether the dots will be displayed or not when parameters of components for example are auto positioned. |
| Metafile_Blankets | bool | get; set | |
| Metafile_NoERCMarkers | bool | get; set | |
| Metafile_Notes | bool | get; set | |
| Metafile_NotesCollapsed | bool | get; set | |
| Metafile_ParameterSets | bool | get; set | This property if set to true includes Parameter Sets design objects when copying to the clipboard or when printing a schematic document. |
| Metafile_Probes | bool | get; set | |
| Metafile_StrNoERCSymbolsToShow | string | get; set | |
| MultiPartNamingMethod | int | get; set | |
| MultipartSeparator | string | get | |
| MultiPartSeparator | string | set | |
| MultiSelectionColor | int | get; set | This property determines the color of the multi_selection, that is multiple objects on the schematic object is being selected. |
| OpenBusMenuID | string | get; set | |
| OptimizePolylines | bool | get; set | If this property is set to true, then extra wires, poly-lines or buses are prevented from overlapping on top of each other and the overlapping wires, poly-lines or busses are removed automatically. |
| OrcadFootPrint | TOrcadFootPrint | get; set | |
| PhysicalViewDimLevel | int | get; set | |
| PinNameMargin | int | get; set | Normally, component pin names are displayed inside the body of the component, adjacent to the corresponding pin. |
| PinNumberMargin | int | get; set | Normally, component pin numbers are displayed outside the body of the component, directly above the corresponding pin line. |
| PolylineCutterMode | TPolylineCutterMode | get; set | |
| ResizeColor | int | get; set | |
| RunInPlaceEditing | bool | get; set | This property if set to true, then the focused text field may be directly edited within the Schematic Editor, rather than in a dialog box. |
| SelectionColor | int | get; set | |
| SelectionReference | bool | get; set | |
| Sensitivity | int | get; set | |
| SheetStyle_MarginWidth | int | get | |
| SheetStyle_XSize | int | get | |
| SheetStyle_XZones | int | get | |
| SheetStyle_YSize | int | get | |
| SheetStyle_YZones | int | get | |
| ShowCutterBoxMode | TShowCutterBoxMode | get; set | |
| ShowCutterMarkersMode | TShowCutterMarkersMode | get; set | |
| ShowPinDirection | bool | get; set | |
| SingleSlashNegation | bool | get; set | |
| SnapToCenter | bool | get; set | This property represents the action where you hold the object being moved or dragged by its reference point (for objects that have one, such as library components or ports), or its center (for object… |
| SnapToHotSpot | bool | get; set | This property represents the action where you hold the object being moved or dragged by the nearest electrical hot spot (eg, the end of a pin) when moving or dragging. |
| SpatialAnalysisDuringDragging | bool | get; set | |
| StringIncA | string | get; set | This property represents a value to auto-increment on pin designators of a component when you are placing pins for a component. |
| StringIncB | string | get; set | This property represents a value to auto-increment on pin names of a component when you are placing pins for a component. |
| StringIncRemoveLeadingZero | bool | get; set | |
| SuperscriptDesignator | TSuperscriptMode | get; set | |
| SuperscriptDocumentNumber | TSuperscriptMode | get; set | |
| SuperscriptNetLabel | TSuperscriptMode | get; set | |
| SuperscriptPort | TSuperscriptMode | get; set | |
| SuperscriptSheetNumber | TSuperscriptMode | get; set | |
| TranslateRotateColor | int | get; set | This property sets or gets the color associated with translation or rotation. |
| UndoRedoStackSize | int | get; set | This property shows the number of actions held in the Undo Buffer. |
| UseOrcadPortWidth | bool | get; set | The UseOrcadPortWidth property determines whether the ports can be re-sized in the Schematic Editor. |
| ViolationColorByLevel | int | get; set | This ViolationColor property determines the color of the violation depending on the error level. |
| ViolationDisplayByLevel | bool | get; set | This ViolationDisplay property determines the error level for the violation display. |
| VisibleGridColor | int | get; set | This property determines the color of the visible grid on schematic sheets. |
| VisibleGridStyle | TVisibleGrid | get; set | This property determines the lined or dotted style of the visible grid on the schematic document. |
| WatermarkDeviceSheet | bool | get; set | |
| WatermarkReadOnlySheet | bool | get; set | |
| WireAutoJunctionsColor | int | get; set | This property determines the color of the auto generated junctions on the schematic document. |
| WireAutoJunctionsSize | TSize | get; set | |
| WireDragJunctionsColor | int | get; set |
AddTemplateToClipBoard
The AddTemplateToClipBoard property determines whether the current sheet template can be added to to the clipboard when you copy or cut from the current schematic sheet.
bool Get_AddTemplateToClipBoard();
void Set_AddTemplateToClipBoard(bool argValue);
Type: bool · Access: read/write
AllowDeviceSheetEditing
No description yet.
bool Get_AllowDeviceSheetEditing();
void Set_AllowDeviceSheetEditing(bool argValue);
Type: bool · Access: read/write
AlwaysDrag
This property represents the AlwaysDrag option and every time you are dragging a group of objects on a schematic document, the electrical wiring stay connected if it is true. Note, to keep the connections clean while dragging, press the spacebar to cycle through the different corner modes.
bool Get_AlwaysDrag();
void Set_AlwaysDrag(bool argValue);
Type: bool · Access: read/write
Set it to false and the wiring are left alone and become disconnected when previously connected objects are being dragged.
AutoBackupFileCount
No description yet.
int Get_AutoBackupFileCount();
void Set_AutoBackupFileCount(int argValue);
Type: int · Access: read/write
AutoBackupTime
No description yet.
int Get_AutoBackupTime();
void Set_AutoBackupTime(int argValue);
Type: int · Access: read/write
AutoPanJumpDistance
This property represents the value to set/get the size of each auto-panning step. The step size determines how fast the document pans when auto-panning is enabled. The smaller the value, the slower or finer the auto-panning movement.
int Get_AutoPanJumpDistance();
void Set_AutoPanJumpDistance(int argValue);
Type: int · Access: read/write
AutoPanShiftJumpDistance
This property represents a value to get/set the size of each step when the SHIFT key is held during auto-panning. The shift step size determines how fast the document pans when auto-panning is enabled and the SHIFT key is pressed. The smaller the value, the slower or finer the auto-panning movement.
int Get_AutoPanShiftJumpDistance();
void Set_AutoPanShiftJumpDistance(int argValue);
Type: int · Access: read/write
AutoPanStyle
No description yet.
TAutoPanStyle Get_AutoPanStyle();
void Set_AutoPanStyle(TAutoPanStyle argValue);
Type: TAutoPanStyle · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
AutoZoom
This property if set to true the schematic sheet is automatically zoomed when jumping to a component. Zoom level remains as it was if this option is not enabled.
bool Get_AutoZoom();
void Set_AutoZoom(bool argValue);
Type: bool · Access: read/write
BufferedPainting
No description yet.
bool Get_BufferedPainting();
void Set_BufferedPainting(bool argValue);
Type: bool · Access: read/write
BusAutoJunctionsColor
No description yet.
int Get_BusAutoJunctionsColor();
void Set_BusAutoJunctionsColor(int argValue);
Type: int · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
BusAutoJunctionsSize
No description yet.
TSize Get_BusAutoJunctionsSize();
void Set_BusAutoJunctionsSize(TSize argValue);
Type: TSize · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
BusDragJunctionsColor
No description yet.
int Get_BusDragJunctionsColor();
void Set_BusDragJunctionsColor(int argValue);
Type: int · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
ClickClearsSelection
If this property is set to true, then all design objects are de-selected by clicking any where on the schematic workspace. Set this property to false if you do not want to have this click anywhere to deselect all ability and the selection is cumulative.
bool Get_ClickClearsSelection();
void Set_ClickClearsSelection(bool argValue);
Type: bool · Access: read/write
Note: regardless of the setting, you can de-select a selected design object by clicking on it.
ComponentsCutWires
Set the property to true so you can drop a component onto a schematic wire and then the wire is cut into two segments and the segments are terminated onto any two hot pins of this component automatically. You will need to set the Optimize Wires & Buses option to true first.
bool Get_ComponentsCutWires();
void Set_ComponentsCutWires(bool argValue);
Type: bool · Access: read/write
ConfirmSelectionMemoryClear
The selection memories can be used to store the selection state of a set of objects. To prevent inadvertent overwriting of a selection memory, set the property to true.
bool Get_ConfirmSelectionMemoryClear();
void Set_ConfirmSelectionMemoryClear(bool argValue);
Type: bool · Access: read/write
ConvertSpecialStrings
This property when set to true, the contents of the special strings on screen are displayed, as they appear on a printout.
bool Get_ConvertSpecialStrings();
void Set_ConvertSpecialStrings(bool argValue);
Type: bool · Access: read/write
CrossRefLocationStyle
No description yet.
TCrossRefLocationStyle Get_CrossRefLocationStyle();
void Set_CrossRefLocationStyle(TCrossRefLocationStyle argValue);
Type: TCrossRefLocationStyle · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
CrossRefSheetStyle
No description yet.
TCrossRefSheetStyle Get_CrossRefSheetStyle();
void Set_CrossRefSheetStyle(TCrossRefSheetStyle argValue);
Type: TCrossRefSheetStyle · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
CtrlDbleClickGoesDown
This property when set to true, the sub-sheet of its associated sheet symbol by double clicking on this sheet symbol opens in Altium Designer.
bool Get_CtrlDbleClickGoesDown();
void Set_CtrlDbleClickGoesDown(bool argValue);
Type: bool · Access: read/write
Set it to false and when you double-click on a sheet symbol, the change properties dialog is displayed instead.
CutterFixedLength
No description yet.
int Get_CutterFixedLength();
void Set_CutterFixedLength(int argValue);
Type: int · Access: read/write
CutterGridSizeMultiple
No description yet.
int Get_CutterGridSizeMultiple();
void Set_CutterGridSizeMultiple(int argValue);
Type: int · Access: read/write
DefaultEarthName
The DefaultEarthName denotes the default signal ground name to be used for objects on the schematic document. The default name is EARTH.
string Get_DefaultEarthName();
void Set_DefaultEarthName(string argValue);
Type: string · Access: read/write
DefaultPowerGndName
The DefaultPowerGndName property denotes the default power ground name to be used for objects on the schematic document. The default name is GND.
string Get_DefaultPowerGndName();
void Set_DefaultPowerGndName(string argValue);
Type: string · Access: read/write
The Get_DefaultPowerGndName method retrieves the power ground name string.
DefaultPrimOverridesLibraryComment
No description yet.
bool Get_DefaultPrimOverridesLibraryComment();
void Set_DefaultPrimOverridesLibraryComment(bool argValue);
Type: bool · Access: read/write
DefaultPrimOverridesLibraryDesignator
No description yet.
bool Get_DefaultPrimOverridesLibraryDesignator();
void Set_DefaultPrimOverridesLibraryDesignator(bool argValue);
Type: bool · Access: read/write
DefaultPrimsPermanent
No description yet.
bool Get_DefaultPrimsPermanent();
void Set_DefaultPrimsPermanent(bool argValue);
Type: bool · Access: read/write
DefaultSheetStyle
The DefaultSheetStyle property denotes the sheet style used for the workspace.
TSheetStyle Get_DefaultSheetStyle();
void Set_DefaultSheetStyle(TSheetStyle argValue);
Type: TSheetStyle · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
There are various sheet styles; A4,A3,A2,A1,A0, A,C,D,E,Letter, Legal, Tabloid, Orcad A, Orcad B, Orcad C, Orcad D, Orcad E.
See also: TSheetStyle
DefaultSignalGndName
The DefaultSignalGndName denotes the default signal ground name to be used for objects on the schematic document. The default name is SGND.
string Get_DefaultSignalGndName();
void Set_DefaultSignalGndName(string argValue);
Type: string · Access: read/write
DefaultTemplateFileName
No description yet.
string Get_DefaultTemplateFileName();
void Set_DefaultTemplateFileName(string argValue);
Type: string · Access: read/write
DefaultUnit
No description yet.
TUnit Get_DefaultUnit();
void Set_DefaultUnit(TUnit argValue);
Type: TUnit · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
DefaultUnitSystem
No description yet.
TUnitSystem Get_DefaultUnitSystem();
Type: TUnitSystem · Access: read-only
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
DisplayPrinterFonts
The DisplayPrinterFonts property denotes whether the printer fonts can be displayed or not.
bool Get_DisplayPrinterFonts();
void Set_DisplayPrinterFonts(bool argValue);
Type: bool · Access: read/write
DocMenuID
The DocMenuID property determines which pop up menu to pop up depending on whether it is a schematic or a library document. The property returns a widestring format which can be either PUSCHMENU or PUSCHLIBMENU strings and they correspond to the entries in the Schematic Editor's resources file (ADVSCH.RCS file).
string Get_DocMenuID();
void Set_DocMenuID(string argValue);
Type: string · Access: read/write
DocumentScope
The DocumentScope property determines the scope for filtering and selection to be applied to the current document or to any open document in Altium Designer.
TChosenDocumentScope Get_DocumentScope();
void Set_DocumentScope(TChosenDocumentScope argValue);
Type: TChosenDocumentScope · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
See also: TChosenDocumentScope
DoubleClickRunsInspector
This property represents the option to bring up the Inspector dialog instead of the design object's properties dialog when you double click on a design object.
bool Get_DoubleClickRunsInspector();
void Set_DoubleClickRunsInspector(bool argValue);
Type: bool · Access: read/write
Assign false to this property to disable this option if you want to see the design object's properties dialog when you double click on a design object. Invoke this property to check if design object's properties dialog is invoked (false) or the Inspector dialog (true) when you double click on a design object.
DragJunctionsColor
No description yet.
int Get_DragJunctionsColor();
void Set_DragJunctionsColor(int argValue);
Type: int · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
DragJunctionsSize
No description yet.
TSize Get_DragJunctionsSize();
void Set_DragJunctionsSize(TSize argValue);
Type: TSize · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
DragStairSize
No description yet.
TSize Get_DragStairSize();
void Set_DragStairSize(TSize argValue);
Type: TSize · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
DragStepSize
No description yet.
TSize Get_DragStepSize();
void Set_DragStepSize(TSize argValue);
Type: TSize · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
ExpandComponentDesignators
No description yet.
bool Get_ExpandComponentDesignators();
void Set_ExpandComponentDesignators(bool argValue);
Type: bool · Access: read/write
ExpandDocumentNumber
No description yet.
bool Get_ExpandDocumentNumber();
void Set_ExpandDocumentNumber(bool argValue);
Type: bool · Access: read/write
ExpandNetLabelsText
No description yet.
bool Get_ExpandNetLabelsText();
void Set_ExpandNetLabelsText(bool argValue);
Type: bool · Access: read/write
ExpandPortsName
No description yet.
bool Get_ExpandPortsName();
void Set_ExpandPortsName(bool argValue);
Type: bool · Access: read/write
ExpandSheetNumber
No description yet.
bool Get_ExpandSheetNumber();
void Set_ExpandSheetNumber(bool argValue);
Type: bool · Access: read/write
FSMMenuID
No description yet.
string Get_FSMMenuID();
void Set_FSMMenuID(string argValue);
Type: string · Access: read/write
GraphicsCursorStyle
No description yet.
TCursorShape Get_GraphicsCursorStyle();
void Set_GraphicsCursorStyle(TCursorShape argValue);
Type: TCursorShape · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
HotSpotGridDistance
No description yet.
int Get_HotSpotGridDistance();
void Set_HotSpotGridDistance(int argValue);
Type: int · Access: read/write
IgnoreSelection
No description yet.
bool Get_IgnoreSelection();
void Set_IgnoreSelection(bool argValue);
Type: bool · Access: read/write
LastModelType
No description yet.
string Get_LastModelType();
void Set_LastModelType(string argValue);
Type: string · Access: read/write
LibMenuID
No description yet.
string Get_LibMenuID();
void Set_LibMenuID(string argValue);
Type: string · Access: read/write
LibraryScope
This property represents scope for filtering and selection to be applied to the current component on a library sheet or to all components of an open library in Altium Designer.
TLibraryScope Get_LibraryScope();
void Set_LibraryScope(TLibraryScope argValue);
Type: TLibraryScope · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
See also: TLibraryScope
MaintainOrthogonal
This property if set to true then when you drag components, any wiring that is dragged with the component is kept orthogonal (i.e. corners at 90 degrees). If this option is disabled, wiring dragged with a component will be repositioned obliquely.
bool Get_MaintainOrthogonal();
void Set_MaintainOrthogonal(bool argValue);
Type: bool · Access: read/write
ManualJunctionsColor
No description yet.
int Get_ManualJunctionsColor();
void Set_ManualJunctionsColor(int argValue);
Type: int · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
MarkManualParameters
The MarkManualParameters property denotes whether the dots will be displayed or not when parameters of components for example are auto positioned. If true, the dot for the parameter will appear when its associated component has been rotated/moved on the schematic document.
bool Get_MarkManualParameters();
void Set_MarkManualParameters(bool argValue);
Type: bool · Access: read/write
Metafile_Blankets
No description yet.
bool Get_Metafile_Blankets();
void Set_Metafile_Blankets(bool argValue);
Type: bool · Access: read/write
Metafile_NoERCMarkers
No description yet.
bool Get_Metafile_NoERCMarkers();
void Set_Metafile_NoERCMarkers(bool argValue);
Type: bool · Access: read/write
Metafile_Notes
No description yet.
bool Get_Metafile_Notes();
void Set_Metafile_Notes(bool argValue);
Type: bool · Access: read/write
Metafile_NotesCollapsed
No description yet.
bool Get_Metafile_NotesCollapsed();
void Set_Metafile_NotesCollapsed(bool argValue);
Type: bool · Access: read/write
Metafile_ParameterSets
This property if set to true includes Parameter Sets design objects when copying to the clipboard or when printing a schematic document.
bool Get_Metafile_ParameterSets();
void Set_Metafile_ParameterSets(bool argValue);
Type: bool · Access: read/write
Metafile_Probes
No description yet.
bool Get_Metafile_Probes();
void Set_Metafile_Probes(bool argValue);
Type: bool · Access: read/write
Metafile_StrNoERCSymbolsToShow
No description yet.
string Get_Metafile_StrNoERCSymbolsToShow();
void Set_Metafile_StrNoERCSymbolsToShow(string argValue);
Type: string · Access: read/write
MultiPartNamingMethod
No description yet.
int Get_MultiPartNamingMethod();
void Set_MultiPartNamingMethod(int argValue);
Type: int · Access: read/write
MultipartSeparator
No description yet.
string Get_MultipartSeparator();
Type: string · Access: read-only
MultiPartSeparator
No description yet.
void Set_MultiPartSeparator(string argValue);
Type: string · Access: write-only
MultiSelectionColor
This property determines the color of the multi_selection, that is multiple objects on the schematic object is being selected.
int Get_MultiSelectionColor();
void Set_MultiSelectionColor(int argValue);
Type: int · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
OpenBusMenuID
No description yet.
string Get_OpenBusMenuID();
void Set_OpenBusMenuID(string argValue);
Type: string · Access: read/write
OptimizePolylines
If this property is set to true, then extra wires, poly-lines or buses are prevented from overlapping on top of each other and the overlapping wires, poly-lines or busses are removed automatically.
bool Get_OptimizePolylines();
void Set_OptimizePolylines(bool argValue);
Type: bool · Access: read/write
Note: You need to enable this option to have the ability to automatically cut a wire and terminate onto any two pins of this component when this component is dropped onto this wire.
OrcadFootPrint
No description yet.
TOrcadFootPrint Get_OrcadFootPrint();
void Set_OrcadFootPrint(TOrcadFootPrint argValue);
Type: TOrcadFootPrint · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
PhysicalViewDimLevel
No description yet.
int Get_PhysicalViewDimLevel();
void Set_PhysicalViewDimLevel(int argValue);
Type: int · Access: read/write
PinNameMargin
Normally, component pin names are displayed inside the body of the component, adjacent to the corresponding pin. This property controls the placement of component pin names. It specifies the distance (in hundredths of an inch) from the component outline to the start of the pin name text. The default is 5.
int Get_PinNameMargin();
void Set_PinNameMargin(int argValue);
Type: int · Access: read/write
PinNumberMargin
Normally, component pin numbers are displayed outside the body of the component, directly above the corresponding pin line. This property controls the placement of the pin numbers. It specifies the distance (in hundredths of an inch) from the component outline to the start of the pin number text. The default is 8.
int Get_PinNumberMargin();
void Set_PinNumberMargin(int argValue);
Type: int · Access: read/write
PolylineCutterMode
No description yet.
TPolylineCutterMode Get_PolylineCutterMode();
void Set_PolylineCutterMode(TPolylineCutterMode argValue);
Type: TPolylineCutterMode · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
ResizeColor
No description yet.
int Get_ResizeColor();
void Set_ResizeColor(int argValue);
Type: int · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
RunInPlaceEditing
This property if set to true, then the focused text field may be directly edited within the Schematic Editor, rather than in a dialog box. After focusing the field you wish to modify, clicking upon it again or pressing the F2 shortcut key will open the field for editing.
bool Get_RunInPlaceEditing();
void Set_RunInPlaceEditing(bool argValue);
Type: bool · Access: read/write
If this property is set to false, you cannot edit the text directly and you have to edit it from the Parameter Properties dialog. You can just graphically move this text field.
SelectionColor
No description yet.
int Get_SelectionColor();
void Set_SelectionColor(int argValue);
Type: int · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
SelectionReference
No description yet.
bool Get_SelectionReference();
void Set_SelectionReference(bool argValue);
Type: bool · Access: read/write
Sensitivity
No description yet.
int Get_Sensitivity();
void Set_Sensitivity(int argValue);
Type: int · Access: read/write
SheetStyle_MarginWidth
No description yet.
int Get_SheetStyle_MarginWidth(TSheetStyle argS);
Type: int · Access: read-only · Index: argS (TSheetStyle)
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
SheetStyle_XSize
No description yet.
int Get_SheetStyle_XSize(TSheetStyle argS);
Type: int · Access: read-only · Index: argS (TSheetStyle)
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
SheetStyle_XZones
No description yet.
int Get_SheetStyle_XZones(TSheetStyle argS);
Type: int · Access: read-only · Index: argS (TSheetStyle)
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
SheetStyle_YSize
No description yet.
int Get_SheetStyle_YSize(TSheetStyle argS);
Type: int · Access: read-only · Index: argS (TSheetStyle)
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
SheetStyle_YZones
No description yet.
int Get_SheetStyle_YZones(TSheetStyle argS);
Type: int · Access: read-only · Index: argS (TSheetStyle)
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
ShowCutterBoxMode
No description yet.
TShowCutterBoxMode Get_ShowCutterBoxMode();
void Set_ShowCutterBoxMode(TShowCutterBoxMode argValue);
Type: TShowCutterBoxMode · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
ShowCutterMarkersMode
No description yet.
TShowCutterMarkersMode Get_ShowCutterMarkersMode();
void Set_ShowCutterMarkersMode(TShowCutterMarkersMode argValue);
Type: TShowCutterMarkersMode · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
ShowPinDirection
No description yet.
bool Get_ShowPinDirection();
void Set_ShowPinDirection(bool argValue);
Type: bool · Access: read/write
SingleSlashNegation
No description yet.
bool Get_SingleSlashNegation();
void Set_SingleSlashNegation(bool argValue);
Type: bool · Access: read/write
SnapToCenter
This property represents the action where you hold the object being moved or dragged by its reference point (for objects that have one, such as library components or ports), or its center (for objects which do not have a reference point such as a rectangle).
bool Get_SnapToCenter();
void Set_SnapToCenter(bool argValue);
Type: bool · Access: read/write
SnapToHotSpot
This property represents the action where you hold the object being moved or dragged by the nearest electrical hot spot (eg, the end of a pin) when moving or dragging.
bool Get_SnapToHotSpot();
void Set_SnapToHotSpot(bool argValue);
Type: bool · Access: read/write
SpatialAnalysisDuringDragging
No description yet.
bool Get_SpatialAnalysisDuringDragging();
void Set_SpatialAnalysisDuringDragging(bool argValue);
Type: bool · Access: read/write
StringIncA
This property represents a value to auto-increment on pin designators of a component when you are placing pins for a component. This is used for building components in the Library editor. Normally you would use a positive increment value for pin designators and negative increment value for pin names. Eg 1, 2,3 for pin designators and D8, D7, D6 for pin names. Thus Primary = 1 and Secondary = -1 and set Display Name to D8 and Designator to 1 in the Pin Properties dialog before you place the first pin.
string Get_StringIncA();
void Set_StringIncA(string argValue);
Type: string · Access: read/write
StringIncB
This property represents a value to auto-increment on pin names of a component when you are placing pins for a component. This can be used for building components in the Library editor.
string Get_StringIncB();
void Set_StringIncB(string argValue);
Type: string · Access: read/write
Normally you would use a positive increment value for pin designators and negative increment value for pin names. Eg 1, 2,3 for pin designators and D8, D7, D6 for pin names. Thus Primary = 1 and Secondary = -1 and set Display Name to D8 and Designator to 1 in the Pin Properties dialog before you place the first pin.
StringIncRemoveLeadingZero
No description yet.
bool Get_StringIncRemoveLeadingZero();
void Set_StringIncRemoveLeadingZero(bool argValue);
Type: bool · Access: read/write
SuperscriptDesignator
No description yet.
TSuperscriptMode Get_SuperscriptDesignator();
void Set_SuperscriptDesignator(TSuperscriptMode argValue);
Type: TSuperscriptMode · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
SuperscriptDocumentNumber
No description yet.
TSuperscriptMode Get_SuperscriptDocumentNumber();
void Set_SuperscriptDocumentNumber(TSuperscriptMode argValue);
Type: TSuperscriptMode · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
SuperscriptNetLabel
No description yet.
TSuperscriptMode Get_SuperscriptNetLabel();
void Set_SuperscriptNetLabel(TSuperscriptMode argValue);
Type: TSuperscriptMode · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
SuperscriptPort
No description yet.
TSuperscriptMode Get_SuperscriptPort();
void Set_SuperscriptPort(TSuperscriptMode argValue);
Type: TSuperscriptMode · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
SuperscriptSheetNumber
No description yet.
TSuperscriptMode Get_SuperscriptSheetNumber();
void Set_SuperscriptSheetNumber(TSuperscriptMode argValue);
Type: TSuperscriptMode · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
TranslateRotateColor
This property sets or gets the color associated with translation or rotation.
int Get_TranslateRotateColor();
void Set_TranslateRotateColor(int argValue);
Type: int · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
UndoRedoStackSize
This property shows the number of actions held in the Undo Buffer. The default value is 50. Define a value to set the Undo Buffer size. There is no limit to the size of the Undo Buffer, however, the larger the size, the more main memory is used to store undo information.
int Get_UndoRedoStackSize();
void Set_UndoRedoStackSize(int argValue);
Type: int · Access: read/write
UseOrcadPortWidth
The UseOrcadPortWidth property determines whether the ports can be re-sized in the Schematic Editor. This is important if the design has to go back to Orcad(TM) (which does not support re-sizing ports).
bool Get_UseOrcadPortWidth();
void Set_UseOrcadPortWidth(bool argValue);
Type: bool · Access: read/write
ViolationColorByLevel
This ViolationColor property determines the color of the violation depending on the error level.
int Get_ViolationColorByLevel(TErrorLevel argLevel);
void Set_ViolationColorByLevel(TErrorLevel argLevel, int argValue);
Type: int · Access: read/write · Index: argLevel (TErrorLevel)
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
ViolationDisplayByLevel
This ViolationDisplay property determines the error level for the violation display.
bool Get_ViolationDisplayByLevel(TErrorLevel argLevel);
void Set_ViolationDisplayByLevel(TErrorLevel argLevel, bool argValue);
Type: bool · Access: read/write · Index: argLevel (TErrorLevel)
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
VisibleGridColor
This property determines the color of the visible grid on schematic sheets.
int Get_VisibleGridColor();
void Set_VisibleGridColor(int argValue);
Type: int · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
VisibleGridStyle
This property determines the lined or dotted style of the visible grid on the schematic document.
TVisibleGrid Get_VisibleGridStyle();
void Set_VisibleGridStyle(TVisibleGrid argValue);
Type: TVisibleGrid · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
See also: TVisibleGrid
WatermarkDeviceSheet
No description yet.
bool Get_WatermarkDeviceSheet();
void Set_WatermarkDeviceSheet(bool argValue);
Type: bool · Access: read/write
WatermarkReadOnlySheet
No description yet.
bool Get_WatermarkReadOnlySheet();
void Set_WatermarkReadOnlySheet(bool argValue);
Type: bool · Access: read/write
WireAutoJunctionsColor
This property determines the color of the auto generated junctions on the schematic document.
int Get_WireAutoJunctionsColor();
void Set_WireAutoJunctionsColor(int argValue);
Type: int · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
WireAutoJunctionsSize
No description yet.
TSize Get_WireAutoJunctionsSize();
void Set_WireAutoJunctionsSize(TSize argValue);
Type: TSize · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
WireDragJunctionsColor
No description yet.
int Get_WireDragJunctionsColor();
void Set_WireDragJunctionsColor(int argValue);
Type: int · Access: read/write
The accessors are extension methods of ISch_PreferencesHelper (using SCH;).
Methods
| Method | Returns | Description |
|---|---|---|
| GridPresetAt | IGridSetting | |
| GridPresetsCount | int | |
| Import_FromUser | bool |
GridPresetAt
No description yet.
IGridSetting GridPresetAt(TUnitSystem argUnit, int argnIndex);
| Parameter | Type | Passing |
|---|---|---|
argUnit | TUnitSystem | value |
argnIndex | int | value |
Returns: IGridSetting
Extension method of ISch_PreferencesHelper (using SCH;).
GridPresetsCount
No description yet.
int GridPresetsCount(TUnitSystem argUnit);
int GridPresetsCount(int argUnit);
| Parameter | Type | Passing |
|---|---|---|
argUnit | TUnitSystem | value |
Returns: int
The first overload is an extension method of ISch_PreferencesHelper (using SCH;) with typed parameters; the second is declared by the interface.
Import_FromUser
No description yet.
bool Import_FromUser();
Returns: bool