pycatia.multi_cad_interfaces.multi_cad_setting_att

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.multi_cad_interfaces.multi_cad_setting_att.MultiCADSettingAtt(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
System.SettingController
MultiCADSettingAtt
property annotation_3d_mode: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Annotation3DMode() As boolean

Returns or sets the Annotation 3D mode R18sp3 on env. variable
Return type:

bool

property conversion_technology: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ConversionTechnology() As long

Returns or sets the Conversion Technology
Return type:

int

get_annotation_3d_mode_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetAnnotation3DModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the Annotation3DMode
parameter.
Role:Retrieves the state of the Annotation3DMode 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_conversion_technology_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetConversionTechnologyInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ConversionTechnology
parameter.
Role:Retrieves the state of the ConversionTechnology 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetLinkModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the LinkMode
parameter.
Role:Retrieves the state of the LinkMode 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_output_path_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetOutputPathInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the OutputPath
parameter.
Role:Retrieves the state of the OutputPath 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_parts_parameter_mode_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetPartsParameterModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the PartsParameterMode
parameter.
Role:Retrieves the state of the PartsParameterMode 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_pro_e_instance_mode_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetProEInstanceModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ProEInstanceMode
parameter.
Role:Retrieves the state of the ProEInstanceMode 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_pro_e_instance_name_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetProEInstanceNameInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ProEInstanceName
parameter.
Role:Retrieves the state of the ProEInstanceName 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_pro_e_quilts_read_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetProEQuiltsReadInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ProEQuiltsRead
parameter.
Role:Retrieves the state of the ProEQuiltsRead 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_pro_e_simp_rep_mode_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetProESimpRepModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ProESimpRepMode
parameter.
Role:Retrieves the state of the ProESimpRepMode 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_pro_e_simp_rep_name_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetProESimpRepNameInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the ProESimpRepName
parameter.
Role:Retrieves the state of the ProESimpRepName 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_save_coorsys_in_cgr_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetSaveCoorsysInCgrInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the SaveCoorsysInCgr
parameter.
Role:Retrieves the state of the SaveCoorsysInCgr 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_translator_mode_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetTranslatorModeInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the Translator mode
parameter.
Role:Retrieves the state of the Translator mode 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_ug_active_layers_only_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetUGActiveLayersOnlyInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the UGActiveLayersOnly
parameter.
Role:Retrieves the state of the UGActiveLayersOnly 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_ug_drawing_name_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetUGDrawingNameInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the UGDrawingName
parameter.
Role:Retrieves the state of the UGDrawingName 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_ug_layer_numbers_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetUGLayerNumbersInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the UGLayerNumbers
parameter.
Role:Retrieves the state of the UGLayerNumbers 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_ug_open_surfaces_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetUGOpenSurfacesInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the UGOpenSurfaces
parameter.
Role:Retrieves the state of the UGOpenSurfaces 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_ug_reference_set_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetUgReferenceSetInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the UgReferenceSet
parameter.
Role:Retrieves the state of the UgReferenceSet 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

get_visu_format_unit_info(io_admin_level: str, io_locked: str) → bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Func GetVisuFormatUnitInfo(CATBSTR ioAdminLevel,
CATBSTR ioLocked) As boolean

Retrieves environment informations for the VisuFormatUnit
parameter.
Role:Retrieves the state of the VisuFormatUnit 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.
Parameters:

  • io_admin_level (str) –

  • io_locked (str) –

Return type:

bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property LinkMode() As long

Returns or sets the Link Mode
Return type:

int

property output_path: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property OutputPath() As CATBSTR

Returns or sets the Output Path
Return type:

str

property parts_parameter_mode: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property PartsParameterMode() As long

Returns or sets the parts parameterization mode
Return type:

int

property pro_e_instance_mode: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ProEInstanceMode() As boolean

Returns or sets the ProEInstanceMode
Return type:

bool

property pro_e_instance_name: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ProEInstanceName() As CATBSTR

Returns or sets the ProEInstanceName
Return type:

str

property pro_e_quilts_read: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ProEQuiltsRead() As boolean

Returns or sets the ProEQuiltsRead
Return type:

bool

property pro_e_simp_rep_mode: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ProESimpRepMode() As boolean

Returns or sets the ProESimpRepMode
Return type:

bool

property pro_e_simp_rep_name: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ProESimpRepName() As CATBSTR

Returns or sets the ProESimpRepName
Return type:

str

property save_coorsys_in_cgr: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property SaveCoorsysInCgr() As boolean

Returns or sets the Save Coordinate Systems in CGR
Return type:

bool

set_annotation_3d_mode_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetAnnotation3DModeLock(boolean iLocked)

Locks or unlocks the Annotation3DMode parameter.
Role:Locks or unlocks the Annotation3DMode 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.
Parameters:

i_locked (bool) –

Return type:

None

set_conversion_technology_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetConversionTechnologyLock(boolean iLocked)

Locks or unlocks the ConversionTechnology parameter.
Role:Locks or unlocks the ConversionTechnology 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.
Parameters:

i_locked (bool) –

Return type:

None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetLinkModeLock(boolean iLocked)

Locks or unlocks the LinkMode parameter.
Role:Locks or unlocks the LinkMode 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.
Parameters:

i_locked (bool) –

Return type:

None

set_output_path_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetOutputPathLock(boolean iLocked)

Locks or unlocks the OutputPath parameter.
Role:Locks or unlocks the OutputPath 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.
Parameters:

i_locked (bool) –

Return type:

None

set_parts_parameter_mode_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetPartsParameterModeLock(boolean iLocked)

Locks or unlocks the PartsParameterMode parameter.
Role:Locks or unlocks the PartsParameterMode 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.
Parameters:

i_locked (bool) –

Return type:

None

set_pro_e_instance_mode_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetProEInstanceModeLock(boolean iLocked)

Locks or unlocks the ProEInstanceMode parameter.
Role:Locks or unlocks the ProEInstanceMode 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.
Parameters:

i_locked (bool) –

Return type:

None

set_pro_e_instance_name_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetProEInstanceNameLock(boolean iLocked)

Locks or unlocks the ProEInstanceName parameter.
Role:Locks or unlocks the ProEInstanceName 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.
Parameters:

i_locked (bool) –

Return type:

None

set_pro_e_quilts_read_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetProEQuiltsReadLock(boolean iLocked)

Locks or unlocks the ProEQuiltsRead parameter.
Role:Locks or unlocks the ProEQuiltsRead 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.
Parameters:

i_locked (bool) –

Return type:

None

set_pro_e_simp_rep_mode_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetProESimpRepModeLock(boolean iLocked)

Locks or unlocks the ProESimpRepMode parameter.
Role:Locks or unlocks the ProESimpRepMode 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.
Parameters:

i_locked (bool) –

Return type:

None

set_pro_e_simp_rep_name_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetProESimpRepNameLock(boolean iLocked)

Locks or unlocks the ProESimpRepName parameter.
Role:Locks or unlocks the ProESimpRepName 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.
Parameters:

i_locked (bool) –

Return type:

None

set_save_coorsys_in_cgr_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetSaveCoorsysInCgrLock(boolean iLocked)

Locks or unlocks the SaveCoorsysInCgr parameter.
Role:Locks or unlocks the SaveCoorsysInCgr 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.
Parameters:

i_locked (bool) –

Return type:

None

set_translator_mode_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetTranslatorModeLock(boolean iLocked)

Locks or unlocks the Translator mode parameter.
Role:Locks or unlocks the Translator mode 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.
Parameters:

i_locked (bool) –

Return type:

None

set_ug_active_layers_only_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetUGActiveLayersOnlyLock(boolean iLocked)

Locks or unlocks the UGActiveLayersOnly parameter.
Role:Locks or unlocks the UGActiveLayersOnly 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.
Parameters:

i_locked (bool) –

Return type:

None

set_ug_drawing_name_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetUGDrawingNameLock(boolean iLocked)

Locks or unlocks the UGDrawingName parameter.
Role:Locks or unlocks the UGDrawingName 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.
Parameters:

i_locked (bool) –

Return type:

None

set_ug_layer_numbers_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetUGLayerNumbersLock(boolean iLocked)

Locks or unlocks the UGLayerNumbers parameter.
Role:Locks or unlocks the UGLayerNumbers 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.
Parameters:

i_locked (bool) –

Return type:

None

set_ug_open_surfaces_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetUGOpenSurfacesLock(boolean iLocked)

Locks or unlocks the UGOpenSurfaces parameter.
Role:Locks or unlocks the UGOpenSurfaces 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.
Parameters:

i_locked (bool) –

Return type:

None

set_ug_reference_set_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetUgReferenceSetLock(boolean iLocked)

Locks or unlocks the UgReferenceSet parameter.
Role:Locks or unlocks the UgReferenceSet 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.
Parameters:

i_locked (bool) –

Return type:

None

set_visu_format_unit_lock(i_locked: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SetVisuFormatUnitLock(boolean iLocked)

Locks or unlocks the VisuFormatUnit parameter.
Role:Locks or unlocks the VisuFormatUnit 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.
Parameters:

i_locked (bool) –

Return type:

None

property translator_mode: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property TranslatorMode() As long

Returns or sets the Translator mode
Return type:

int

property ug_active_layers_only: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property UGActiveLayersOnly() As boolean

Returns or sets the UGActiveLayersOnly
Return type:

bool

property ug_drawing_name: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property UGDrawingName() As CATBSTR

Returns or sets the UGDrawingName
Return type:

str

property ug_layer_numbers: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property UGLayerNumbers() As CATBSTR

Returns or sets the UGLayerNumbers
Return type:

str

property ug_open_surfaces: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property UGOpenSurfaces() As boolean

Returns or sets the UGOpenSurfaces
Return type:

bool

property ug_reference_set: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property UgReferenceSet() As CATBSTR

Returns or sets the UgReferenceSet
Return type:

str

property visu_format_unit: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property VisuFormatUnit() As float

Returns or sets the Unit for Visu Format (number of milimeters per unit of
the file)
Return type:

float