Extended modules > 3D Documenation > Create 3D documentation > Indexes
  
Indexes
You can customize the following areas of 3D Documentation relating to indexes:
The DEFAULT-NUMBER-BEHAVIOUR function
The DEFAULT-INDEX-SETTINGS Function
The DEFAULT-UPDATE-INDEX-SETTINGS Function
The DEFAULT-NUMBER-BEHAVIOUR function
The DEFAULT-NUMBER-BEHAVIOUR function allows you to define the default settings in the dialog in which indexes are reorganized. The switches Remove and Renumber can be set to be switched on or off by default when the dialog is opened, or they can be disabled entirely.
Syntax
(DOC3D::DEFAULT-NUMBER-BEHAVIOUR
:REMOVE :ON or :OFF or :DISABLE
:RENUMBER :ON or :OFF or :DISABLE)
Options
:REMOVE specifies whether the switch to remove all indexes of annotations belonging to a specified part or assembly is on or off by default, or disabled.
:RENUMBER specifies whether the switch that applies new numbering to all indexes of annotations belonging to a specified part or assembly is on or off by default, or disabled.
Example
(doc3d::default-number-behaviour
:REMOVE :ON
:RENUMBER :OFF)
The DEFAULT-INDEX-SETTINGS Function
The DEFAULT-INDEX-SETTINGS function sets the default behavior and parameters for newly-created index entries. These settings are available in the user interface, but this function allows you to set the defaults from start-up of 3D Documentation.
Syntax
(DOC3D:DEFAULT-INDEX-SETTINGS
:CREATE_AUT_IND :ON or :OFF
:INDEX-FRAME-TYPE :OFF or :BOX or :BALLOON
:INDEX-SIZE value
:INDEX-COLOR R,G,B values
:INDEX-POSITION a value between 1 and 16)
Options
:CREATE_AUT_IND specifies whether indexes should be created automatically with new annotations.
:INDEX-FRAME-TYPE specifies what type of frame should be drawn around the index, or none at all.
:INDEX-SIZE specifies the size of the index number.
:INDEX-COLOR specifies the color of the index number and frame, expressed as three comma-separated RGB values.
:INDEX-POSITION specifies the position of the index relative to the annotation label. Position 1 is top left and the other numbers go round the label clockwise. See the graphic for an illustration:
Example
(doc3d:default-index-settings
:CREATE_AUT_IND :ON
:INDEX-FRAME-TYPE :BALLOON
:INDEX-SIZE 1.5
:INDEX-COLOR 0,1,0
:INDEX-POSITION 4)
The DEFAULT-UPDATE-INDEX-SETTINGS Function
The DEFAULT-UPDATE-INDEX-SETTINGS function sets the behavior for when index numbers are updated. You can set whether certain modifications to the annotation should trigger a change (increment) of index number.
Syntax
(DOC3D:DEFAULT-UPDATE-INDEX-SETTINGS
:DEFAULT-START-INDEX value
:UPDATE-NOM-VAL-CHANGE t or nil
:UPDATE-PRE-POST-CHANGE t or nil
:UPDATE-TOL-CHANGE t or nil)
Options
:DEFAULT-START-INDEX specifies the default start index number, that is, the lowest index value.
:UPDATE-NOM-VAL-CHANGE specifies whether or not a changed dimension value, resulting from a modeling change or from editing the value, should trigger a change of index number.
:UPDATE-PRE-POST-CHANGE specifies whether or not a change of prefix or postfix should trigger a change of index number.
:UPDATE-TOL-CHANGE specifies whether or not a change of the tolerance value should trigger a change of index number.
Example
(doc3d:default-index-update-settings
:DEFAULT-START-INDEX 1
:UPDATE-NOM-VAL-CHANGE t
:UPDATE-PRE-POST-CHANGE nil
:UPDATE-TOL-CHANGE t)