References Key-in Format

Many of the references key-ins take a “file-spec,” which can be the file name or the logical name of the reference. The “file-spec” format can be a series of file names separated by the “->” delimiter, where the series of file names represent the path to a nested reference. For example, “ref1.dgn->ref2.dgn->ref3.dgn->ref4.dgn” represents the path to a nested reference (ref4.dgn). Additionally, you may use “all” or “*” to signify all attached references.

Example 1: To turn off “level 1” in the reference ref1.dgn.

reference levels off “level 1” ref1.dgn;selview 1

Example 2: To turn off “level 1” in the nested reference ref2.dgn.

reference levels off “level 1” ref1.dgn->ref2.dgn;selview 1

Following key-ins can use the delimiters to represent the path to nested file names:

  • REFERENCE ACTIVATE <file-spec>
  • REFERENCE EXCHANGE <reference_file_name>
  • REFERENCE DISPLAY ON|OFF|TOGGLE <file_spec>
  • REFERENCE SNAP ON|OFF|TOGGLE <file_spec>
  • REFERENCE LOCATE ON|OFF|TOGGLE <file_spec>
  • REFERENCE LEVELS ON|OFF|TOGGLE <file_spec>
  • REFERENCE PROPERTIES <file_spec>
References key-in Description
REFERENCE ACTIVATE <file-spec> Activates the selected reference for in-place editing. A black dot indicates it is activated.
REFERENCE DEACTIVATE <file-spec> Deactivates the selected reference so that you can return to editing the active model. A gray check mark indicates it is deactivated.
REFERENCE EXCHANGE <reference_file_name>

XD=<reference_file_name>

Opens the defined reference, retaining the same view configuration.

If no filename is given with the key-in, and no reference is selected in the References dialog, you are prompted to select a reference (graphically).

