Indexes  Previous Next

N4DNavigatorSettingAtt (Object)

Interface to handle the settings of the DMU Navigator workbench.


The different settings are:

DMUClashPreview:
Display of the preview viewer when editing an interference.

DMUDistancePreview:
Display of the preview viewer when editing a distance.

DMUGroupPreview:
Display of the preview viewer when editing a group.

DMUSectionPreview:
Display of the preview viewer when editing a section.

DMUShuttlePreview:
Display of the preview viewer when editing a shuttle.

DMUThicknessPreview:
Display of the preview viewer for the thickness command.

DMUOffsetPreview:
Display of the preview viewer for the offset command.

DMUSweptVolPreview:
Display of the preview viewer for the swept volume command.

DMUSilhouettePreview:
Display of the preview viewer for the silhouette command.

DMUWrappingPreview:
Display of the preview viewer for the wrapping command.

DMUFreeSpacePreview:
Display of the preview viewer for the free space command.

DMUSimplifPreview:
Display of the preview viewer for the simplification command.

DMUVibrationVolPreview:
Display of the preview viewer for the vibration volume command.

DMUCut3DPreview:
Display of the preview viewer for the 3D cut command.

DMUMergerPreview:
Display of the preview viewer for the merger command.

NumUrlName:
Display of the hyperlink name.

MarkerAutoUpdate:
Update on product structure modifications and scenes activation.

MarkerDefaultsColor:
Default color of an annotation.

SceneDefaultsColor:
Default background color for scene environment.

MarkerTextColor:
Default color of a text annotation.

MarkerDefaultsWeight:
Default weight value of an annotation.

MarkerDefaultsDashed:
Default dashed value of an annotation.

MarkerDefaultsSize:
Default size value of an annotation.

MarkerDefaultsFont:
Default font of an annotation.

MarkerTextDashed:
Default dashed value of a text annotation.

MarkerTextWeight:
Default weight value of a text annotation.

PublishAutoLaunchBrowser:
Automatic launching of publish results in a browser.

Marker2DAutoNaming:
Automatically use a Part's name as the default for the creation of text annotations.

Marker3DAutoNaming:
Activation of the mechanism that enables to transform temporary markers into persistent 3D annotations.

DMUReviewName:
The desired default name for DMU Reviews

ForceVoxel:
Force users of the Spatial Query command to use the defined Released Accuracy.

ClearanceVoxel:
Definition of the Clearance value.

ForceClearanceVoxel:
Force users of the Spatial Query command to use the defined Clearance value.

InsertMode:
Mode for the Import applicative data command.

DMUGroupPreviewHiddenObjectsDisplayMode:
Display mode for hidden objects of a DMU Group in its preview: visualized as in main 3D viewer or visualized with customized graphic properties

DMUGroupPreviewHiddenObjectsColor:
Color for hidden objects in DMU Group Preview.

DMUGroupPreviewHiddenObjectsOpacity:
Opacity for hidden objects in DMU Group Preview.

DMUGroupPreviewHiddenObjectsLowIntMode:
Hidden objects are low intensified or not in DMU Group Preview.

DMUGroupPreviewHiddenObjectsPickMode:
Hidden objects can be picked or not in DMU Group Preview.

Property Index

