pycatia.drafting_interfaces.drafting_setting_att¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

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.drafting_interfaces.drafting_setting_att.DraftingSettingAtt(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

DraftingSettingAtt

Manages drafting settings.

property create_new_sheet_from: int¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property CreateNewSheetFrom() As CatDrwNewSheetFrom

Returns the CreateNewSheetFrom parameter.

Returns:: enum cat_drw_new_sheet_from
Return type:: int

property display_reset_button: bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property DisplayResetButton() As boolean

Returns the DisplayResetButton parameter.

Return type:: bool

get_create_new_sheet_from_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetCreateNewSheetFromInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the CreateNewSheetFrom

parameter.

Role:Retrieves the state of the CreateNewSheetFrom 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_display_reset_button_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetDisplayResetButtonInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DisplayResetButton

parameter.

Role:Retrieves the state of the DisplayResetButton 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_lock_user_default_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetLockUserDefaultInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the LockUserDefault

parameter.

Role:Retrieves the state of the LockUserDefault 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_prevent_background_access_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetPreventBackgroundAccessInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventBackgroundAccess

parameter.

Role:Retrieves the state of the PreventBackgroundAccess 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_prevent_dim_driving_3d_cstr_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetPreventDimDriving3DCstrInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventDimDriving3DCstr

parameter.

Role:Retrieves the state of the PreventDimDriving3DCstr 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_prevent_file_new_info(io_admin_level: str, io_locked: str, o_modified: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub GetPreventFileNewInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the PreventFileNew

parameter.

Role:Retrieves the state of the PreventFileNew 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) –
o_modified (bool) –

Return type:

None

get_prevent_gen_view_style_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetPreventGenViewStyleInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventGenViewStyle

parameter.

Role:Retrieves the state of the PreventGenViewStyle 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_prevent_set_as_default_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetPreventSetAsDefaultInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventSetAsDefault

parameter.

Role:Retrieves the state of the PreventSetAsDefault 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_prevent_switch_standard_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetPreventSwitchStandardInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventSwitchStandard

parameter.

Role:Retrieves the state of the PreventSwitchStandard 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_prevent_true_dimension_creation_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetPreventTrueDimensionCreationInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventTrueDimensionCreation

parameter.

Role:Retrieves the state of the PreventTrueDimensionCreation 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_prevent_update_standard_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetPreventUpdateStandardInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventUpdateStandard

parameter.

Role:Retrieves the state of the PreventUpdateStandard 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_prevent_view_geom_upgrade_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetPreventViewGeomUpgradeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventViewGeomUpgrade

parameter.

Role:Retrieves the state of the PreventViewGeomUpgrade 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_use_style_create_objects_info(io_admin_level: str, io_locked: str) → bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Func GetUseStyleCreateObjectsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the UseStyleCreateObjects

parameter.

Role:Retrieves the state of the UseStyleCreateObjects 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

property lock_user_default: bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property LockUserDefault() As boolean

Returns the LockUserDefault parameter.

Return type:: bool

property prevent_background_access: bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property PreventBackgroundAccess() As boolean

Returns the PreventBackgroundAccess parameter.

Return type:: bool

property prevent_dim_driving_3d_cstr: bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property PreventDimDriving3DCstr() As boolean

Returns the PreventDimDriving3DCstr parameter.

Return type:: bool

property prevent_file_new: bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property PreventFileNew() As boolean

Returns the PreventFileNew parameter.

Returns:: bool

property prevent_gen_view_style: bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property PreventGenViewStyle() As boolean

Returns the PreventGenViewStyle parameter.

Return type:: bool

property prevent_set_as_default: bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property PreventSetAsDefault() As boolean

Returns the PreventSetAsDefault parameter.

Return type:: bool

property prevent_switch_standard: bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property PreventSwitchStandard() As boolean

Returns the PreventSwitchStandard parameter.

Return type:: bool

property prevent_true_dimension_creation: bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property PreventTrueDimensionCreation() As boolean

Returns the PreventTrueDimensionCreation parameter.

Return type:: bool

property prevent_update_standard: bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property PreventUpdateStandard() As boolean

Returns the PreventUpdateStandard parameter.

Return type:: bool

property prevent_view_geom_upgrade: bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property PreventViewGeomUpgrade() As boolean

Returns the PreventViewGeomUpgrade parameter.

Returns:: bool

set_create_new_sheet_from_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetCreateNewSheetFromLock(boolean iLocked)

Locks or unlocks the CreateNewSheetFrom parameter.

Role:Locks or unlocks the CreateNewSheetFrom 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_display_reset_button_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetDisplayResetButtonLock(boolean iLocked)

Locks or unlocks the DisplayResetButton parameter.

Role:Locks or unlocks the DisplayResetButton 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_lock_user_default_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetLockUserDefaultLock(boolean iLocked)

Locks or unlocks the LockUserDefault parameter.

Role:Locks or unlocks the LockUserDefault 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_prevent_background_access_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPreventBackgroundAccessLock(boolean iLocked)

Locks or unlocks the PreventBackgroundAccess parameter.

Role:Locks or unlocks the PreventBackgroundAccess 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_prevent_dim_driving_3d_cstr_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPreventDimDriving3DCstrLock(boolean iLocked)

Locks or unlocks the PreventDimDriving3DCstr parameter.

Role:Locks or unlocks the PreventDimDriving3DCstr 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_prevent_file_new_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPreventFileNewLock(boolean iLocked)

Locks or unlocks the PreventFileNew parameter.

Role:Locks or unlocks the PreventFileNew 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_prevent_gen_view_style_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPreventGenViewStyleLock(boolean iLocked)

Locks or unlocks the PreventGenViewStyle parameter.

Role:Locks or unlocks the PreventGenViewStyle 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_prevent_set_as_default_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPreventSetAsDefaultLock(boolean iLocked)

Locks or unlocks the PreventSetAsDefault parameter.

Role:Locks or unlocks the PreventSetAsDefault 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_prevent_switch_standard_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPreventSwitchStandardLock(boolean iLocked)

Locks or unlocks the PreventSwitchStandard parameter.

Role:Locks or unlocks the PreventSwitchStandard 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_prevent_true_dimension_creation_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPreventTrueDimensionCreationLock(boolean iLocked)

Locks or unlocks the PreventTrueDimensionCreation

parameter.

Role:Locks or unlocks the PreventTrueDimensionCreation 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_prevent_update_standard_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPreventUpdateStandardLock(boolean iLocked)

Locks or unlocks the PreventUpdateStandard parameter.

Role:Locks or unlocks the PreventUpdateStandard 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_prevent_view_geom_upgrade_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetPreventViewGeomUpgradeLock(boolean iLocked)

Locks or unlocks the PreventViewGeomUpgrade parameter.

Role:Locks or unlocks the PreventViewGeomUpgrade 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) –
Returns:: None

set_use_style_create_objects_lock(i_locked: bool) → None¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)): o Sub SetUseStyleCreateObjectsLock(boolean iLocked)

Locks or unlocks the UseStyleCreateObjects parameter.

Role:Locks or unlocks the UseStyleCreateObjects 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 use_style_create_objects: bool¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445): o Property UseStyleCreateObjects() As boolean

Returns the UseStyleCreateObjects parameter.

Return type:: bool

pycatia.drafting_interfaces.drafting_setting_att¶

Navigation

Related Topics