www.kxcad.net Home > Electronic Index > Altium(Protel) Index
Description
The DocumentPreferences process is used to define various PCB and library document settings, such as active layers, display options and other options.
Parameters
ChangeFromLegacyToDXPPlaneMode (True, False )
Change from legacy mode to DXP plane mode when importing from legacy designs and updating them.
Tab (LayerStack, DrillPairs, Mechanical, Layers, Sheet, Options,Grid)
When Tab is set to one of the four values, the appropriate dialog is displayed, for example, Tab = LayerStack, the Layer Stack manager dialog is invoked and displayed. Tab = Options, Library Options dialog appears. Defaults to empty which means that a Board Options dialog appears.
Current, Top, Bottom, Topoverlay, Multilayer, Bottomoverlay, Connect, Bottompaste,Bottomsolder,Drilldrawing,Drillguide,Keepout,Mechanical1..16,Mid1..30,Bottompaste,Bottomsolder,Drilldrawing,Drillguide,Plane1..16,Toppaste,Topsolder,Drcerrors,Selections,Visiblegrid1x,Visiblegrid10x,Padholes,Viaholes (True, False, Toggle )
One of the three states sets the display status of the specified layer. If true, the specified layer is displayed, if false, the layer is not displayed. If Toggle, the display status of the layer is toggled.
SnapGrid (Real)
Denotes the snap grid. X and Y sizes are the same. The snap grid is used to define the alignment grid for manual movement and placement.
SnapGridX Real
Denotes the snap grid X size (horizontal value set),
SnapGridY Real
Denotes the snap grid Y size (vertical value set).
ComponentGrid (Real)
The ComponentGridSize is set in mils. (note that X and Y values are set the same).
ComponentGridX (Real)
Denotes the component grid X size.
ComponentGridY (Real)
Denotes the component grid Y size.
RoutingTrackGrid (Real)
Denotes the track grid size.
RoutingViaGrid (Real)
Denotes the track grid size.
VisibleGrid1 (Real)
Denotes the size of the first visible grid size in mils.
VisibleGrid2 (Real)
Denotes the size of the second visible grid size in mils.
ElectricalGridRange (Real)
Denotes the electrical grid size.
ElectricalGridEnabled (True, False, Toggle)
Denotes whether the electrical grid is enabled or not.
MeasurementUnit (Imperial, Metric, Toggle)
This denotes the default measurement units for the current PCB document. Defaults to imperial units. The default units are used to display any distance related information on screen or in reports. They are also used if units are not specified when editing a distance value in an object dialog field. The Toggle value changes from one unit to the other.
VisibleGridKind (Dots,Lines, Toggle)
Denotes the visible grid type on the PCB document.
ShowSheet True, False, Toggle
Denotes whether to display the sheet behind the PCB document.
MaskLevel Increase, Decrease
When the INCREASE parameter is applied, the MaskLevel is increased by one unit and when DECREASE parameter is applied, the MaskLevel is decreased by one unit.
Example
Process: PCB:DocumentPreferences
Parameters : ShowSheet = Toggle
See also
SetupPreferences process