ClearanceVoxel
Returns or sets the clearance value (oValue the clearance value in mm).
DMUClashPreview
Returns or sets the preview activation state for Interference (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUCut3DPreview
Returns or sets the preview activation state for 3D Cut (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUDistancePreview
Returns or sets the preview activation state for Distance (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUFreeSpacePreview
Returns or sets the preview activation state for Free Space (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUGroupPreviewHiddenObjectsDisplayMode
Returns or sets the mode for the display of hidden objects in DMU Group Preview.
DMUGroupPreviewHiddenObjectsLowInt
Returns or sets the Low Intensity mode for the display of hidden objects in DMU Group Preview.
DMUGroupPreviewHiddenObjectsOpacity
Returns or sets the opacity for the display of hidden objects in DMU Group Preview.
DMUGroupPreviewHiddenObjectsPick
Returns or sets the pick mode for the display of hidden objects in DMU Group Preview.
DMUGroupPreview
Returns or sets the preview activation state for Group (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUMergerPreview
Returns or sets the preview activation state for Merger (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUOffsetPreview
Returns or sets the preview activation state for Offset (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUReviewName
Returns or sets the default name for the DMU Reviews (oValue, the DMU Review name).
DMUSectionPreview
Returns or sets the preview activation state for Section (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUShuttlePreview
Returns or sets the preview activation state for Shuttle (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUSilhouettePreview
Returns or sets the preview activation state for Silhouette (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUSimplifPreview
Returns or sets the preview activation state for Simplification (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUSweptVolPreview
Returns or sets the preview activation state for Swept Volume (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUThicknessPreview
Returns or sets the preview activation state for Thickness (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUVibrationVolPreview
Returns or sets the preview activation state for Vibration volume (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
DMUWrappingPreview
Returns or sets the preview activation state for Wrapping (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
ForceClearanceVoxel
Returns or sets the activation state for the use of the clearance value (TRUE the clearance value is used, FALSE the clearance value is not used);
ForceVoxel
Returns or sets the activation state for the use of the Released accuracy value (TRUE the released accuracy value is used, FALSE the released accuracy value is not used);
InsertLevel
Returns or sets the level for the Import Applicative Data command (True : at highest review level, False : in current review).
InsertMode
Returns or sets the mode for the Import Applicative Data command (CatSacSettingsEnumNoInsert no import of applicative data, CatSacSettingsEnumAutomatic the import of applicative is automatic, CatSacSettingsEnumUserPrompt the user can select the applicative data to import).
Marker2DAutoNaming
Marker3DAutoNaming
MarkerAutoUpdate
Returns or sets the activation of the automatic update on product structure modification (TRUE update is done automatically, FALSE update is done manually).
MarkerDefaultsDashed
MarkerDefaultsFont
MarkerDefaultsSize
MarkerDefaultsWeight
MarkerTextDashed
MarkerTextWeight
NumUrlName
Returns or sets the name activation state for Hyperlink (TRUE the hyperlink name is displayed, FALSE the hyperlink name is not displayed).
PublishAutoLaunchBrowser
Returns or sets the activation state of the automatic launching of the publish browser (TRUE the publish browser is automatically opened, FALSE the publish browser is not automatically opened).

Method Index

GetClearanceVoxelInfo
Retrieves environment informations for the ClearanceVoxel parameter.
GetDMUClashPreviewInfo
Retrieves environment informations for the DMUClashPreview parameter.
GetDMUCut3DPreviewInfo
Retrieves environment informations for the DMUCut3DPreview parameter.
GetDMUDistancePreviewInfo
Retrieves environment informations for the DMUDistancePreview parameter.
GetDMUFreeSpacePreviewInfo
Retrieves environment informations for the DMUFreeSpacePreview parameter.
GetDMUGroupPreviewHiddenObjectsColorInfo
Retrieves environment informations for the DMUGroupPreviewHiddenObjectsColor parameter.
GetDMUGroupPreviewHiddenObjectsColor
Returns the color for the display of hidden objects in DMU Group Preview.
GetDMUGroupPreviewHiddenObjectsDisplayModeInfo
Retrieves environment informations for the DMUGroupPreviewHiddenObjectsDisplayMode parameter.
GetDMUGroupPreviewHiddenObjectsLowIntInfo
Retrieves environment informations for the DMUGroupPreviewHiddenObjectsLowInt parameter.
GetDMUGroupPreviewHiddenObjectsOpacityInfo
Retrieves environment informations for the DMUGroupPreviewHiddenObjectsOpacity parameter.
GetDMUGroupPreviewHiddenObjectsPickInfo
Retrieves environment informations for the DMUGroupPreviewHiddenObjectsPick parameter.
GetDMUGroupPreviewInfo
Retrieves environment informations for the DMUGroupPreview parameter.
GetDMUMergerPreviewInfo
Retrieves environment informations for the DMUMergerPreview parameter.
GetDMUOffsetPreviewInfo
Retrieves environment informations for the DMUOffsetPreview parameter.
GetDMUReviewNameInfo
Retrieves environment informations for the DMUReviewName parameter.
GetDMUSectionPreviewInfo
Retrieves environment informations for the DMUSectionPreview parameter.
GetDMUShuttlePreviewInfo
Retrieves environment informations for the DMUShuttlePreview parameter.
GetDMUSilhouettePreviewInfo
Retrieves environment informations for the DMUSilhouettePreview parameter.
GetDMUSimplifPreviewInfo
Retrieves environment informations for the DMUSimplifPreview parameter.
GetDMUSweptVolPreviewInfo
Retrieves environment informations for the DMUSweptVolPreview parameter.
GetDMUThicknessPreviewInfo
Retrieves environment informations for the DMUThicknessPreview parameter.
GetDMUVibrationVolPreviewInfo
Retrieves environment informations for the DMUVibrationVolPreview parameter.
GetDMUWrappingPreviewInfo
Retrieves environment informations for the DMUWrappingPreview parameter.
GetForceClearanceVoxelInfo
Retrieves environment informations for the ForceClearanceVoxel parameter.
GetForceVoxelInfo
Retrieves environment informations for the ForceVoxel parameter.
GetInsertLevelInfo
Retrieves environment informations for the InsertLevel parameter.
GetInsertModeInfo
Retrieves environment informations for the InsertMode parameter.
GetMarker2DAutoNamingInfo
GetMarker3DAutoNamingInfo
GetMarkerAutoUpdateInfo
Retrieves environment informations for the MarkerAutoUpdate parameter.
GetMarkerDefaultsColorInfo
GetMarkerDefaultsColor
GetMarkerDefaultsDashedInfo
GetMarkerDefaultsFontInfo
GetMarkerDefaultsSizeInfo
GetMarkerDefaultsWeightInfo
GetMarkerTextColorInfo
GetMarkerTextColor
GetMarkerTextDashedInfo
GetMarkerTextWeightInfo
GetNumUrlNameInfo
Retrieves environment informations for the NumUrlName parameter.
GetPublishAutoLaunchBrowserInfo
Retrieves environment informations for the PublishAutoLaunchBrowser parameter.
GetSceneDefaultsColorInfo
Retrieves environment informations for the SceneDefaultsColor parameter.
GetSceneDefaultsColor
Returns the scene background color (oRed, oGreen, oBlue: RGB values of the color).
SetClearanceVoxelLock
Locks or unlocks the ClearanceVoxel parameter.
SetDMUClashPreviewLock
Locks or unlocks the DMUClashPreview parameter.
SetDMUCut3DPreviewLock
Locks or unlocks the DMUCut3DPreview parameter.
SetDMUDistancePreviewLock
Locks or unlocks the DMUDistancePreview parameter.
SetDMUFreeSpacePreviewLock
Locks or unlocks the DMUFreeSpacePreview parameter.
SetDMUGroupPreviewHiddenObjectsColorLock
Locks or unlocks the DMUGroupPreviewHiddenObjectsColor parameter.
SetDMUGroupPreviewHiddenObjectsColor
Sets the color for the display of hidden objects in DMU Group Preview.
SetDMUGroupPreviewHiddenObjectsDisplayModeLock
Locks or unlocks the DMUGroupPreviewHiddenObjectsDisplayMode parameter.
SetDMUGroupPreviewHiddenObjectsLowIntLock
Locks or unlocks the DMUGroupPreviewHiddenObjectsLowInt parameter.
SetDMUGroupPreviewHiddenObjectsOpacityLock
Locks or unlocks the DMUGroupPreviewHiddenObjectsOpacity parameter.
SetDMUGroupPreviewHiddenObjectsPickLock
Locks or unlocks the DMUGroupPreviewHiddenObjectsPick parameter.
SetDMUGroupPreviewLock
Locks or unlocks the DMUGroupPreview parameter.
SetDMUMergerPreviewLock
Locks or unlocks the DMUMergerPreview parameter.
SetDMUOffsetPreviewLock
Locks or unlocks the DMUOffsetPreview parameter.
SetDMUReviewNameLock
Locks or unlocks the DMUReviewName parameter.
SetDMUSectionPreviewLock
Locks or unlocks the DMUSectionPreview parameter.
SetDMUShuttlePreviewLock
Locks or unlocks the DMUShuttlePreview parameter.
SetDMUSilhouettePreviewLock
Locks or unlocks the DMUSilhouettePreview parameter.
SetDMUSimplifPreviewLock
Locks or unlocks the DMUSimplifPreview parameter.
SetDMUSweptVolPreviewLock
Locks or unlocks the DMUSweptVolPreview parameter.
SetDMUThicknessPreviewLock
Locks or unlocks the DMUThicknessPreview parameter.
SetDMUVibrationVolPreviewLock
Locks or unlocks the DMUVibrationVolPreview parameter.
SetDMUWrappingPreviewLock
Locks or unlocks the DMUWrappingPreview parameter.
SetForceClearanceVoxelLock
Locks or unlocks the ForceClearanceVoxel parameter.
SetForceVoxelLock
Locks or unlocks the ForceVoxel parameter.
SetInsertLevelLock
Locks or unlocks the InsertMode parameter.
SetInsertModeLock
Locks or unlocks the InsertMode parameter.
SetMarker2DAutoNamingLock
SetMarker3DAutoNamingLock
SetMarkerAutoUpdateLock
Locks or unlocks the MarkerAutoUpdate parameter.
SetMarkerDefaultsColorLock
SetMarkerDefaultsColor
SetMarkerDefaultsDashedLock
SetMarkerDefaultsFontLock
SetMarkerDefaultsSizeLock
SetMarkerDefaultsWeightLock
SetMarkerTextColorLock
SetMarkerTextColor
SetMarkerTextDashedLock
SetMarkerTextWeightLock
SetNumUrlNameLock
Locks or unlocks the NumUrlName parameter.
SetPublishAutoLaunchBrowserLock
Locks or unlocks the PublishAutoLaunchBrowser parameter.
SetSceneDefaultsColorLock
Locks or unlocks the SceneDefaultsColor parameter.
SetSceneDefaultsColor
Sets the scene background color (iRed, iGreen, iBlue: RGB values for the desired color)

Properties


o Property ClearanceVoxel() As float
Returns or sets the clearance value (oValue the clearance value in mm).
o Property DMUClashPreview() As boolean
Returns or sets the preview activation state for Interference (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUCut3DPreview() As boolean
Returns or sets the preview activation state for 3D Cut (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUDistancePreview() As boolean
Returns or sets the preview activation state for Distance (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUFreeSpacePreview() As boolean
Returns or sets the preview activation state for Free Space (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUGroupPreviewHiddenObjectsDisplayMode() As CatDMUGroupPreviewHiddenObjectsDisplayMode
Returns or sets the mode for the display of hidden objects in DMU Group Preview.
o Property DMUGroupPreviewHiddenObjectsLowInt() As boolean
Returns or sets the Low Intensity mode for the display of hidden objects in DMU Group Preview.
o Property DMUGroupPreviewHiddenObjectsOpacity() As long
Returns or sets the opacity for the display of hidden objects in DMU Group Preview.
o Property DMUGroupPreviewHiddenObjectsPick() As boolean
Returns or sets the pick mode for the display of hidden objects in DMU Group Preview.
o Property DMUGroupPreview() As boolean
Returns or sets the preview activation state for Group (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUMergerPreview() As boolean
Returns or sets the preview activation state for Merger (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUOffsetPreview() As boolean
Returns or sets the preview activation state for Offset (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUReviewName() As CATBSTR
Returns or sets the default name for the DMU Reviews (oValue, the DMU Review name).
o Property DMUSectionPreview() As boolean
Returns or sets the preview activation state for Section (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUShuttlePreview() As boolean
Returns or sets the preview activation state for Shuttle (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUSilhouettePreview() As boolean
Returns or sets the preview activation state for Silhouette (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUSimplifPreview() As boolean
Returns or sets the preview activation state for Simplification (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUSweptVolPreview() As boolean
Returns or sets the preview activation state for Swept Volume (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUThicknessPreview() As boolean
Returns or sets the preview activation state for Thickness (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUVibrationVolPreview() As boolean
Returns or sets the preview activation state for Vibration volume (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property DMUWrappingPreview() As boolean
Returns or sets the preview activation state for Wrapping (TRUE the preview window is automatically displayed, FALSE the preview window is not displayed).
o Property ForceClearanceVoxel() As boolean
Returns or sets the activation state for the use of the clearance value (TRUE the clearance value is used, FALSE the clearance value is not used);
o Property ForceVoxel() As boolean
Returns or sets the activation state for the use of the Released accuracy value (TRUE the released accuracy value is used, FALSE the released accuracy value is not used);
o Property InsertLevel() As boolean
Returns or sets the level for the Import Applicative Data command (True : at highest review level, False : in current review).
o Property InsertMode() As CatSacSettingsEnum
Returns or sets the mode for the Import Applicative Data command (CatSacSettingsEnumNoInsert no import of applicative data, CatSacSettingsEnumAutomatic the import of applicative is automatic, CatSacSettingsEnumUserPrompt the user can select the applicative data to import).
o Property Marker2DAutoNaming() As boolean
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.get_Marker2DAutoNaming This method will be replaced by MarkerSettingAtt.put_Marker2DAutoNaming Returns or sets the activation state for 2D annotations automatic naming (TRUE naming is automatic, FALSE the naming is not automatic).
o Property Marker3DAutoNaming() As boolean
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.get_Marker3DAutoNaming This method will be replaced by MarkerSettingAtt.put_Marker3DAutoNaming Returns or sets the activation state for 3D annotations automatic naming (TRUE naming is automatic, FALSE the naming is not automatic).
o Property MarkerAutoUpdate() As boolean
Returns or sets the activation of the automatic update on product structure modification (TRUE update is done automatically, FALSE update is done manually).
o Property MarkerDefaultsDashed() As long
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.get_MarkerDefaultsDashed This method will be replaced by MarkerSettingAtt.put_MarkerDefaultsDashed Returns or sets the default dashed value of an annotation (oValue the dashed value).
o Property MarkerDefaultsFont() As CATBSTR
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.get_MarkerTextDefaultsFont2D This method will be replaced by MarkerSettingAtt.put_MarkerTextDefaultsFont2D Returns or sets the default font of an annotation (oValue the font name).
o Property MarkerDefaultsSize() As long
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.get_MarkerTextDefaultsSize2D This method will be replaced by MarkerSettingAtt.put_MarkerTextDefaultsSize2D Returns or sets the default size value of an annotation (oValue the size value)..
o Property MarkerDefaultsWeight() As long
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.get_MarkerDefaultsWeight This method will be replaced by MarkerSettingAtt.put_MarkerDefaultsWeight Returns or sets the default weight value of an annotation (oValue the weight value).
o Property MarkerTextDashed() As long
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.get_MarkerTextDashed2D This method will be replaced by MarkerSettingAtt.put_MarkerTextDashed2D Returns or sets the default dashed value of a text annotation (oValue the dashed value).
o Property MarkerTextWeight() As long
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.get_MarkerTextWeight2D This method will be replaced by MarkerSettingAtt.put_MarkerTextWeight2D Returns or sets the default weight value of a text annotation (oValue the weight value).
o Property NumUrlName() As boolean
Returns or sets the name activation state for Hyperlink (TRUE the hyperlink name is displayed, FALSE the hyperlink name is not displayed).
o Property PublishAutoLaunchBrowser() As boolean
Returns or sets the activation state of the automatic launching of the publish browser (TRUE the publish browser is automatically opened, FALSE the publish browser is not automatically opened).

Methods


o Func GetClearanceVoxelInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the ClearanceVoxel parameter.
Role:Retrieves the state of the ClearanceVoxel parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUClashPreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUClashPreview parameter.
Role:Retrieves the state of the DMUClashPreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUCut3DPreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUCut3DPreview parameter.
Role:Retrieves the state of the DMUCut3DPreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUDistancePreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUDistancePreview parameter.
Role:Retrieves the state of the DMUDistancePreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUFreeSpacePreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUFreeSpacePreview parameter.
Role:Retrieves the state of the DMUFreeSpacePreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUGroupPreviewHiddenObjectsColorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUGroupPreviewHiddenObjectsColor parameter.
Role:Retrieves the state of the DMUGroupPreviewHiddenObjectsColor parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Sub GetDMUGroupPreviewHiddenObjectsColor(long oRed,
long oGreen,
long oBlue)
Returns the color for the display of hidden objects in DMU Group Preview.
o Func GetDMUGroupPreviewHiddenObjectsDisplayModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUGroupPreviewHiddenObjectsDisplayMode parameter.
Role:Retrieves the state of the DMUGroupPreviewHiddenObjectsDisplayMode parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUGroupPreviewHiddenObjectsLowIntInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUGroupPreviewHiddenObjectsLowInt parameter.
Role:Retrieves the state of the DMUGroupPreviewHiddenObjectsLowInt parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUGroupPreviewHiddenObjectsOpacityInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUGroupPreviewHiddenObjectsOpacity parameter.
Role:Retrieves the state of the DMUGroupPreviewHiddenObjectsOpacity parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUGroupPreviewHiddenObjectsPickInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUGroupPreviewHiddenObjectsPick parameter.
Role:Retrieves the state of the DMUGroupPreviewHiddenObjectsPick parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUGroupPreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUGroupPreview parameter.
Role:Retrieves the state of the DMUGroupPreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUMergerPreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUMergerPreview parameter.
Role:Retrieves the state of the DMUMergerPreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUOffsetPreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUOffsetPreview parameter.
Role:Retrieves the state of the DMUOffsetPreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUReviewNameInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUReviewName parameter.
Role:Retrieves the state of the DMUReviewName parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUSectionPreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUSectionPreview parameter.
Role:Retrieves the state of the DMUSectionPreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUShuttlePreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUShuttlePreview parameter.
Role:Retrieves the state of the DMUShuttlePreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUSilhouettePreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUSilhouettePreview parameter.
Role:Retrieves the state of the DMUSilhouettePreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUSimplifPreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUSimplifPreview parameter.
Role:Retrieves the state of the DMUSimplifPreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUSweptVolPreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUSweptVolPreview parameter.
Role:Retrieves the state of the DMUSweptVolPreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUThicknessPreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUThicknessPreview parameter.
Role:Retrieves the state of the DMUThicknessPreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUVibrationVolPreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUVibrationVolPreview parameter.
Role:Retrieves the state of the DMUVibrationVolPreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetDMUWrappingPreviewInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the DMUWrappingPreview parameter.
Role:Retrieves the state of the DMUWrappingPreview parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetForceClearanceVoxelInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the ForceClearanceVoxel parameter.
Role:Retrieves the state of the ForceClearanceVoxel parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetForceVoxelInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the ForceVoxel parameter.
Role:Retrieves the state of the ForceVoxel parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetInsertLevelInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the InsertLevel parameter.
Role:Retrieves the state of the InsertLevel parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetInsertModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the InsertMode parameter.
Role:Retrieves the state of the InsertMode parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetMarker2DAutoNamingInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.GetMarker2DAutoNamingInfo Retrieves environment informations for the Marker2DAutoNaming parameter.
Role:Retrieves the state of the Marker2DAutoNaming parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetMarker3DAutoNamingInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.GetMarker3DAutoNamingInfo Retrieves environment informations for the Marker3DAutoNaming parameter.
Role:Retrieves the state of the Marker3DAutoNaming parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetMarkerAutoUpdateInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the MarkerAutoUpdate parameter.
Role:Retrieves the state of the MarkerAutoUpdate parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetMarkerDefaultsColorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.GetMarkerDefaultsColorInfo Retrieves environment informations for the MarkerDefaultsColor parameter.
Role:Retrieves the state of the MarkerDefaultsColor parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Sub GetMarkerDefaultsColor(long oRed,
long oGreen,
long oBlue)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.GetMarkerDefaultsColor Returns the default color of an annotation (oRed, oGreen, oBlue: RGB values of the color).
o Func GetMarkerDefaultsDashedInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.GetMarkerDefaultsDashedInfo Retrieves environment informations for the MarkerDefaultsDashed parameter.
Role:Retrieves the state of the MarkerDefaultsDashed parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetMarkerDefaultsFontInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.GetMarkerDefaultsFont2DInfo Retrieves environment informations for the MarkerDefaultsFont parameter.
Role:Retrieves the state of the MarkerDefaultsFont parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetMarkerDefaultsSizeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R17 This method will be replaced by CATIAmarkerSettingAtt Retrieves environment informations for the MarkerDefaultsSize parameter.
Role:Retrieves the state of the MarkerDefaultsSize parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetMarkerDefaultsWeightInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.GetMarkerDefaultsWeightInfo Retrieves environment informations for the MarkerDefaultsWeight parameter.
Role:Retrieves the state of the MarkerDefaultsWeight parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetMarkerTextColorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.GetMarkerTextColor2DInfo Retrieves environment informations for the MarkerTextColor parameter.
Role:Retrieves the state of the MarkerTextColor parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Sub GetMarkerTextColor(long oRed,
long oGreen,
long oBlue)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.GetMarkerTextColor2DInfo Returns the default color of a text annotation (oRed, oGreen, oBlue: RGB values of the color).
o Func GetMarkerTextDashedInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.GetMarkerTextDashed2DInfo Retrieves environment informations for the MarkerTextDashed parameter.
Role:Retrieves the state of the MarkerTextDashed parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetMarkerTextWeightInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.GetMarkerTextWeight2DInfo Retrieves environment informations for the MarkerTextWeight parameter.
Role:Retrieves the state of the MarkerTextWeight parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetNumUrlNameInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the NumUrlName parameter.
Role:Retrieves the state of the NumUrlName parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetPublishAutoLaunchBrowserInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the PublishAutoLaunchBrowser parameter.
Role:Retrieves the state of the PublishAutoLaunchBrowser parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Func GetSceneDefaultsColorInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean
Retrieves environment informations for the SceneDefaultsColor parameter.
Role:Retrieves the state of the SceneDefaultsColor parameter in the current environment.
Parameters:
ioAdminLevel

If the parameter is locked, AdminLevel gives the administration level that imposes the value of the parameter.
If the parameter is not locked, AdminLevel gives the administration level that will give the value of the parameter after a reset.
ioLocked
Indicates if the parameter has been locked.
Returns:
Indicates if the parameter has been explicitly modified or remain to the administrated value.
o Sub GetSceneDefaultsColor(long oR,
long oG,
long oB)
Returns the scene background color (oRed, oGreen, oBlue: RGB values of the color).
o Sub SetClearanceVoxelLock(boolean iLocked)
Locks or unlocks the ClearanceVoxel parameter.
Role:Locks or unlocks the ClearanceVoxel parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUClashPreviewLock(boolean iLocked)
Locks or unlocks the DMUClashPreview parameter.
Role:Locks or unlocks the DMUClashPreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUCut3DPreviewLock(boolean iLocked)
Locks or unlocks the DMUCut3DPreview parameter.
Role:Locks or unlocks the DMUCut3DPreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUDistancePreviewLock(boolean iLocked)
Locks or unlocks the DMUDistancePreview parameter.
Role:Locks or unlocks the DMUDistancePreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUFreeSpacePreviewLock(boolean iLocked)
Locks or unlocks the DMUFreeSpacePreview parameter.
Role:Locks or unlocks the DMUFreeSpacePreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUGroupPreviewHiddenObjectsColorLock(boolean iLocked)
Locks or unlocks the DMUGroupPreviewHiddenObjectsColor parameter.
Role:Locks or unlocks the DMUGroupPreviewHiddenObjectsColor parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUGroupPreviewHiddenObjectsColor(long iRed,
long iGreen,
long iBlue)
Sets the color for the display of hidden objects in DMU Group Preview.
o Sub SetDMUGroupPreviewHiddenObjectsDisplayModeLock(boolean iLocked)
Locks or unlocks the DMUGroupPreviewHiddenObjectsDisplayMode parameter.
Role:Locks or unlocks the DMUGroupPreviewHiddenObjectsDisplayMode parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUGroupPreviewHiddenObjectsLowIntLock(boolean iLocked)
Locks or unlocks the DMUGroupPreviewHiddenObjectsLowInt parameter.
Role:Locks or unlocks the DMUGroupPreviewHiddenObjectsLowInt parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUGroupPreviewHiddenObjectsOpacityLock(boolean iLocked)
Locks or unlocks the DMUGroupPreviewHiddenObjectsOpacity parameter.
Role:Locks or unlocks the DMUGroupPreviewHiddenObjectsOpacity parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUGroupPreviewHiddenObjectsPickLock(boolean iLocked)
Locks or unlocks the DMUGroupPreviewHiddenObjectsPick parameter.
Role:Locks or unlocks the DMUGroupPreviewHiddenObjectsPick parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUGroupPreviewLock(boolean iLocked)
Locks or unlocks the DMUGroupPreview parameter.
Role:Locks or unlocks the DMUGroupPreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUMergerPreviewLock(boolean iLocked)
Locks or unlocks the DMUMergerPreview parameter.
Role:Locks or unlocks the DMUMergerPreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUOffsetPreviewLock(boolean iLocked)
Locks or unlocks the DMUOffsetPreview parameter.
Role:Locks or unlocks the DMUOffsetPreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUReviewNameLock(boolean iLocked)
Locks or unlocks the DMUReviewName parameter.
Role:Locks or unlocks the DMUReviewName parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUSectionPreviewLock(boolean iLocked)
Locks or unlocks the DMUSectionPreview parameter.
Role:Locks or unlocks the DMUSectionPreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUShuttlePreviewLock(boolean iLocked)
Locks or unlocks the DMUShuttlePreview parameter.
Role:Locks or unlocks the DMUShuttlePreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUSilhouettePreviewLock(boolean iLocked)
Locks or unlocks the DMUSilhouettePreview parameter.
Role:Locks or unlocks the DMUSilhouettePreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUSimplifPreviewLock(boolean iLocked)
Locks or unlocks the DMUSimplifPreview parameter.
Role:Locks or unlocks the DMUSimplifPreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUSweptVolPreviewLock(boolean iLocked)
Locks or unlocks the DMUSweptVolPreview parameter.
Role:Locks or unlocks the DMUSweptVolPreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUThicknessPreviewLock(boolean iLocked)
Locks or unlocks the DMUThicknessPreview parameter.
Role:Locks or unlocks the DMUThicknessPreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUVibrationVolPreviewLock(boolean iLocked)
Locks or unlocks the DMUVibrationVolPreview parameter.
Role:Locks or unlocks the DMUVibrationVolPreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetDMUWrappingPreviewLock(boolean iLocked)
Locks or unlocks the DMUWrappingPreview parameter.
Role:Locks or unlocks the DMUWrappingPreview parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetForceClearanceVoxelLock(boolean iLocked)
Locks or unlocks the ForceClearanceVoxel parameter.
Role:Locks or unlocks the ForceClearanceVoxel parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetForceVoxelLock(boolean iLocked)
Locks or unlocks the ForceVoxel parameter.
Role:Locks or unlocks the ForceVoxel parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetInsertLevelLock(boolean iLocked)
Locks or unlocks the InsertMode parameter.
Role:Locks or unlocks the InsertMode parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetInsertModeLock(boolean iLocked)
Locks or unlocks the InsertMode parameter.
Role:Locks or unlocks the InsertMode parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetMarker2DAutoNamingLock(boolean iLocked)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.SetMarker2DAutoNamingLock Locks or unlocks the Marker2DAutoNaming parameter.
Role:Locks or unlocks the Marker2DAutoNaming parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetMarker3DAutoNamingLock(boolean iLocked)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.SetMarker3DAutoNamingLock Locks or unlocks the Marker3DAutoNaming parameter.
Role:Locks or unlocks the Marker3DAutoNaming parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetMarkerAutoUpdateLock(boolean iLocked)
Locks or unlocks the MarkerAutoUpdate parameter.
Role:Locks or unlocks the MarkerAutoUpdate parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetMarkerDefaultsColorLock(boolean iLocked)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.SetMarkerDefaultsColorLock Locks or unlocks the MarkerDefaultsColor parameter.
Role:Locks or unlocks the MarkerDefaultsColor parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetMarkerDefaultsColor(long iRed,
long iGreen,
long iBlue)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.SetMarkerDefaultsColor Sets the default color of an annotation (iRed, iGreen, iBlue: RGB values for the desired color)
o Sub SetMarkerDefaultsDashedLock(boolean iLocked)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.SetMarkerDefaultsDashedLock Locks or unlocks the MarkerDefaultsDashed parameter.
Role:Locks or unlocks the MarkerDefaultsDashed parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetMarkerDefaultsFontLock(boolean iLocked)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.SetMarkerDefaultsFont2DLock Locks or unlocks the MarkerDefaultsFont parameter.
Role:Locks or unlocks the MarkerDefaultsSize parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetMarkerDefaultsSizeLock(boolean iLocked)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.SetMarkerTextDefaultsSize2DLock Locks or unlocks the MarkerDefaultsSize parameter.
Role:Locks or unlocks the MarkerDefaultsSize parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetMarkerDefaultsWeightLock(boolean iLocked)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.SetMarkerDefaultsWeightLock Locks or unlocks the MarkerDefaultsWeight parameter.
Role:Locks or unlocks the MarkerDefaultsColor parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetMarkerTextColorLock(boolean iLocked)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.SetMarkerTextColor2DLock Locks or unlocks the MarkerTextColor parameter.
Role:Locks or unlocks the MarkerTextColor parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetMarkerTextColor(long iRed,
long iGreen,
long iBlue)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.SetMarkerTextColor2D Sets the default color of a text annotation (iRed, iGreen, iBlue: RGB values for the desired color).
o Sub SetMarkerTextDashedLock(boolean iLocked)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.SetMarkerTextDashed2DLock Locks or unlocks the MarkerTextDashed parameter.
Role:Locks or unlocks the MarkerTextDashed parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetMarkerTextWeightLock(boolean iLocked)
Deprecated:
R17 This method will be replaced by MarkerSettingAtt.SetMarkerTextWeight2DLock Locks or unlocks the MarkerTextWeight parameter.
Role:Locks or unlocks the MarkerTextWeight parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetNumUrlNameLock(boolean iLocked)
Locks or unlocks the NumUrlName parameter.
Role:Locks or unlocks the NumUrlName parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetPublishAutoLaunchBrowserLock(boolean iLocked)
Locks or unlocks the PublishAutoLaunchBrowser parameter.
Role:Locks or unlocks the PublishAutoLaunchBrowser parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetSceneDefaultsColorLock(boolean iLocked)
Locks or unlocks the SceneDefaultsColor parameter.
Role:Locks or unlocks the SceneDefaultsColor parameter if it is possible in the current administrative context. In user mode this method will always return E_FAIL.
Parameters:
iLocked
the locking operation to be performed Legal values:
TRUE : to lock the parameter.
FALSE: to unlock the parameter.
o Sub SetSceneDefaultsColor(long iR,
long iG,
long iB)
Sets the scene background color (iRed, iGreen, iBlue: RGB values for the desired color)

Copyright © 2006, Dassault Systèmes. All rights reserved.