REFERENCE ATTACH (or RF=)[configuration_variable:]<file_name>[,model_name][,logical_name][,description][,view_name][,scale][,nesting][,on|off] Attach Reference to the active model.
REFERENCE CLIP BOUNDARY <file-spec> Set Reference Clip Boundary.
REFERENCE CLIP MASK <file-spec> Set Reference Clip Mask.
REFERENCE CLIP DELETE <file-spec> Delete Reference Clip.
REFERENCE CLIP BACK <file-spec> Set Reference Back Clip Plane for a 3D reference.
REFERENCE CLIP FRONT <file-spec> Set Reference Front Clip Plane for a 3D reference.
REFERENCE RELOAD <file-spec> ../122994/GUID-FB6FB091-1803-B826-C07C-C25A34ED185B.html that have changed since last loaded.
REFERENCE RELOAD FORCE <file-spec> Forces a References, Raster Images, Point Clouds, and Reality Mesh.
REFERENCE MOVE <file-spec> Move Reference.
REFERENCE COPY <file-spec> Makes a Copy References.
REFERENCE SCALE ABSOLUTE|FACTOR|POINTS <file-spec> Scale References.
REFERENCE ROTATE <file-spec> Rotate Reference.
REFERENCE MIRROR HORIZONTAL|VERTICAL <file-spec> Mirror Reference about a horizontal or vertical line.
REFERENCE COPY FOLDED HORIZONTAL|LINE|VERTICAL <file-spec> Copy Reference By Folding, folded about an orthogonal axis, or about a defined line.
REFERENCE PRESENTATION <file-spec> Set Reference Presentation of a reference.
REFERENCE DETACH <file-spec> Detach Reference.
REFERENCE DISPLAY ON|OFF|TOGGLE <file_spec> The display of the defined references is turned on, off, or their on/off state is switched.
REFERENCE SNAP ON|OFF|TOGGLE <file_spec> The ability to snap to the defined references is turned on, off, or their on/off state is switched.
REFERENCE LOCATE ON|OFF|TOGGLE <file_spec> The ability to select elements in the defined references is turned on, off, or their on/off state is switched.
REFERENCE LEVELS ON|OFF|TOGGLE <file_spec> For the defined references, all levels are turned on, off, or their on/off state is switched.
REFERENCE PROPERTIES <file_spec> For the defined reference, opens the Attachment Properties dialog.
References key-in Description
REFERENCE ACTIVATE <file-spec> Activates the selected reference for in-place editing. A black dot indicates it is activated.
REFERENCE DEACTIVATE <file-spec> Deactivates the selected reference so that you can return to editing the active model. A gray check mark indicates it is deactivated.
REFERENCE ATTACH (or RF=)[configuration_variable:]<file_name>[,model_name][,logical_name][,description][,view_name][,scale][,nesting][,on|off] Attach Reference to the active model.
REFERENCE CLIP BOUNDARY <file-spec> Set Reference Clip Boundary.
REFERENCE CLIP MASK <file-spec> Set Reference Clip Mask.
REFERENCE CLIP DELETE <file-spec> Delete Reference Clip.
REFERENCE CLIP BACK <file-spec> Set Reference Back Clip Plane for a 3D reference.
REFERENCE CLIP FRONT <file-spec> Set Reference Front Clip Plane for a 3D reference.
REFERENCE RELOAD FORCE <file-spec> Forces a Reload Reference.
REFERENCE MOVE <file-spec> Move Reference.
REFERENCE COPY <file-spec> Makes a Copy References.
REFERENCE SCALE ABSOLUTE|FACTOR|POINTS <file-spec> Scale References.
REFERENCE ROTATE <file-spec> Rotate Reference.
REFERENCE MIRROR HORIZONTAL|VERTICAL <file-spec> Mirror Reference about a horizontal or vertical line.
REFERENCE PRESENTATION <file-spec> Set Reference Presentation of a reference.
REFERENCE DETACH <file-spec> Detach Reference.
REFERENCE DETACH ALL Detaches all references.
REFERENCE SET SYNCHWITHSAVEDVIEW=<setting_spec> <file_spec> If the reference source is a saved view, turns on/off the synchronized with saved view check box.
References key-in Description
REFERENCE ACTIVATE <file-spec> Activates the selected reference for in-place editing. A black dot indicates it is activated.
REFERENCE DEACTIVATE <file-spec> Deactivates the selected reference so that you can return to editing the active model. A gray check mark indicates it is deactivated.
REFERENCE ATTACH (or RF=)[configuration_variable:]<file_name>[,model_name][,logical_name][,description][,view_name][,scale][,nesting][,on|off] Attach Reference to the active model.
REFERENCE CLIP BACK <file-spec> Set Reference Back Clip Plane for a 3D reference.
REFERENCE CLIP BOUNDARY <file-spec> Set Reference Clip Boundary.
REFERENCE CLIP DELETE <file-spec> Delete Reference Clip.
REFERENCE CLIP FRONT <file-spec> Set Reference Front Clip Plane for a 3D reference.
REFERENCE CLIP MASK <file-spec> Set Reference Clip Mask.
REFERENCE COPY <file-spec> Makes a Copy References.
REFERENCE RELOAD <file-spec> ../122994/GUID-FB6FB091-1803-B826-C07C-C25A34ED185B.html that have changed since last loaded.
REFERENCE RELOAD FORCE <file-spec> Forces a References, Raster Images, Point Clouds, and Reality Mesh.
REFERENCE MOVE <file-spec> Move Reference.
REFERENCE SCALE ABSOLUTE|FACTOR|POINTS <file-spec> Scale References.
REFERENCE ROTATE <file-spec> Rotate Reference.
REFERENCE MIRROR HORIZONTAL|VERTICAL <file-spec> Mirror Reference about a horizontal or vertical line.
REFERENCE PRESENTATION <file-spec> Set Reference Presentation of a reference.
REFERENCE DETACH <file-spec> Detach Reference.
REFERENCE PROPERTIES <file_spec> Opens the Attachment Properties dialog.
REFERENCE GROUP ADD|DROP <file_spec> Adds or drops the selected references to/from a group.